Top Description Methods
javax.enterprise.context.spi

public Interface Context

Known Direct Subinterfaces
javax.enterprise.context.spi.AlterableContext
Imports
java.lang.annotation.Annotation, javax.enterprise.context.ContextNotActiveException

Provides an operation for obtaining contextual instances with a particular scope of any contextual type. Any instance of Context is called a context object.

AlterableContext was introduced in CDI 1.1 to allow bean instances to be destroyed by the application. Extensions should implement AlterableContext instead of Context.

The context object is responsible for creating and destroying contextual instances by calling operations of javax.enterprise.context.spi.Contextual. In particular, the context object is responsible for destroying any contextual instance it creates by passing the instance to javax.enterprise.context.spi.Contextual#destroy(Object, CreationalContext) . A destroyed instance must not subsequently be returned by get(). The context object must pass the same instance of javax.enterprise.context.spi.CreationalContext to Contextual.destroy() that it passed to Contextual.create() when it created the instance.

A custom context object may be registered with the container using javax.enterprise.inject.spi.AfterBeanDiscovery#addContext(Context).

Authors
Gavin King, Pete Muir

Method Summary

Modifier and TypeMethod and Description
public <
the type of contextual type
T
>
T

Returns:

the contextual instance
get
(Contextual<T>
the contextual type
contextual
,
CreationalContext<T>
the context in which the new instance will be created
creationalContext
)

Return an existing instance of certain contextual type or create a new instance by calling javax.enterprise.context.spi.Contextual#create(CreationalContext) and return the new instance.

public <
the type of the contextual type
T
>
T

Returns:

the contextual instance, or a null value
get
(Contextual<T>
the contextual type
contextual
)

Return an existing instance of a certain contextual type or a null value.

public Class<? extends Annotation>

Returns:

the scope
getScope
()

Get the scope type of the context object.

public boolean

Returns:

true if the context is active, or false otherwise.
isActive
()

Determines if the context object is active.

Method Detail

getback to summary
public <T> T get(Contextual<T> contextual, CreationalContext<T> creationalContext)

Return an existing instance of certain contextual type or create a new instance by calling javax.enterprise.context.spi.Contextual#create(CreationalContext) and return the new instance.

Parameters
<T>
the type of contextual type
contextual:Contextual<T>

the contextual type

creationalContext:CreationalContext<T>

the context in which the new instance will be created

Returns:T

the contextual instance

Exceptions
ContextNotActiveException:
if the context is not active
getback to summary
public <T> T get(Contextual<T> contextual)

Return an existing instance of a certain contextual type or a null value.

Parameters
<T>
the type of the contextual type
contextual:Contextual<T>

the contextual type

Returns:T

the contextual instance, or a null value

Exceptions
ContextNotActiveException:
if the context is not active
getScopeback to summary
public Class<? extends Annotation> getScope()

Get the scope type of the context object.

Returns:Class<? extends Annotation>

the scope

isActiveback to summary
public boolean isActive()

Determines if the context object is active.

Returns:boolean

true if the context is active, or false otherwise.