Jakarta EE 11.0.0 · jakarta.faces.FactoryFinderInstance

Modifier and Type	Field and Description
private final String	createdBy
private final Map<String, Object>	factories
private static final Map<String, Class<?>>	factoryClasses Map of Class instances for our factory names.
private static final List<String>	factoryNames The set of Jakarta Faces factory classes for which the factory discovery mechanism is supported.
private static final String	INJECTION_PROVIDER_KEY
private final ReentrantReadWriteLock	lock
private static final Logger	LOGGER
private final Map<String, List<String>>	savedFactoryNames
private ServletContextFacesContextFactory	servletContextFinder

Access	Constructor and Description
pack-priv	FactoryFinderInstance(FacesContext facesContext)
pack-priv	FactoryFinderInstance(FacesContext facesContext, FactoryFinderInstance toCopy)

Method Summary

Modifier and Type	Method and Description
pack-priv void	addFactory(String factoryName, String implementationClassName)
private static <T extends Comparable<T>> List<T>	asSortedList(T... elements)
private static Map<String, Class<?>>	buildFactoryClassesMap()
pack-priv void	clearInjectionProvider()
private void	copyInjectionProviderFromFacesContext(FacesContext facesContext)
pack-priv Collection<Object>	getFactories()
pack-priv Object	getFactory(String factoryName)
private Class<?>	Returns: the `java.lang.Class` for the argument factory. getFactoryClass(String factoryClassName)
private Object	getImplementationInstance(ClassLoader Class loader for the web application that will be loading the implementation class classLoader, String factoryName, List<String> A List of implementations for a given factory class. implementations) Load and return an instance of the specified implementation class using the following algorithm.
private Object	getImplGivenPreviousImpl(ClassLoader the ClassLoader from which to load the class classLoader, String the fully qualified class name of the factory. factoryName, String the fully qualified class name of a class that implements the factory. factoryImplClassName, Object if non-`null`, the factory instance to be passed to the constructor of the new factory. previousFactoryImplementation) Implement the decorator pattern for the factory implementation.
private List<String>	getImplNameFromServices(ClassLoader classLoader, String factoryName) Perform the logic to get the implementation class for the second step of `FactoryFinder#getImplementationInstance(ClassLoader, String, java.util.List)`.
pack-priv InjectionProvider	getInjectionProvider()
private void	injectImplementation(String implementationName, Object implementation)
private void	logNoFactory(String factoryName)
private void	logPreDestroyFail(Object factory, Exception ex)
private void	notNullFactory(String factoryName, Object factory)
private String	readLineFromStream(InputStream stream)
pack-priv void	releaseFactories()
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.
private void	validateFactoryName(String factoryName)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

createdBy	back to summary
private final String createdBy

factories	back to summary
private final Map<String, Object> factories

factoryClasses	back to summary
private static final Map<String, Class<?>> factoryClasses Map of Class instances for our factory names.

factoryNames	back to summary
private static final List<String> factoryNames The set of Jakarta Faces factory classes for which the factory discovery mechanism is supported. The entries in this list must be alphabetically ordered according to the entire string of the value of each of the literals, not just the last part of the literal!

INJECTION_PROVIDER_KEY	back to summary
private static final String INJECTION_PROVIDER_KEY

lock	back to summary
private final ReentrantReadWriteLock lock

LOGGER	back to summary
private static final Logger LOGGER

savedFactoryNames	back to summary
private final Map<String, List<String>> savedFactoryNames

servletContextFinder	back to summary
private ServletContextFacesContextFactory servletContextFinder

FactoryFinderInstance	back to summary
pack-priv FactoryFinderInstance(FacesContext facesContext)

FactoryFinderInstance	back to summary
pack-priv FactoryFinderInstance(FacesContext facesContext, FactoryFinderInstance toCopy)

Method Detail

addFactory	back to summary
pack-priv void addFactory(String factoryName, String implementationClassName)

asSortedList	back to summary
private static <T extends Comparable<T>> List<T> asSortedList(T... elements) Annotations @SafeVarargs

buildFactoryClassesMap	back to summary
private static Map<String, Class<?>> buildFactoryClassesMap()

clearInjectionProvider	back to summary
pack-priv void clearInjectionProvider()

copyInjectionProviderFromFacesContext	back to summary
private void copyInjectionProviderFromFacesContext(FacesContext facesContext)

getFactories	back to summary
pack-priv Collection<Object> getFactories()

getFactory	back to summary
pack-priv Object getFactory(String factoryName) Annotations @SuppressWarnings:unchecked

getFactoryClass	back to summary
private Class<?> getFactoryClass(String factoryClassName) Returns:Class<?> the `java.lang.Class` for the argument factory.

getImplementationInstance back to summary

getImplementationInstance	back to summary
private Object getImplementationInstance(ClassLoader classLoader, String factoryName, List<String> implementations) throws FacesException Load and return an instance of the specified implementation class using the following algorithm. If the argument `implementations` list has more than one element, or exactly one element, interpret the last element in the list to be the fully qualified class name of a class implementing `factoryName`. Instantiate that class and save it for return. If the `implementations` list has only one element, skip this step. Look for a resource called `/META-INF/services/<factoryName>`. If found, interpret it as a properties file, and read out the first entry. Interpret the first entry as a fully qualify class name of a class that implements `factoryName`. If we have an instantiated factory from the previous step and the implementing class has a one arg constructor of the type for `factoryName`, instantiate it, passing the instantiated factory from the previous step. If there is no one arg constructor, just instantiate the zero arg constructor. Save the newly instantiated factory for return, replacing the instantiated factory from the previous step. Treat each remaining element in the `implementations` list as a fully qualified class name of a class implementing `factoryName`. If the currentKeyrent element has a one arg constructor of the type for `factoryName`, instantiate it, passing the instantiated factory from the previous or step iteration. If there is no one arg constructor, just instantiate the zero arg constructor, replacing the instantiated factory from the previous step or iteration. Return the saved factory Parameters classLoader:ClassLoader Class loader for the web application that will be loading the implementation class implementations:List<String> A List of implementations for a given factory class. Exceptions FacesException: if the specified implementation class cannot be loaded if an instance of the specified implementation class cannot be instantiated

private Object getImplementationInstance(ClassLoader classLoader, String factoryName, List<String> implementations) throws FacesException

Load and return an instance of the specified implementation class using the following algorithm.

If the argument implementations list has more than one element, or exactly one element, interpret the last element in the list to be the fully qualified class name of a class implementing factoryName. Instantiate that class and save it for return. If the implementations list has only one element, skip this step.
Look for a resource called /META-INF/services/<factoryName>. If found, interpret it as a properties file, and read out the first entry. Interpret the first entry as a fully qualify class name of a class that implements factoryName. If we have an instantiated factory from the previous step and the implementing class has a one arg constructor of the type for factoryName, instantiate it, passing the instantiated factory from the previous step. If there is no one arg constructor, just instantiate the zero arg constructor. Save the newly instantiated factory for return, replacing the instantiated factory from the previous step.
Treat each remaining element in the implementations list as a fully qualified class name of a class implementing factoryName. If the currentKeyrent element has a one arg constructor of the type for factoryName, instantiate it, passing the instantiated factory from the previous or step iteration. If there is no one arg constructor, just instantiate the zero arg constructor, replacing the instantiated factory from the previous step or iteration.
Return the saved factory

Parameters

classLoader:ClassLoader: Class loader for the web application that will be loading the implementation class
implementations:List<String>: A List of implementations for a given factory class.

Exceptions

FacesException:

if the specified implementation class cannot be loaded
if an instance of the specified implementation class cannot be instantiated

getImplGivenPreviousImpl back to summary

getImplGivenPreviousImpl	back to summary
private Object getImplGivenPreviousImpl(ClassLoader classLoader, String factoryName, String factoryImplClassName, Object previousFactoryImplementation) Implement the decorator pattern for the factory implementation. If `previousImpl` is non-`null` and the class named by the argument `implName` has a one arg contstructor of type `factoryName`, instantiate it, passing previousImpl to the constructor. Otherwise, we just instantiate and return `implName`. Parameters classLoader:ClassLoader the ClassLoader from which to load the class factoryName:String the fully qualified class name of the factory. factoryImplClassName:String the fully qualified class name of a class that implements the factory. previousFactoryImplementation:Object if non-`null`, the factory instance to be passed to the constructor of the new factory.

private Object getImplGivenPreviousImpl(ClassLoader classLoader, String factoryName, String factoryImplClassName, Object previousFactoryImplementation)

Implement the decorator pattern for the factory implementation.

If previousImpl is non-null and the class named by the argument implName has a one arg contstructor of type factoryName, instantiate it, passing previousImpl to the constructor.

Otherwise, we just instantiate and return implName.

Parameters

classLoader:ClassLoader: the ClassLoader from which to load the class
factoryName:String: the fully qualified class name of the factory.
factoryImplClassName:String: the fully qualified class name of a class that implements the factory.
previousFactoryImplementation:Object: if non-null, the factory instance to be passed to the constructor of the new factory.

getImplNameFromServices	back to summary
private List<String> getImplNameFromServices(ClassLoader classLoader, String factoryName) Perform the logic to get the implementation class for the second step of `FactoryFinder#getImplementationInstance(ClassLoader, String, java.util.List)`.

getInjectionProvider	back to summary
pack-priv InjectionProvider getInjectionProvider()

injectImplementation	back to summary
private void injectImplementation(String implementationName, Object implementation)

logNoFactory	back to summary
private void logNoFactory(String factoryName)

logPreDestroyFail	back to summary
private void logPreDestroyFail(Object factory, Exception ex)

notNullFactory	back to summary
private void notNullFactory(String factoryName, Object factory)

readLineFromStream	back to summary
private String readLineFromStream(InputStream stream) throws IOException

releaseFactories	back to summary
pack-priv void releaseFactories()

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Satisfying this method's contract implies a non-`null` result must be returned. Returns:String a string representation of the object Annotations @Override

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations

@Override

validateFactoryName	back to summary
private void validateFactoryName(String factoryName)

pack-priv final Class FactoryFinderInstance

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail