Module jakarta.faces

Package com.sun.faces.config

Class FacesInitializer

java.lang.Object

com.sun.faces.config.FacesInitializer

All Implemented Interfaces:

ServletContainerInitializer

public class FacesInitializer
extends Object
implements ServletContainerInitializer

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

Fields

Modifier and Type	Field	Description
static final String	FACES_PACKAGE_PREFIX
static final String	MOJARRA_PACKAGE_PREFIX
static final String	MOJARRA_TEST_PACKAGE_PREFIX

Constructor Summary

Constructors

Constructor	Description
FacesInitializer()

Method Summary

Modifier and Type	Method	Description
static void	addAnnotatedClasses(Set<Class<?>> classes, ServletContext servletContext)
void	onStartup(Set<Class<?>> classes, ServletContext servletContext)	Notifies this ServletContainerInitializer of the startup of the application represented by the given ServletContext.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

FACES_PACKAGE_PREFIX

public static final String FACES_PACKAGE_PREFIX

See Also:

• Constant Field Values

MOJARRA_PACKAGE_PREFIX

public static final String MOJARRA_PACKAGE_PREFIX

See Also:

• Constant Field Values

MOJARRA_TEST_PACKAGE_PREFIX

public static final String MOJARRA_TEST_PACKAGE_PREFIX

See Also:

• Constant Field Values

Constructor Details

FacesInitializer

public FacesInitializer()

Method Details

onStartup

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

Description copied from interface: ServletContainerInitializer

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.

Specified by:

onStartup in interface ServletContainerInitializer

Parameters:

classes - 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 - the ServletContext of the web application that is being started and in which the classes contained in c were found

Throws:

ServletException - if an error has occurred

addAnnotatedClasses

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