Jakarta EE 11.0.0 · com.sun.faces.config.ConfigManager

Field Summary

Modifier and Type	Field and Description
private static final String	ANNOTATIONS_SCAN_TASK_KEY The application-scoped key under which the Future responsible for annotation scanning is associated with.
private static final String	CONFIG_MANAGER_INSTANCE_KEY
private final List<ConfigProcessor>	configProcessors
private final ConfigProcessor	faceletTaglibConfigProcessor The chain of `ConfigProcessor` instances to processing of facelet-taglib documents.
private final List<ConfigurationResourceProvider>	facesConfigProviders A List of resource providers that search for faces-config documents.
private final List<ConfigurationResourceProvider>	facesletsTagLibConfigProviders A List of resource providers that search for faces-config documents.
private final List<ServletContext>	initializedContexts Contains each `ServletContext` that we've initialized.
public static final String	INJECTION_PROVIDER_KEY The initialization time FacesContext scoped key under which the InjectionProvider is stored.
private static final Logger	LOGGER
private static final int	NUMBER_OF_TASK_THREADS The `ConfigManager` will multithread the calls to the `ConfigurationResourceProvider`s as well as any calls to parse a resources into a DOM.

Constructor Summary

Access	Constructor and Description
public	ConfigManager()

Method Summary

Modifier and Type	Method and Description
private static ExecutorService	createExecutorService() Create a new `ExecutorService` with `NUMBER_OF_TASK_THREADS` threads.
public static ConfigManager	createInstance(ServletContext servletContext)
public void	destroy(ServletContext the `ServletContext` for the application that needs to be removed servletContext, FacesContext the `FacesContext` for the application that needs to be removed facesContext) This method will remove any information about the application.
private void	findAnnotations(DocumentInfo[] facesDocuments, InjectionProvider containerConnector, ServletContext servletContext, InitFacesContext context, ExecutorService executor) Execute the Task responsible for finding annotation classes
public static Map<Class<? extends Annotation>, Set<Class<?>>>	Returns: the results of the annotation scan task getAnnotatedClasses(FacesContext the involved faces context ctx)
private List<ApplicationConfigurationPopulator>	getConfigPopulators()
private List<ConfigurationResourceProvider>	getConfigurationResourceProviders(List<ConfigurationResourceProvider> defaultProviders, ConfigurationResourceProviderFactory.ProviderType providerType)
private List<ConfigurationResourceProvider>	getFaceletConfigResourceProviders()
private List<ConfigurationResourceProvider>	getFacesConfigResourceProviders()
public static ConfigManager	Returns: a `ConfigManager` instance getInstance(ServletContext the involved servlet context servletContext)
private ThreadContext	getThreadContext(InjectionProvider containerConnector)
public boolean	Returns: `true` if this application has already been initialized, otherwise returns `fase` hasBeenInitialized(ServletContext the `ServletContext` for the application in question servletContext)
public void	initialize(ServletContext the `ServletContext` for the application that requires initialization servletContext, InitFacesContext the involved initialization faces context facesContext) This method bootstraps Faces based on the parsed configuration resources.
private void	initializeConfigProcessors(ServletContext servletContext, FacesContext facesContext)
pack-priv void	publishPostConfigEvent() Publishes a `jakarta.faces.event.PostConstructApplicationEvent` event for the current `Application` instance.
private void	pushTaskToContext(ServletContext servletContext, Future<Map<Class<? extends Annotation>, Set<Class<?>>>> scanTask) Push the provided `Future` to the specified `ServletContext`.
private void	releaseFactories() Calls through to `jakarta.faces.FactoryFinder#releaseFactories()` ignoring any exceptions.
public static void	removeInstance(ServletContext servletContext)
private boolean	useThreads(ServletContext ctx)

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

Field Detail

ANNOTATIONS_SCAN_TASK_KEY	back to summary
private static final String ANNOTATIONS_SCAN_TASK_KEY The application-scoped key under which the Future responsible for annotation scanning is associated with.

CONFIG_MANAGER_INSTANCE_KEY	back to summary
private static final String CONFIG_MANAGER_INSTANCE_KEY

configProcessors	back to summary
private final List<ConfigProcessor> configProcessors

faceletTaglibConfigProcessor	back to summary
private final ConfigProcessor faceletTaglibConfigProcessor The chain of `ConfigProcessor` instances to processing of facelet-taglib documents.

facesConfigProviders	back to summary
private final List<ConfigurationResourceProvider> facesConfigProviders A List of resource providers that search for faces-config documents. By default, this contains a provider for the Mojarra, and two other providers to satisfy the requirements of the specification.

facesletsTagLibConfigProviders	back to summary
private final List<ConfigurationResourceProvider> facesletsTagLibConfigProviders A List of resource providers that search for faces-config documents. By default, this contains a provider for the Mojarra, and one other providers to satisfy the requirements of the specification.

initializedContexts	back to summary
private final List<ServletContext> initializedContexts Contains each `ServletContext` that we've initialized. The `ServletContext` will be removed when the application is destroyed.

INJECTION_PROVIDER_KEY	back to summary
public static final String INJECTION_PROVIDER_KEY The initialization time FacesContext scoped key under which the InjectionProvider is stored.

LOGGER	back to summary
private static final Logger LOGGER

NUMBER_OF_TASK_THREADS	back to summary
private static final int NUMBER_OF_TASK_THREADS The `ConfigManager` will multithread the calls to the `ConfigurationResourceProvider`s as well as any calls to parse a resources into a DOM. By default, we'll use only 5 threads per web application.

Constructor Detail

ConfigManager	back to summary
public ConfigManager()

Method Detail

createExecutorService	back to summary
private static ExecutorService createExecutorService() Create a new `ExecutorService` with `NUMBER_OF_TASK_THREADS` threads.

createInstance	back to summary
public static ConfigManager createInstance(ServletContext servletContext)

destroy back to summary

destroy	back to summary
public void destroy(ServletContext servletContext, FacesContext facesContext) This method will remove any information about the application. Parameters servletContext:ServletContext the `ServletContext` for the application that needs to be removed facesContext:FacesContext the `FacesContext` for the application that needs to be removed

public void destroy(ServletContext servletContext, FacesContext facesContext)

This method will remove any information about the application.

Parameters

servletContext:ServletContext: the ServletContext for the application that needs to be removed
facesContext:FacesContext: the FacesContext for the application that needs to be removed

findAnnotations	back to summary
private void findAnnotations(DocumentInfo[] facesDocuments, InjectionProvider containerConnector, ServletContext servletContext, InitFacesContext context, ExecutorService executor) Execute the Task responsible for finding annotation classes

getAnnotatedClasses	back to summary
public static Map<Class<? extends Annotation>, Set<Class<?>>> getAnnotatedClasses(FacesContext ctx) Parameters ctx:FacesContext the involved faces context Returns:Map<Class<? extends Annotation>, Set<Class<?>>> the results of the annotation scan task

getConfigPopulators	back to summary
private List<ApplicationConfigurationPopulator> getConfigPopulators()

getConfigurationResourceProviders	back to summary
private List<ConfigurationResourceProvider> getConfigurationResourceProviders(List<ConfigurationResourceProvider> defaultProviders, ConfigurationResourceProviderFactory.ProviderType providerType)

getFaceletConfigResourceProviders	back to summary
private List<ConfigurationResourceProvider> getFaceletConfigResourceProviders()

getFacesConfigResourceProviders	back to summary
private List<ConfigurationResourceProvider> getFacesConfigResourceProviders()

getInstance	back to summary
public static ConfigManager getInstance(ServletContext servletContext) Parameters servletContext:ServletContext the involved servlet context Returns:ConfigManager a `ConfigManager` instance

getThreadContext	back to summary
private ThreadContext getThreadContext(InjectionProvider containerConnector)

hasBeenInitialized	back to summary
public boolean hasBeenInitialized(ServletContext servletContext) Parameters servletContext:ServletContext the `ServletContext` for the application in question Returns:boolean `true` if this application has already been initialized, otherwise returns `fase`

initialize back to summary

initialize	back to summary
public void initialize(ServletContext servletContext, InitFacesContext facesContext) This method bootstraps Faces based on the parsed configuration resources. Parameters servletContext:ServletContext the `ServletContext` for the application that requires initialization facesContext:InitFacesContext the involved initialization faces context

public void initialize(ServletContext servletContext, InitFacesContext facesContext)

This method bootstraps Faces based on the parsed configuration resources.