Browse Source
As a mechanism for setting the 'role' hint on BeanDefinitions created via component-scanning or @Bean methods.pull/7/head
6 changed files with 210 additions and 0 deletions
@ -0,0 +1,62 @@
@@ -0,0 +1,62 @@
|
||||
/* |
||||
* Copyright 2002-2011 the original author or authors. |
||||
* |
||||
* 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.springframework.context.annotation; |
||||
|
||||
import java.lang.annotation.Documented; |
||||
import java.lang.annotation.ElementType; |
||||
import java.lang.annotation.Retention; |
||||
import java.lang.annotation.RetentionPolicy; |
||||
import java.lang.annotation.Target; |
||||
|
||||
import org.springframework.beans.factory.config.BeanDefinition; |
||||
|
||||
/** |
||||
* Indicates the 'role' hint for a given bean. |
||||
* |
||||
* <p>May be used on any class directly or indirectly annotated with |
||||
* {@link org.springframework.stereotype.Component} or on methods annotated with |
||||
* {@link Bean}. |
||||
* |
||||
* <p>If this annotation is not present on a Component or Bean definition, the |
||||
* default value of {@link BeanDefinition#ROLE_APPLICATION} will apply. |
||||
* |
||||
* <p>If Role is present on a {@link Configuration @Configuration} class, this |
||||
* indicates the role of the configuration class bean definition and does not |
||||
* cascade to all @{@code Bean} methods defined within. This behavior is |
||||
* different than that of the @{@link Lazy} annotation, for example. |
||||
* |
||||
* @author Chris Beams |
||||
* @since 3.1 |
||||
* @see BeanDefinition#ROLE_APPLICATION |
||||
* @see BeanDefinition#ROLE_INFRASTRUCTURE |
||||
* @see BeanDefinition#ROLE_SUPPORT |
||||
* @see Bean |
||||
*/ |
||||
@Target({ElementType.TYPE, ElementType.METHOD}) |
||||
@Retention(RetentionPolicy.RUNTIME) |
||||
@Documented |
||||
public @interface Role { |
||||
|
||||
/** |
||||
* Set the role hint for the associated bean. |
||||
* @see BeanDefinition#ROLE_APPLICATION |
||||
* @see BeanDefinition#ROLE_INFRASTRUCTURE |
||||
* @see BeanDefinition#ROLE_SUPPORT |
||||
*/ |
||||
int value(); |
||||
|
||||
} |
||||
@ -0,0 +1,85 @@
@@ -0,0 +1,85 @@
|
||||
/* |
||||
* Copyright 2002-2011 the original author or authors. |
||||
* |
||||
* 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.springframework.context.annotation; |
||||
|
||||
import static org.hamcrest.CoreMatchers.is; |
||||
import static org.junit.Assert.assertThat; |
||||
|
||||
import org.junit.Test; |
||||
import org.springframework.beans.factory.config.BeanDefinition; |
||||
import org.springframework.context.annotation.role.ComponentWithRole; |
||||
import org.springframework.context.annotation.role.ComponentWithoutRole; |
||||
|
||||
/** |
||||
* Tests the use of the @Role annotation on @Bean methods and |
||||
* @Component classes. |
||||
* |
||||
* @author Chris Beams |
||||
* @since 3.1 |
||||
*/ |
||||
public class RoleAnnotationTests { |
||||
|
||||
@Test |
||||
public void onBeanMethod() { |
||||
AnnotationConfigApplicationContext ctx = new AnnotationConfigApplicationContext(); |
||||
ctx.register(Config.class); |
||||
ctx.refresh(); |
||||
assertThat("Expected bean to have ROLE_APPLICATION", |
||||
ctx.getBeanDefinition("foo").getRole(), is(BeanDefinition.ROLE_APPLICATION)); |
||||
assertThat("Expected bean to have ROLE_INFRASTRUCTURE", |
||||
ctx.getBeanDefinition("bar").getRole(), is(BeanDefinition.ROLE_INFRASTRUCTURE)); |
||||
} |
||||
|
||||
|
||||
@Configuration |
||||
static class Config { |
||||
@Bean |
||||
public String foo() { |
||||
return "foo"; |
||||
} |
||||
|
||||
@Bean |
||||
@Role(BeanDefinition.ROLE_INFRASTRUCTURE) |
||||
public String bar() { |
||||
return "bar"; |
||||
} |
||||
} |
||||
|
||||
|
||||
@Test |
||||
public void onComponentClass() { |
||||
AnnotationConfigApplicationContext ctx = new AnnotationConfigApplicationContext(); |
||||
ctx.register(ComponentWithoutRole.class, ComponentWithRole.class); |
||||
ctx.refresh(); |
||||
assertThat("Expected bean to have ROLE_APPLICATION", |
||||
ctx.getBeanDefinition("componentWithoutRole").getRole(), is(BeanDefinition.ROLE_APPLICATION)); |
||||
assertThat("Expected bean to have ROLE_INFRASTRUCTURE", |
||||
ctx.getBeanDefinition("componentWithRole").getRole(), is(BeanDefinition.ROLE_INFRASTRUCTURE)); |
||||
} |
||||
|
||||
|
||||
@Test |
||||
public void viaComponentScanning() { |
||||
AnnotationConfigApplicationContext ctx = new AnnotationConfigApplicationContext(); |
||||
ctx.scan("org.springframework.context.annotation.role"); |
||||
ctx.refresh(); |
||||
assertThat("Expected bean to have ROLE_APPLICATION", |
||||
ctx.getBeanDefinition("componentWithoutRole").getRole(), is(BeanDefinition.ROLE_APPLICATION)); |
||||
assertThat("Expected bean to have ROLE_INFRASTRUCTURE", |
||||
ctx.getBeanDefinition("componentWithRole").getRole(), is(BeanDefinition.ROLE_INFRASTRUCTURE)); |
||||
} |
||||
} |
||||
@ -0,0 +1,26 @@
@@ -0,0 +1,26 @@
|
||||
/* |
||||
* Copyright 2002-2011 the original author or authors. |
||||
* |
||||
* 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.springframework.context.annotation.role; |
||||
|
||||
import org.springframework.beans.factory.config.BeanDefinition; |
||||
import org.springframework.context.annotation.Role; |
||||
import org.springframework.stereotype.Component; |
||||
|
||||
@Component("componentWithRole") |
||||
@Role(BeanDefinition.ROLE_INFRASTRUCTURE) |
||||
public class ComponentWithRole { |
||||
} |
||||
@ -0,0 +1,23 @@
@@ -0,0 +1,23 @@
|
||||
/* |
||||
* Copyright 2002-2011 the original author or authors. |
||||
* |
||||
* 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.springframework.context.annotation.role; |
||||
|
||||
import org.springframework.stereotype.Component; |
||||
|
||||
@Component("componentWithoutRole") |
||||
public class ComponentWithoutRole { |
||||
} |
||||
Loading…
Reference in new issue