org.jboss.weld.serialization.spi

Interface ContextualStore

All Superinterfaces:

Service

All Known Implementing Classes:

ContextualStoreImpl

public interface ContextualStore
extends Service

Application wide contextual identifier service which allows a serializable reference to a contextual to be obtained, and the contextual to be returned for a given id.

If the contextual implements PassivationCapable, the id will be obtained from it, in which case the Contextual can be activated in any container. If not, the Contextual can only be activated in this container.

Note that this allows a Bean object to be loaded regardless of the bean's accessiblity from the current module, and should not be abused as a way to ignore accessibility rules enforced during resolution.

Author:

Pete Muir, Marius Bogoevici

Method Summary

Modifier and Type	Method and Description
<C extends Contextual<I>,I> C	getContextual(BeanIdentifier identifier)
<C extends Contextual<I>,I> C	getContextual(java.lang.String id) Given a particular id, return the correct contextual.
<C extends Contextual<I>,I> SerializableContextual<C,I>	getSerializableContextual(Contextual<I> contextual) Returns a SerializableContextual that corresponds to the given Contextual
<C extends Contextual<I>,I> SerializableContextualInstance<C,I>	getSerializableContextualInstance(Contextual<I> contextual, I instance, CreationalContext<I> creationalContext) Returns a SerializableContextualInstance that corresponds to the given instance and Contextual
BeanIdentifier	putIfAbsent(Contextual<?> contextual) Add a contextual (if not already present) to the store, and return it's id.

Methods inherited from interface org.jboss.weld.bootstrap.api.Service

cleanup

Method Detail

getContextual

<C extends Contextual<I>,I> C getContextual(java.lang.String id)

Given a particular id, return the correct contextual. For contextuals which aren't passivation capable, the contextual can't be found in another container, and null will be returned.

Type Parameters:

C - the contextual

I - the type of the contextual

Parameters:

id - An identifier for the contextual

Returns:

the contextual

getContextual

<C extends Contextual<I>,I> C getContextual(BeanIdentifier identifier)

putIfAbsent

BeanIdentifier putIfAbsent(Contextual<?> contextual)

Add a contextual (if not already present) to the store, and return it's id. If the contextual is passivation capable, it's id will be used, otherwise an id will be generated

Parameters:

contextual - the contexutal to add

Returns:

the current id for the contextual

getSerializableContextual

<C extends Contextual<I>,I> SerializableContextual<C,I> getSerializableContextual(Contextual<I> contextual)

Returns a SerializableContextual that corresponds to the given Contextual

Type Parameters:

C - the contextual

I - the type of the contextual

Parameters:

contextual - the contextual for which the serializable contextual is created

Returns:

a serializable contextual

getSerializableContextualInstance

<C extends Contextual<I>,I> SerializableContextualInstance<C,I> getSerializableContextualInstance(Contextual<I> contextual,
                                                                                                  I instance,
                                                                                                  CreationalContext<I> creationalContext)

Returns a SerializableContextualInstance that corresponds to the given instance and Contextual

Type Parameters:

C - the contextual

I - the type of the contextual

Parameters:

contextual - the contextual for which the serializable contextual instance is returned

instance - the instance

creationalContext - the creational context of the instance

Returns:

the serializable contextual instance