org.zalando.baigan.annotation.ConfigurationServiceScan Maven / Gradle / Ivy

Go to download
/**
 * Copyright (C) 2015 Zalando SE (http://tech.zalando.com)
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *         http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.zalando.baigan.annotation;

import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Inherited;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

import org.springframework.context.annotation.Import;
import org.zalando.baigan.proxy.ConfigurationBeanDefinitionRegistrar;

/**
 * Use this annotation to enable the Baigan configuration.
 *
 * @author mchand
 *
 */
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
@Documented
@Import(ConfigurationBeanDefinitionRegistrar.class)
@Inherited
public @interface ConfigurationServiceScan {

    /**
     * Alias for the {@link #basePackages()} attribute. Allows for more concise
     * annotation declarations e.g.:
     * {@code @EnableConfigService("de.zalando.shop")} instead of
     * {@code @EnableConfigService(basePackages= "de.zalando.shop"})}.
     */
    String[] value() default {};

    /**
     * Base packages to scan for AppConfigService interfaces.
     */
    String[] basePackages() default {};

}