Interface ProcessBeanAttributes<T>
-
- Type Parameters:
T- The class of the bean
public interface ProcessBeanAttributes<T>The container fires an event of this type for each enabled bean, interceptor or decorator deployed in a bean archive before registering the
Beanobject.Any observer of this event is permitted to wrap and/or replace the
BeanAttributesby calling eithersetBeanAttributes(BeanAttributes)orconfigureBeanAttributes(). If both methods are called within an observer notification anIllegalStateExceptionis thrown. The container must use the final value of this property, after all observers have been called, to manage instances of the bean.If any observer method of a
ProcessBeanAttributesevent throws an exception, the exception is treated as a definition error by the container.CDI Lite implementations are not required to provide support for Portable Extensions.
- Since:
- 1.1
- Author:
- Pete Muir, Antoine Sabot-Durand
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description voidaddDefinitionError(Throwable t)Registers a definition error with the container, causing the container to abort deployment after bean discovery is complete.BeanAttributesConfigurator<T>configureBeanAttributes()returns aBeanAttributesConfiguratorinitialized with theBeanAttributesprocessed by this event to configure a new BeanAttributes that will replace the original one at the end of the observer invocation.AnnotatedgetAnnotated()BeanAttributes<T>getBeanAttributes()voidignoreFinalMethods()Instructs the container to ignore all non-static, final methods with public, protected or default visibility declared on any bean type of the specific bean during validation of injection points that require proxyable bean type.voidsetBeanAttributes(BeanAttributes<T> beanAttributes)Replaces theBeanAttributes.voidveto()Forces the container to ignore the bean.
-
-
-
Method Detail
-
getAnnotated
Annotated getAnnotated()
- Returns:
- the
AnnotatedTyperepresenting the managed bean class or session bean class, theAnnotatedMethodrepresenting the producer field, or theAnnotatedFieldrepresenting the producer field - Throws:
IllegalStateException- if called outside of the observer method invocation
-
getBeanAttributes
BeanAttributes<T> getBeanAttributes()
- Returns:
- the
BeanAttributesobject that will be used by the container to manage instances of the bean - Throws:
IllegalStateException- if called outside of the observer method invocation
-
setBeanAttributes
void setBeanAttributes(BeanAttributes<T> beanAttributes)
Replaces theBeanAttributes.- Parameters:
beanAttributes- the newBeanAttributesto use- Throws:
IllegalStateException- if called outside of the observer method invocation
-
configureBeanAttributes
BeanAttributesConfigurator<T> configureBeanAttributes()
returns aBeanAttributesConfiguratorinitialized with theBeanAttributesprocessed by this event to configure a new BeanAttributes that will replace the original one at the end of the observer invocation. Each call returns the same BeanAttributesConfigurator.- Returns:
- a non reusable
BeanAttributesConfiguratorto configure the replacing BeanAttributes - Throws:
IllegalStateException- if called outside of the observer method invocation- Since:
- 2.0
-
addDefinitionError
void addDefinitionError(Throwable t)
Registers a definition error with the container, causing the container to abort deployment after bean discovery is complete.- Parameters:
t- the error to add- Throws:
IllegalStateException- if called outside of the observer method invocation
-
veto
void veto()
Forces the container to ignore the bean.- Throws:
IllegalStateException- if called outside of the observer method invocation
-
ignoreFinalMethods
void ignoreFinalMethods()
Instructs the container to ignore all non-static, final methods with public, protected or default visibility declared on any bean type of the specific bean during validation of injection points that require proxyable bean type.
These method should never be invoked upon bean instances. Otherwise, unpredictable behavior results.
- Throws:
IllegalStateException- if called outside of the observer method invocation- Since:
- 2.0
-
-