001/*
002 * Copyright 2012-2017 the original author or authors.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *      http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016
017package org.springframework.boot.autoconfigure.condition;
018
019import java.lang.annotation.Documented;
020import java.lang.annotation.ElementType;
021import java.lang.annotation.Retention;
022import java.lang.annotation.RetentionPolicy;
023import java.lang.annotation.Target;
024
025import javax.naming.InitialContext;
026
027import org.springframework.context.annotation.Conditional;
028
029/**
030 * {@link Conditional} that matches based on the availability of a JNDI
031 * {@link InitialContext} and the ability to lookup specific locations.
032 *
033 * @author Phillip Webb
034 * @since 1.2.0
035 */
036@Target({ ElementType.TYPE, ElementType.METHOD })
037@Retention(RetentionPolicy.RUNTIME)
038@Documented
039@Conditional(OnJndiCondition.class)
040public @interface ConditionalOnJndi {
041
042        /**
043         * JNDI Locations, one of which must exist. If no locations are specific the condition
044         * matches solely based on the presence of an {@link InitialContext}.
045         * @return the JNDI locations
046         */
047        String[] value() default {};
048
049}