javax.enterprise.inject.spi

Interface BeanManager

public interface BeanManager

The interface Manager provides operations for obtaining the contextual instance of the webbeans. There are operations related with;

• Adding new webbeans
• Adding new contexts
• Adding new decorators
• Adding new interceptors
• Firing the observer events
• Creating the instance of the contextual beans
• Resolution of beans, interceptors, decorators and observers
• Other utility methods etc..

There is always one root manager in the system. You can set the current activity via call to the BeanManager#setCurrent(Class) method.

Version:

$Rev$ $Date$

Method Summary

Modifier and Type	Method and Description
<T> AnnotatedType<T>	createAnnotatedType(java.lang.Class<T> type) Returns a AnnotatedType instance for the given class.
<T> CreationalContext<T>	createCreationalContext(Contextual<T> contextual) Returns a new creational context implementation.
<T> InjectionTarget<T>	createInjectionTarget(AnnotatedType<T> type) Creates a new instance of injection target.
void	fireEvent(java.lang.Object event, java.lang.annotation.Annotation... qualifiers) Fires an event with given even object and qualifiers.
java.util.Set<Bean<?>>	getBeans(java.lang.String name) Returns set of beans with given name.
java.util.Set<Bean<?>>	getBeans(java.lang.reflect.Type beanType, java.lang.annotation.Annotation... qualifiers) Returns set of beans that their api types contain given bean type and given qualifiers.
Context	getContext(java.lang.Class<? extends java.lang.annotation.Annotation> scope) Returns a context with given scope type.
javax.el.ELResolver	getELResolver() Returns el resolver.
java.lang.Object	getInjectableReference(InjectionPoint injectionPoint, CreationalContext<?> ctx) Gets injection point bean reference.
java.util.Set<java.lang.annotation.Annotation>	getInterceptorBindingDefinition(java.lang.Class<? extends java.lang.annotation.Annotation> qualifier) Returns a set of meta-annotations that are defined on the binding
Bean<?>	getPassivationCapableBean(java.lang.String id) Returns passivation capable bean given id.
java.lang.Object	getReference(Bean<?> bean, java.lang.reflect.Type beanType, CreationalContext<?> ctx) Returns a bean instance reference for the given bean.
java.util.Set<java.lang.annotation.Annotation>	getStereotypeDefinition(java.lang.Class<? extends java.lang.annotation.Annotation> stereotype) Returns a set of meta-annotations that are defined on the stereotype type.
boolean	isInterceptorBinding(java.lang.Class<? extends java.lang.annotation.Annotation> annotationType) Returns true if given type is a interceptor binding, false otherwise.
boolean	isNormalScope(java.lang.Class<? extends java.lang.annotation.Annotation> annotationType) Returns true if given type is a normal scope type, false otherwise.
boolean	isPassivatingScope(java.lang.Class<? extends java.lang.annotation.Annotation> annotationType) Returns true if given type is a passivating scope type, false otherwise.
boolean	isQualifier(java.lang.Class<? extends java.lang.annotation.Annotation> annotationType) Returns true if given type is a qualifier, false otherwise.
boolean	isScope(java.lang.Class<? extends java.lang.annotation.Annotation> annotationType) Returns true if given type is a scope type, false otherwise.
boolean	isStereotype(java.lang.Class<? extends java.lang.annotation.Annotation> annotationType) Returns true if given type is a stereotype type, false otherwise.
<X> Bean<? extends X>	resolve(java.util.Set<Bean<? extends X>> beans) Returns a bean object that is resolved according to the type safe resolution rules.
java.util.List<Decorator<?>>	resolveDecorators(java.util.Set<java.lang.reflect.Type> types, java.lang.annotation.Annotation... qualifiers) Returns a list of decorator.
java.util.List<Interceptor<?>>	resolveInterceptors(InterceptionType type, java.lang.annotation.Annotation... interceptorBindings) Returns a list of interceptor.
<T> java.util.Set<ObserverMethod<? super T>>	resolveObserverMethods(T event, java.lang.annotation.Annotation... qualifiers) Returns set of observer methods.
void	validate(InjectionPoint injectionPoint) Validates injection point.
javax.el.ExpressionFactory	wrapExpressionFactory(javax.el.ExpressionFactory expressionFactory) Wrapped around given expression factory.

Method Detail

getReference

java.lang.Object getReference(Bean<?> bean,
                              java.lang.reflect.Type beanType,
                              CreationalContext<?> ctx)

Returns a bean instance reference for the given bean.

Parameters:

bean - bean that its reference is getting

beanType - bean api type that is implemented by the proxy

ctx - creational context is used to destroy any object with scope @Dependent

Returns:

bean reference

Throws:

java.lang.IllegalArgumentException - if given bean type is not api type of the given bean object

getInjectableReference

java.lang.Object getInjectableReference(InjectionPoint injectionPoint,
                                        CreationalContext<?> ctx)

Gets injection point bean reference.

Parameters:

injectionPoint - injection point definition

ctx - creational context that is passed to the Contextual.create(CreationalContext) method

Returns:

bean reference

Throws:

UnsatisfiedResolutionException - if no bean found for the given injection point

AmbiguousResolutionException - if more than one bean found

createCreationalContext

<T> CreationalContext<T> createCreationalContext(Contextual<T> contextual)

Returns a new creational context implementation.

Returns:

new creational context

getBeans

java.util.Set<Bean<?>> getBeans(java.lang.reflect.Type beanType,
                                java.lang.annotation.Annotation... qualifiers)

Returns set of beans that their api types contain given bean type and given qualifiers.

If no qualifier is given, @Current is assumed.

Parameters:

beanType - required bean type

qualifiers - required qualifiers

Returns:

set of beans

Throws:

java.lang.IllegalArgumentException - given bean type is a TypeVariable

java.lang.IllegalArgumentException - given qualifier annotation is not a qualifier

java.lang.IllegalArgumentException - same qualifier is given

getBeans

java.util.Set<Bean<?>> getBeans(java.lang.String name)

Returns set of beans with given name.

Parameters:

name - name of the bean

Returns:

set of beans with given name

getPassivationCapableBean

Bean<?> getPassivationCapableBean(java.lang.String id)

Returns passivation capable bean given id.

Parameters:

id - bean id

Returns:

passivation capable bean given id

resolve

<X> Bean<? extends X> resolve(java.util.Set<Bean<? extends X>> beans)

Returns a bean object that is resolved according to the type safe resolution rules.

Type Parameters:

X - bean class info

Parameters:

beans - set of beans

Returns:

bean that is resolved according to the type safe resolution rules

Throws:

AmbiguousResolutionException - if ambigious exists

fireEvent

void fireEvent(java.lang.Object event,
               java.lang.annotation.Annotation... qualifiers)

Fires an event with given even object and qualifiers.

Parameters:

event - observer event object

qualifiers - event qualifiers

Throws:

java.lang.IllegalArgumentException - event object contains a TypeVariable

java.lang.IllegalArgumentException - given qualifier annotation is not a qualifier

java.lang.IllegalArgumentException - same qualifier is given

resolveObserverMethods

<T> java.util.Set<ObserverMethod<? super T>> resolveObserverMethods(T event,
                                                                    java.lang.annotation.Annotation... qualifiers)

Returns set of observer methods.

Type Parameters:

T - event type

Parameters:

event - even object

qualifiers - event qualifiers

Returns:

set of observer methods

resolveDecorators

java.util.List<Decorator<?>> resolveDecorators(java.util.Set<java.lang.reflect.Type> types,
                                               java.lang.annotation.Annotation... qualifiers)

Returns a list of decorator.

Parameters:

types - bean types of the decorated bean

qualifiers - decorated bean qualifiers

Returns:

list of decorator

Throws:

java.lang.IllegalArgumentException - given qualifier annotation is not a qualifier

java.lang.IllegalArgumentException - same qualifier is given

java.lang.IllegalArgumentException - if types is empty set

resolveInterceptors

java.util.List<Interceptor<?>> resolveInterceptors(InterceptionType type,
                                                   java.lang.annotation.Annotation... interceptorBindings)

Returns a list of interceptor.

Parameters:

type - interception type

interceptorBindings - interceptor bindings

Returns:

list of interceptor

Throws:

java.lang.IllegalArgumentException - given binding annotation is not a binding

java.lang.IllegalArgumentException - same binding is given

java.lang.IllegalArgumentException - binding is not an interceptor binding

validate

void validate(InjectionPoint injectionPoint)

Validates injection point.

Parameters:

injectionPoint - injection point

Throws:

InjectionException - if problem exist

isScope

boolean isScope(java.lang.Class<? extends java.lang.annotation.Annotation> annotationType)

Returns true if given type is a scope type, false otherwise.

Parameters:

annotationType - annotation type

Returns:

true if given type is a scope type, false otherwise

isNormalScope

boolean isNormalScope(java.lang.Class<? extends java.lang.annotation.Annotation> annotationType)

Returns true if given type is a normal scope type, false otherwise.

Parameters:

annotationType - annotation type

Returns:

true if given type is a scope type, false otherwise

isPassivatingScope

boolean isPassivatingScope(java.lang.Class<? extends java.lang.annotation.Annotation> annotationType)

Returns true if given type is a passivating scope type, false otherwise.

Parameters:

annotationType - annotation type

Returns:

true if given type is a scope type, false otherwise

isQualifier

boolean isQualifier(java.lang.Class<? extends java.lang.annotation.Annotation> annotationType)

Returns true if given type is a qualifier, false otherwise.

Parameters:

annotationType - annotation type

Returns:

true if given type is a qualifier, false otherwise

isInterceptorBinding

boolean isInterceptorBinding(java.lang.Class<? extends java.lang.annotation.Annotation> annotationType)

Returns true if given type is a interceptor binding, false otherwise.

Parameters:

annotationType - annotation type

Returns:

true if given type is a interceptor binding, false otherwise

isStereotype

boolean isStereotype(java.lang.Class<? extends java.lang.annotation.Annotation> annotationType)

Returns true if given type is a stereotype type, false otherwise.

Parameters:

annotationType - annotation type

Returns:

true if given type is a stereotype, false otherwise

getInterceptorBindingDefinition

java.util.Set<java.lang.annotation.Annotation> getInterceptorBindingDefinition(java.lang.Class<? extends java.lang.annotation.Annotation> qualifier)

Returns a set of meta-annotations that are defined on the binding

Parameters:

qualifier - binding class

Returns:

a set of meta-annotations that are defined on the binding

getStereotypeDefinition

java.util.Set<java.lang.annotation.Annotation> getStereotypeDefinition(java.lang.Class<? extends java.lang.annotation.Annotation> stereotype)

Returns a set of meta-annotations that are defined on the stereotype type.

Parameters:

stereotype - stereotype type class

Returns:

a set of meta-annotations that are defined on the stereotype type

getContext

Context getContext(java.lang.Class<? extends java.lang.annotation.Annotation> scope)

Returns a context with given scope type.

Parameters:

scope - scope type class type

Returns:

a context with given scope type

getELResolver

javax.el.ELResolver getELResolver()

Returns el resolver.

Returns:

el resolver

createAnnotatedType

<T> AnnotatedType<T> createAnnotatedType(java.lang.Class<T> type)

Returns a AnnotatedType instance for the given class.

Type Parameters:

T - class type

Parameters:

type - class

Returns:

a AnnotatedType instance

createInjectionTarget

<T> InjectionTarget<T> createInjectionTarget(AnnotatedType<T> type)

Creates a new instance of injection target.

Type Parameters:

T - bean type

Parameters:

type - annotated type

Returns:

injection target

wrapExpressionFactory

javax.el.ExpressionFactory wrapExpressionFactory(javax.el.ExpressionFactory expressionFactory)

Wrapped around given expression factory.

Parameters:

expressionFactory - expression factory

Returns:

wrapped expression factory