Class ExternalContextFactory
- java.lang.Object
-
- jakarta.faces.context.ExternalContextFactory
-
- All Implemented Interfaces:
FacesWrapper<ExternalContextFactory>
public abstract class ExternalContextFactory extends 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 Summary
Constructors Constructor 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.
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description abstract ExternalContext
getExternalContext(Object context, Object request, Object response)
Create (if needed) and return anExternalContext
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.
-
-
-
Constructor Detail
-
ExternalContextFactory
@Deprecated public ExternalContextFactory()
Deprecated.Use the other constructor taking the implementation being wrapped.
-
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.- Parameters:
wrapped
- The implementation being wrapped.
-
-
Method Detail
-
getWrapped
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.
- Specified by:
getWrapped
in interfaceFacesWrapper<ExternalContextFactory>
- Returns:
- the wrapped instance.
- Since:
- 2.0
-
getExternalContext
public abstract ExternalContext getExternalContext(Object context, Object request, 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.- Parameters:
context
- In Jakarta Servlet environments, theServletContext
that is associated with this web applicationrequest
- In Jakarta Servlet environments, theServletRequest
that is to be processedresponse
- In Jakarta Servlet environments, theServletResponse
that is to be processed- Returns:
- the instance of
ExternalContext
. - Throws:
FacesException
- if aExternalContext
cannot be constructed for the specified parametersNullPointerException
- if any of the parameters arenull
-
-