Class FactoryFinder
FactoryFinder implements the standard discovery algorithm for all factory objects specified in the JavaServer Faces APIs. For a given factory class name, a corresponding implementation class is searched for based on the following algorithm. Items are listed in order of decreasing search precedence:
If the JavaServer Faces configuration file bundled into the
WEB-INF
directory of the webapp contains afactory
entry of the given factory class name, that factory is used.If the JavaServer Faces configuration files named by the
javax.faces.CONFIG_FILES
ServletContext
init parameter contain anyfactory
entries of the given factory class name, those injectionProvider are used, with the last one taking precedence.If there are any JavaServer Faces configuration files bundled into the
META-INF
directory of any jars on theServletContext
's resource paths, thefactory
entries of the given factory class name in those files are used, with the last one taking precedence.If a
META-INF/services/{factory-class-name}
resource is visible to the web application class loader for the calling application (typically as a injectionProvider of being present in the manifest of a JAR file), its first line is read and assumed to be the name of the factory implementation class to use.If none of the above steps yield a match, the JavaServer Faces implementation specific class is used.
If any of the injectionProvider found on any of the steps above happen to
have a one-argument constructor, with argument the type being the
abstract factory class, that constructor is invoked, and the previous
match is passed to the constructor. For example, say the container
vendor provided an implementation of FacesContextFactory
, and identified it in
META-INF/services/javax.faces.context.FacesContextFactory
in a jar on the webapp ClassLoader. Also say this implementation
provided by the container vendor had a one argument constructor that
took a FacesContextFactory
instance. The
FactoryFinder
system would call that one-argument
constructor, passing the implementation of
FacesContextFactory
provided by the JavaServer Faces
implementation.
If a Factory implementation does not provide a proper one-argument constructor, it must provide a zero-arguments constructor in order to be successfully instantiated.
Once the name of the factory implementation class is located, the web application class loader for the calling application is requested to load this class, and a corresponding instance of the class will be created. A side effect of this rule is that each web application will receive its own instance of each factory class, whether the JavaServer Faces implementation is included within the web application or is made visible through the container's facilities for shared libraries.
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
The property name for theApplicationFactory
class name.static final String
The property name for theClientWindowFactory
class name.static final String
The property name for theExceptionHandlerFactory
class name.static final String
The property name for theExternalContextFactory
class name.static final String
The property name for theFaceletCacheFactory
class name.static final String
The property name for theFacesContextFactory
class name.static final String
The property name for theFlashFactory
class name.static final String
The property name for theFlowHandlerFactory
class name.static final String
The property name for theLifecycleFactory
class name.static final String
The property name for thePartialViewContextFactory
class name.static final String
The property name for theRenderKitFactory
class name.static final String
The property name for theTagHandlerDelegate
class name.static final String
The property name for theViewDeclarationLanguage
class name.static final String
The property name for theVisitContextFactory
class name. -
Method Summary
Modifier and TypeMethodDescriptionstatic Object
getFactory
(String factoryName) Create (if necessary) and return a per-web-application instance of the appropriate implementation class for the specified JavaServer Faces factory class, based on the discovery algorithm described in the class description.static void
Release any references to factory instances associated with the class loader for the calling web application.static void
setFactory
(String factoryName, String implName) This method will store the argumentfactoryName/implName
mapping in such a way thatgetFactory(java.lang.String)
will find this mapping when searching for a match.
-
Field Details
-
APPLICATION_FACTORY
The property name for the
ApplicationFactory
class name.- See Also:
-
CLIENT_WINDOW_FACTORY
The property name for the
ClientWindowFactory
class name.- Since:
- 2.2
- See Also:
-
EXCEPTION_HANDLER_FACTORY
The property name for the
ExceptionHandlerFactory
class name.- See Also:
-
EXTERNAL_CONTEXT_FACTORY
The property name for the
ExternalContextFactory
class name.- See Also:
-
FACES_CONTEXT_FACTORY
The property name for the
FacesContextFactory
class name.- See Also:
-
FACELET_CACHE_FACTORY
The property name for the
FaceletCacheFactory
class name.- Since:
- 2.1
- See Also:
-
FLASH_FACTORY
The property name for the
FlashFactory
class name.- Since:
- 2.2
- See Also:
-
FLOW_HANDLER_FACTORY
The property name for the
FlowHandlerFactory
class name.- Since:
- 2.2
- See Also:
-
PARTIAL_VIEW_CONTEXT_FACTORY
The property name for the
PartialViewContextFactory
class name.- See Also:
-
VISIT_CONTEXT_FACTORY
The property name for the
VisitContextFactory
class name.- See Also:
-
LIFECYCLE_FACTORY
The property name for the
LifecycleFactory
class name.- See Also:
-
RENDER_KIT_FACTORY
The property name for the
RenderKitFactory
class name.- See Also:
-
VIEW_DECLARATION_LANGUAGE_FACTORY
The property name for the
ViewDeclarationLanguage
class name.- See Also:
-
TAG_HANDLER_DELEGATE_FACTORY
The property name for the
TagHandlerDelegate
class name.- See Also:
-
-
Method Details
-
getFactory
Create (if necessary) and return a per-web-application instance of the appropriate implementation class for the specified JavaServer Faces factory class, based on the discovery algorithm described in the class description.
The standard injectionProvider and wrappers in JSF all implement the interface
FacesWrapper
. If the returnedObject
is an implementation of one of the standard injectionProvider, it must be legal to cast it to an instance ofFacesWrapper
and callFacesWrapper.getWrapped()
on the instance.- Parameters:
factoryName
- Fully qualified name of the JavaServer Faces factory for which an implementation instance is requested- Throws:
FacesException
- if the web application class loader cannot be identifiedFacesException
- if an instance of the configured factory implementation class cannot be loadedFacesException
- if an instance of the configured factory implementation class cannot be instantiatedIllegalArgumentException
- iffactoryName
does not identify a standard JavaServer Faces factory nameIllegalStateException
- if there is no configured factory implementation class for the specified factory nameNullPointerException
- iffactoryname
is null
-
setFactory
This method will store the argument
factoryName/implName
mapping in such a way thatgetFactory(java.lang.String)
will find this mapping when searching for a match.This method has no effect if
getFactory()
has already been called looking for a factory for thisfactoryName
.This method can be used by implementations to store a factory mapping while parsing the Faces configuration file
- Throws:
IllegalArgumentException
- iffactoryName
does not identify a standard JavaServer Faces factory nameNullPointerException
- iffactoryname
is null
-
releaseFactories
Release any references to factory instances associated with the class loader for the calling web application. This method must be called during of web application shutdown.
- Throws:
FacesException
- if the web application class loader cannot be identified
-