Module jakarta.faces

Package com.sun.faces.cdi

Class ExternalContextProducer

java.lang.Object

com.sun.faces.cdi.ExternalContextProducer

All Implemented Interfaces:

Contextual<ExternalContext>, Bean<ExternalContext>, BeanAttributes<ExternalContext>, PassivationCapable, Serializable

public class ExternalContextProducer
extends Object

The ExternalContextProducer is the CDI producer that allows injection of the ExternalContext using @Inject and allows EL resolving of #{externalContext}

Since:

2.3

See Also:

• FacesContext
• Serialized Form

Constructor Summary

Constructors

Constructor	Description
ExternalContextProducer()

Method Summary

Modifier and Type	Method	Description
protected com.sun.faces.cdi.CdiProducer<ExternalContext>	addToId(Object object)
ExternalContext	create(CreationalContext<ExternalContext> creationalContext)	Create a new instance of the contextual type.
protected com.sun.faces.cdi.CdiProducer<ExternalContext>	create(Function<CreationalContext<ExternalContext>,ExternalContext> create)
void	destroy(ExternalContext instance, CreationalContext<ExternalContext> creationalContext)	Destroy the instance.
Class<?>	getBeanClass()	The bean class of the managed bean or session bean or of the bean that declares the producer method or field.
String	getId()	Get the ID of this particular instantiation of the producer.
Set<InjectionPoint>	getInjectionPoints()	Get the injection points.
String	getName()	Obtains the EL name of a bean, if it has one.
Set<Annotation>	getQualifiers()	Get the default qualifier.
Class<? extends Annotation>	getScope()	Obtains the scope of the bean.
Set<Class<? extends Annotation>>	getStereotypes()	Get the stereotypes.
Set<Type>	getTypes()	Obtains the bean types of the bean.
boolean	isAlternative()	Is this an alternative.
boolean	isNullable()
protected com.sun.faces.cdi.CdiProducer<ExternalContext>	name(String name)
protected com.sun.faces.cdi.CdiProducer<ExternalContext>	qualifiers(Annotation... qualifiers)
protected com.sun.faces.cdi.CdiProducer<ExternalContext>	scope(Class<? extends Annotation> scope)
protected com.sun.faces.cdi.CdiProducer<ExternalContext>	types(Type... types)

Methods inherited from class java.lang.Object

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

Constructor Details

ExternalContextProducer

public ExternalContextProducer()

Method Details

getId

public String getId()

Get the ID of this particular instantiation of the producer.

This is an implementation detail of CDI, where it wants to relocate a particular producer in order to re-inject a value. This is typically used in combination with passivation. Note that this is NOT about the value we're producing, but about the producer itself.

Specified by:

getId in interface PassivationCapable

Returns:

the ID of this particular instantiation of the producer

getName

public String getName()

Description copied from interface: BeanAttributes

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

Specified by:

getName in interface BeanAttributes<T>

Returns:

the EL name

getBeanClass

public Class<?> 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<T>

Returns:

the bean class

getTypes

public Set<Type> getTypes()

Description copied from interface: BeanAttributes

Obtains the bean types of the bean.

Specified by:

getTypes in interface BeanAttributes<T>

Returns:

the bean types

getQualifiers

public Set<Annotation> getQualifiers()

Get the default qualifier.

Specified by:

getQualifiers in interface BeanAttributes<T>

Returns:

the qualifiers, which in the default case only contains the Default

getScope

public Class<? extends Annotation> getScope()

Description copied from interface: BeanAttributes

Obtains the scope of the bean.

Specified by:

getScope in interface BeanAttributes<T>

Returns:

the scope

create

public ExternalContext create(CreationalContext<ExternalContext> 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<T>

Parameters:

creationalContext - the context in which this instance is being created

Returns:

the contextual instance

destroy

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

Destroy the instance.

Since most artifact that the sub classes are producing are artifacts that the Faces runtime really is managing the destroy method here does not need to do anything.

Specified by:

destroy in interface Contextual<T>

Parameters:

instance - the instance.

creationalContext - the creational context.

getInjectionPoints

public Set<InjectionPoint> getInjectionPoints()

Get the injection points.

Specified by:

getInjectionPoints in interface Bean<T>

Returns:

the injection points.

getStereotypes

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

Get the stereotypes.

Specified by:

getStereotypes in interface BeanAttributes<T>

Returns:

the stereotypes.

isAlternative

public boolean isAlternative()

Is this an alternative.

Specified by:

isAlternative in interface BeanAttributes<T>

Returns:

false.

isNullable

public boolean isNullable()

name

protected com.sun.faces.cdi.CdiProducer<ExternalContext> name(String name)

create

protected com.sun.faces.cdi.CdiProducer<ExternalContext> create(Function<CreationalContext<ExternalContext>,ExternalContext> create)

types

protected com.sun.faces.cdi.CdiProducer<ExternalContext> types(Type... types)

qualifiers

protected com.sun.faces.cdi.CdiProducer<ExternalContext> qualifiers(Annotation... qualifiers)

scope

protected com.sun.faces.cdi.CdiProducer<ExternalContext> scope(Class<? extends Annotation> scope)

addToId

protected com.sun.faces.cdi.CdiProducer<ExternalContext> addToId(Object object)