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

Initializes Jakarta Faces if at least one of the following conditions is met:

The Set of classes passed to this initializer contains an user-defined Faces type, or
FacesServlet has been explicitly mapped ,or
/WEB-INF/faces-config.xml exists

If it is met, and the FacesServlet has not been explicitly mapped, then add mappings *.xhtml, /faces, *.jsf, and *.faces for the FacesServlet.

Field Summary

Modifier and Type	Field and Description
private static final String	FACES_CONFIG_RESOURCE_PATH
public static final String	FACES_PACKAGE_PREFIX
private static final String	FACES_SERVLET_CLASS_NAME
private static final String[]	FACES_SERVLET_MAPPINGS_WITH_XHTML
private static final String[]	FACES_SERVLET_MAPPINGS_WITHOUT_XHTML
private static final Logger	LOGGER
public static final String	MOJARRA_PACKAGE_PREFIX
public static final String	MOJARRA_TEST_PACKAGE_PREFIX

Constructor Summary

Access	Constructor and Description
public	FacesInitializer()

Method Summary

Modifier and Type	Method and Description
public static void	addAnnotatedClasses(Set<Class<?>> classes, ServletContext servletContext)
private static ServletRegistration	getExistingFacesServletRegistration(ServletContext servletContext)
private static void	handleCdiConcerns(ServletContext context)
private static void	handleMappingConcerns(ServletContext servletContext)
private static void	handleWebSocketConcerns(ServletContext context)
private static boolean	isFacesConfigFilePresent(ServletContext context)
private static boolean	isFacesServletRegistrationPresent(ServletContext context)
public void	onStartup(Set<Class<?>> the Set of application classes that extend, implement, or have been annotated with the class types specified by the `HandlesTypes` annotation, or `null` if there are no matches, or this `ServletContainerInitializer` has not been annotated with `HandlesTypes` classes, ServletContext the `ServletContext` of the web application that is being started and in which the classes contained in `c` were found servletContext) Implements jakarta.servlet.ServletContainerInitializer.onStartup. Notifies this `ServletContainerInitializer` of the startup of the application represented by the given `ServletContext`.

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

Field Detail

FACES_CONFIG_RESOURCE_PATH	back to summary
private static final String FACES_CONFIG_RESOURCE_PATH

FACES_PACKAGE_PREFIX	back to summary
public static final String FACES_PACKAGE_PREFIX

FACES_SERVLET_CLASS_NAME	back to summary
private static final String FACES_SERVLET_CLASS_NAME

FACES_SERVLET_MAPPINGS_WITH_XHTML	back to summary
private static final String[] FACES_SERVLET_MAPPINGS_WITH_XHTML

FACES_SERVLET_MAPPINGS_WITHOUT_XHTML	back to summary
private static final String[] FACES_SERVLET_MAPPINGS_WITHOUT_XHTML

LOGGER	back to summary
private static final Logger LOGGER

MOJARRA_PACKAGE_PREFIX	back to summary
public static final String MOJARRA_PACKAGE_PREFIX

MOJARRA_TEST_PACKAGE_PREFIX	back to summary
public static final String MOJARRA_TEST_PACKAGE_PREFIX

Constructor Detail

FacesInitializer	back to summary
public FacesInitializer()

Method Detail

addAnnotatedClasses	back to summary
public static void addAnnotatedClasses(Set<Class<?>> classes, ServletContext servletContext)

getExistingFacesServletRegistration	back to summary
private static ServletRegistration getExistingFacesServletRegistration(ServletContext servletContext)

handleCdiConcerns	back to summary
private static void handleCdiConcerns(ServletContext context) throws ServletException

handleMappingConcerns	back to summary
private static void handleMappingConcerns(ServletContext servletContext) throws ServletException

handleWebSocketConcerns	back to summary
private static void handleWebSocketConcerns(ServletContext context) throws ServletException

isFacesConfigFilePresent	back to summary
private static boolean isFacesConfigFilePresent(ServletContext context)

isFacesServletRegistrationPresent	back to summary
private static boolean isFacesServletRegistrationPresent(ServletContext context)

onStartup back to summary

onStartup	back to summary
public void onStartup(Set<Class<?>> classes, ServletContext servletContext) throws ServletException Implements jakarta.servlet.ServletContainerInitializer.onStartup. Doc from jakarta.servlet.ServletContainerInitializer.onStartup. Notifies this `ServletContainerInitializer` of the startup of the application represented by the given `ServletContext`. If this `ServletContainerInitializer` is bundled in a JAR file inside the `WEB-INF/lib` directory of an application, its `onStartup` method will be invoked only once during the startup of the bundling application. If this `ServletContainerInitializer` is bundled inside a JAR file outside of any `WEB-INF/lib` directory, but still discoverable as described above, its `onStartup` method will be invoked every time an application is started. Parameters classes:Set<Class<?>> the Set of application classes that extend, implement, or have been annotated with the class types specified by the `HandlesTypes` annotation, or `null` if there are no matches, or this `ServletContainerInitializer` has not been annotated with `HandlesTypes` servletContext:ServletContext the `ServletContext` of the web application that is being started and in which the classes contained in `c` were found Annotations @Override Exceptions ServletException: if an error has occurred

public void onStartup(Set<Class<?>> classes, ServletContext servletContext) throws ServletException

Implements jakarta.servlet.ServletContainerInitializer.onStartup.

Doc from jakarta.servlet.ServletContainerInitializer.onStartup.

Notifies this ServletContainerInitializer of the startup of the application represented by the given ServletContext.

If this ServletContainerInitializer is bundled in a JAR file inside the WEB-INF/lib directory of an application, its onStartup method will be invoked only once during the startup of the bundling application. If this ServletContainerInitializer is bundled inside a JAR file outside of any WEB-INF/lib directory, but still discoverable as described above, its onStartup method will be invoked every time an application is started.

Parameters

classes:Set<Class<?>>: the Set of application classes that extend, implement, or have been annotated with the class types specified by the HandlesTypes annotation, or null if there are no matches, or this ServletContainerInitializer has not been annotated with HandlesTypes
servletContext:ServletContext: the ServletContext of the web application that is being started and in which the classes contained in c were found

Annotations

@Override

Exceptions

ServletException:: if an error has occurred