public abstract class ExternalContextFactory extends java.lang.Object implements FacesWrapper<ExternalContextFactory>
ExternalContextFactory is a factory object that
creates (if needed) and returns new ExternalContext
instances, initialized for the processing of the
specified request and response objects.
There must be one ExternalContextFactory
instance per web application that is utilizing Jakarta Server
Faces. This instance can be acquired, in a portable manner, by calling:
ExternalContextFactory factory = (ExternalContextFactory) FactoryFinder.getFactory(FactoryFinder.EXTERNAL_CONTEXT_FACTORY);
Usage: extend this class and push the implementation being wrapped to the constructor and use getWrapped()
to
access the instance being wrapped.
Constructor and Description |
---|
ExternalContextFactory()
Deprecated.
Use the other constructor taking the implementation being wrapped.
|
ExternalContextFactory(ExternalContextFactory wrapped)
If this factory has been decorated, the implementation doing the decorating should push the implementation being wrapped to this constructor. |
Modifier and Type | Method and Description |
---|---|
abstract ExternalContext |
getExternalContext(java.lang.Object context,
java.lang.Object request,
java.lang.Object response)
Create (if needed) and return an
ExternalContext instance that is
initialized for the processing of the specified request and response objects, for this web application. |
ExternalContextFactory |
getWrapped()
If this factory has been decorated, the implementation doing the decorating may override this method to provide access to the implementation being wrapped. |
@Deprecated public ExternalContextFactory()
public ExternalContextFactory(ExternalContextFactory wrapped)
If this factory has been decorated, the implementation doing the decorating should push the implementation being
wrapped to this constructor. The getWrapped()
will then return the implementation being wrapped.
wrapped
- The implementation being wrapped.public ExternalContextFactory getWrapped()
If this factory has been decorated, the implementation doing the decorating may override this method to provide access to the implementation being wrapped.
getWrapped
in interface FacesWrapper<ExternalContextFactory>
public abstract ExternalContext getExternalContext(java.lang.Object context, java.lang.Object request, java.lang.Object response) throws FacesException
Create (if needed) and return an ExternalContext
instance that is
initialized for the processing of the specified request and response objects, for this web application.
context
- In Jakarta Servlet environments, the ServletContext
that is associated with this web
applicationrequest
- In Jakarta Servlet environments, the ServletRequest
that is to be processedresponse
- In Jakarta Servlet environments, the ServletResponse
that is to be processedExternalContext
.FacesException
- if a ExternalContext
cannot be constructed for the specified parametersjava.lang.NullPointerException
- if any of the parameters are null