org.picketlink.internal

Class IdentityBeanDefinition

java.lang.Object

org.picketlink.internal.IdentityBeanDefinition

All Implemented Interfaces:

Serializable, Contextual<DefaultIdentity>, Bean<DefaultIdentity>, PassivationCapable

public class IdentityBeanDefinition
extends Object
implements Bean<DefaultIdentity>, Serializable, PassivationCapable

Customizes the Identity behavior accordingly with the configuration provided by the application.

Author:

Pedro Igor

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
IdentityBeanDefinition(BeanManager beanManager)

Method Summary

Methods

Modifier and Type	Method and Description
DefaultIdentity	create(CreationalContext<DefaultIdentity> creationalContext) Create a new instance of the contextual type.
void	destroy(DefaultIdentity instance, CreationalContext<DefaultIdentity> creationalContext) Destroy an instance of the contextual type.
Class<DefaultIdentity>	getBeanClass() The bean class of the managed bean or session bean or of the bean that declares the producer method or field.
String	getId() A string that uniquely identifies the instance of Bean or Contextual.
Set<InjectionPoint>	getInjectionPoints() Obtains the InjectionPoint objects representing injection points of the bean, that will be validated by the container at initialization time.
String	getName() Obtains the EL name of a bean, if it has one.
Set<Annotation>	getQualifiers() Obtains the qualifiers of the bean.
Class<? extends Annotation>	getScope() Obtains the scope of the bean.
Set<Class<? extends Annotation>>	getStereotypes() Obtains the stereotypes of the bean.
Set<Type>	getTypes() Obtains the bean types of the bean.
boolean	isAlternative() Determines if the bean is an alternative.
boolean	isNullable() Determines if Contextual.create(CreationalContext) sometimes return a null value.
void	setSecurityConfiguration(SecurityConfiguration securityConfiguration)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

IdentityBeanDefinition

public IdentityBeanDefinition(BeanManager beanManager)

Method Detail

setSecurityConfiguration

public void setSecurityConfiguration(SecurityConfiguration securityConfiguration)

getTypes

public Set<Type> getTypes()

Description copied from interface: Bean

Obtains the bean types of the bean.

Specified by:

getTypes in interface Bean<DefaultIdentity>

Returns:

the bean types

getQualifiers

public Set<Annotation> getQualifiers()

Description copied from interface: Bean

Obtains the qualifiers of the bean.

Specified by:

getQualifiers in interface Bean<DefaultIdentity>

Returns:

the qualifiers

getScope

public Class<? extends Annotation> getScope()

Description copied from interface: Bean

Obtains the scope of the bean.

Specified by:

getScope in interface Bean<DefaultIdentity>

Returns:

the scope

getName

public String getName()

Description copied from interface: Bean

Obtains the EL name of a bean, if it has one.

Specified by:

getName in interface Bean<DefaultIdentity>

Returns:

the EL name

getStereotypes

public Set<Class<? extends Annotation>> getStereotypes()

Description copied from interface: Bean

Obtains the stereotypes of the bean.

Specified by:

getStereotypes in interface Bean<DefaultIdentity>

Returns:

the set of stereotypes

getBeanClass

public Class<DefaultIdentity> getBeanClass()

Description copied from interface: Bean

The bean class of the managed bean or session bean or of the bean that declares the producer method or field.

Specified by:

getBeanClass in interface Bean<DefaultIdentity>

Returns:

the bean class

isAlternative

public boolean isAlternative()

Description copied from interface: Bean

Determines if the bean is an alternative.

Specified by:

isAlternative in interface Bean<DefaultIdentity>

Returns:

true if the bean is an alternative, and false otherwise.

isNullable

public boolean isNullable()

Description copied from interface: Bean

Determines if Contextual.create(CreationalContext) sometimes return a null value.

Specified by:

isNullable in interface Bean<DefaultIdentity>

Returns:

true if the create() method may return a null value, and false otherwise

getInjectionPoints

public Set<InjectionPoint> getInjectionPoints()

Description copied from interface: Bean

Obtains the InjectionPoint objects representing injection points of the bean, that will be validated by the container at initialization time.

Specified by:

getInjectionPoints in interface Bean<DefaultIdentity>

Returns:

the set of injection points of the bean

create

public DefaultIdentity create(CreationalContext<DefaultIdentity> creationalContext)

Description copied from interface: Contextual

Create a new instance of the contextual type. Instances should use the given CreationalContext when obtaining contextual references to inject, in order to ensure that any dependent objects are associated with the contextual instance that is being created. An implementation may call CreationalContext.push(Object) between instantiation and injection to help the container minimize the use of client proxy objects.

Specified by:

create in interface Contextual<DefaultIdentity>

Parameters:

creationalContext - the context in which this instance is being created

Returns:

the contextual instance

destroy

public void destroy(DefaultIdentity instance,
           CreationalContext<DefaultIdentity> creationalContext)

Description copied from interface: Contextual

Destroy an instance of the contextual type. Implementations should call CreationalContext.release() to allow the container to destroy dependent objects of the contextual instance.

Specified by:

destroy in interface Contextual<DefaultIdentity>

Parameters:

instance - the contextual instance to destroy

creationalContext - the context in which this instance was created

getId

public String getId()

Description copied from interface: PassivationCapable

A string that uniquely identifies the instance of Bean or Contextual. It is recommended that the string contain the package name of the class that implements Bean or Contextual.

Specified by:

getId in interface PassivationCapable

Returns:

a unique identifier for the Bean or Contextual