001/*
002 * Copyright 2002-2015 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 *      https://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.context.annotation;
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 org.springframework.beans.factory.config.BeanDefinition;
026
027/**
028 * Indicates the 'role' hint for a given bean.
029 *
030 * <p>May be used on any class directly or indirectly annotated with
031 * {@link org.springframework.stereotype.Component} or on methods
032 * annotated with {@link Bean}.
033 *
034 * <p>If this annotation is not present on a Component or Bean definition,
035 * the default value of {@link BeanDefinition#ROLE_APPLICATION} will apply.
036 *
037 * <p>If Role is present on a {@link Configuration @Configuration} class,
038 * this indicates the role of the configuration class bean definition and
039 * does not cascade to all @{@code Bean} methods defined within. This behavior
040 * is different than that of the @{@link Lazy} annotation, for example.
041 *
042 * @author Chris Beams
043 * @since 3.1
044 * @see BeanDefinition#ROLE_APPLICATION
045 * @see BeanDefinition#ROLE_INFRASTRUCTURE
046 * @see BeanDefinition#ROLE_SUPPORT
047 * @see Bean
048 */
049@Target({ElementType.TYPE, ElementType.METHOD})
050@Retention(RetentionPolicy.RUNTIME)
051@Documented
052public @interface Role {
053
054        /**
055         * Set the role hint for the associated bean.
056         * @see BeanDefinition#ROLE_APPLICATION
057         * @see BeanDefinition#ROLE_INFRASTRUCTURE
058         * @see BeanDefinition#ROLE_SUPPORT
059         */
060        int value();
061
062}