Nested and Inner Type Summary

Modifier and Type	Class and Description
private class	ConfigureListener.WebConfigResourceMonitor
private static class	ConfigureListener.WebXmlProcessor Processes a web application's deployment descriptor looking for a reference to `jakarta.faces.webapp.FacesServlet`.

Field Summary

Modifier and Type	Field and Description
private static final Logger	LOGGER
protected WebappLifecycleListener	webAppListener
protected WebConfiguration	webConfig
private ScheduledThreadPoolExecutor	webResourcePool

Access	Constructor and Description
public	ConfigureListener()

Method Summary

Modifier and Type	Method and Description
public void	contextDestroyed(ServletContextEvent the ServletContextEvent containing the ServletContext that is being destroyed sce) Overrides default jakarta.servlet.ServletContextListener.contextDestroyed. Receives notification that the ServletContext is about to be shut down.
public void	contextInitialized(ServletContextEvent the ServletContextEvent containing the ServletContext that is being initialized servletContextEvent) Overrides default jakarta.servlet.ServletContextListener.contextInitialized. Receives notification that the web application initialization process is starting.
private InitFacesContext	getInitFacesContext(ServletContext context)
private void	initConfigMonitoring(ServletContext context)
private boolean	isDevModeEnabled()
private void	reload(ServletContext servletContext) This method will be invoked `WebConfigResourceMonitor` when changes to any of the faces-config.xml files included in WEB-INF are modified.
public void	requestDestroyed(ServletRequestEvent the ServletRequestEvent containing the ServletRequest and the ServletContext representing the web application event) Overrides default jakarta.servlet.ServletRequestListener.requestDestroyed. Receives notification that a ServletRequest is about to go out of scope of the web application.
public void	requestInitialized(ServletRequestEvent the ServletRequestEvent containing the ServletRequest and the ServletContext representing the web application event) Overrides default jakarta.servlet.ServletRequestListener.requestInitialized. Receives notification that a ServletRequest is about to come into scope of the web application.
public void	sessionCreated(HttpSessionEvent the HttpSessionEvent containing the session event) Overrides default jakarta.servlet.http.HttpSessionListener.sessionCreated. Receives notification that a session has been created.
public void	sessionDestroyed(HttpSessionEvent the HttpSessionEvent containing the session event) Overrides default jakarta.servlet.http.HttpSessionListener.sessionDestroyed. Receives notification that a session is about to be invalidated.
private boolean	shouldInitConfigMonitoring()

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

Field Detail

LOGGER	back to summary
private static final Logger LOGGER

webAppListener	back to summary
protected WebappLifecycleListener webAppListener

webConfig	back to summary
protected WebConfiguration webConfig

webResourcePool	back to summary
private ScheduledThreadPoolExecutor webResourcePool

ConfigureListener	back to summary
public ConfigureListener()

Method Detail

contextDestroyed	back to summary
public void contextDestroyed(ServletContextEvent sce) Overrides default jakarta.servlet.ServletContextListener.contextDestroyed. Doc from jakarta.servlet.ServletContextListener.contextDestroyed. Receives notification that the ServletContext is about to be shut down. All servlets and filters will have been destroyed before any ServletContextListeners are notified of context destruction. Parameters sce:ServletContextEvent the ServletContextEvent containing the ServletContext that is being destroyed Annotations @Override

contextDestroyed

back to summary

public void contextDestroyed(ServletContextEvent sce)

Overrides default jakarta.servlet.ServletContextListener.contextDestroyed.

Doc from jakarta.servlet.ServletContextListener.contextDestroyed.

Receives notification that the ServletContext is about to be shut down.

All servlets and filters will have been destroyed before any ServletContextListeners are notified of context destruction.

Parameters

sce:ServletContextEvent: the ServletContextEvent containing the ServletContext that is being destroyed

Annotations

@Override

contextInitialized	back to summary
public void contextInitialized(ServletContextEvent servletContextEvent) Overrides default jakarta.servlet.ServletContextListener.contextInitialized. Doc from jakarta.servlet.ServletContextListener.contextInitialized. Receives notification that the web application initialization process is starting. All ServletContextListeners are notified of context initialization before any filters or servlets in the web application are initialized. Parameters servletContextEvent:ServletContextEvent the ServletContextEvent containing the ServletContext that is being initialized Annotations @Override

contextInitialized

back to summary

public void contextInitialized(ServletContextEvent servletContextEvent)

Overrides default jakarta.servlet.ServletContextListener.contextInitialized.

Doc from jakarta.servlet.ServletContextListener.contextInitialized.

Receives notification that the web application initialization process is starting.

All ServletContextListeners are notified of context initialization before any filters or servlets in the web application are initialized.

Parameters

servletContextEvent:ServletContextEvent: the ServletContextEvent containing the ServletContext that is being initialized

Annotations

@Override

getInitFacesContext	back to summary
private InitFacesContext getInitFacesContext(ServletContext context)

initConfigMonitoring	back to summary
private void initConfigMonitoring(ServletContext context)

isDevModeEnabled	back to summary
private boolean isDevModeEnabled()

reload	back to summary
private void reload(ServletContext servletContext) This method will be invoked `WebConfigResourceMonitor` when changes to any of the faces-config.xml files included in WEB-INF are modified.

requestDestroyed	back to summary
public void requestDestroyed(ServletRequestEvent event) Overrides default jakarta.servlet.ServletRequestListener.requestDestroyed. Doc from jakarta.servlet.ServletRequestListener.requestDestroyed. Receives notification that a ServletRequest is about to go out of scope of the web application. Parameters event:ServletRequestEvent the ServletRequestEvent containing the ServletRequest and the ServletContext representing the web application Annotations @Override

requestDestroyed

back to summary

public void requestDestroyed(ServletRequestEvent event)

Overrides default jakarta.servlet.ServletRequestListener.requestDestroyed.

Doc from jakarta.servlet.ServletRequestListener.requestDestroyed.

Receives notification that a ServletRequest is about to go out of scope of the web application.

Parameters

event:ServletRequestEvent: the ServletRequestEvent containing the ServletRequest and the ServletContext representing the web application

Annotations

@Override

requestInitialized	back to summary
public void requestInitialized(ServletRequestEvent event) Overrides default jakarta.servlet.ServletRequestListener.requestInitialized. Doc from jakarta.servlet.ServletRequestListener.requestInitialized. Receives notification that a ServletRequest is about to come into scope of the web application. Parameters event:ServletRequestEvent the ServletRequestEvent containing the ServletRequest and the ServletContext representing the web application Annotations @Override

requestInitialized

back to summary

public void requestInitialized(ServletRequestEvent event)

Overrides default jakarta.servlet.ServletRequestListener.requestInitialized.

Doc from jakarta.servlet.ServletRequestListener.requestInitialized.

Receives notification that a ServletRequest is about to come into scope of the web application.

Parameters

event:ServletRequestEvent: the ServletRequestEvent containing the ServletRequest and the ServletContext representing the web application

Annotations

@Override

sessionCreated	back to summary
public void sessionCreated(HttpSessionEvent event) Overrides default jakarta.servlet.http.HttpSessionListener.sessionCreated. Doc from jakarta.servlet.http.HttpSessionListener.sessionCreated. Receives notification that a session has been created. Parameters event:HttpSessionEvent the HttpSessionEvent containing the session Annotations @Override

sessionCreated

back to summary

public void sessionCreated(HttpSessionEvent event)

Overrides default jakarta.servlet.http.HttpSessionListener.sessionCreated.

Doc from jakarta.servlet.http.HttpSessionListener.sessionCreated.

Receives notification that a session has been created.

Parameters

event:HttpSessionEvent: the HttpSessionEvent containing the session

Annotations

@Override

sessionDestroyed	back to summary
public void sessionDestroyed(HttpSessionEvent event) Overrides default jakarta.servlet.http.HttpSessionListener.sessionDestroyed. Doc from jakarta.servlet.http.HttpSessionListener.sessionDestroyed. Receives notification that a session is about to be invalidated. Parameters event:HttpSessionEvent the HttpSessionEvent containing the session Annotations @Override

sessionDestroyed

back to summary

public void sessionDestroyed(HttpSessionEvent event)

Overrides default jakarta.servlet.http.HttpSessionListener.sessionDestroyed.

Doc from jakarta.servlet.http.HttpSessionListener.sessionDestroyed.

Receives notification that a session is about to be invalidated.

Parameters

event:HttpSessionEvent: the HttpSessionEvent containing the session

Annotations

@Override

shouldInitConfigMonitoring	back to summary
private boolean shouldInitConfigMonitoring()

com.sun.faces.config back to summary

private Class ConfigureListener.WebConfigResourceMonitor

Class Inheritance

extends Object
implements Runnable

java.lang.Object
com.sun.faces.config.ConfigureListener.WebConfigResourceMonitor

All Implemented Interfaces

java.lang.Runnable

Nested and Inner Type Summary

Modifier and Type	Class and Description
private class	ConfigureListener.WebConfigResourceMonitor.Monitor

Field Summary

Modifier and Type	Field and Description
private List<ConfigureListener.WebConfigResourceMonitor.Monitor>	monitors
private final ServletContext	servletContext

Constructor Summary

Access	Constructor and Description
public	WebConfigResourceMonitor(ServletContext servletContext, Collection<URI> uris)

Method Summary

Modifier and Type	Method and Description
public void	run() Implements java.lang.Runnable.run. PENDING javadocs

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

Field Detail

monitors	back to summary
private List<ConfigureListener.WebConfigResourceMonitor.Monitor> monitors

servletContext	back to summary
private final ServletContext servletContext

Constructor Detail

WebConfigResourceMonitor	back to summary
public WebConfigResourceMonitor(ServletContext servletContext, Collection<URI> uris)

Method Detail

run	back to summary
public void run() Implements java.lang.Runnable.run. PENDING javadocs Annotations @Override

run

back to summary

public void run()

Implements java.lang.Runnable.run.

PENDING javadocs

Annotations

@Override

com.sun.faces.config back to summary

private Class ConfigureListener.WebConfigResourceMonitor.Monitor

Class Inheritance

extends Object

java.lang.Object
com.sun.faces.config.ConfigureListener.WebConfigResourceMonitor.Monitor

Field Summary

Modifier and Type	Field and Description
private long	timestamp
private final URI	uri

Constructor Summary

Access	Constructor and Description
pack-priv	Monitor(URI uri)

Method Summary

Modifier and Type	Method and Description
private long	getLastModified()
pack-priv boolean	hasBeenModified()

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

Field Detail

timestamp	back to summary
private long timestamp

uri	back to summary
private final URI uri

Constructor Detail

Monitor	back to summary
pack-priv Monitor(URI uri) throws IOException

Method Detail

getLastModified	back to summary
private long getLastModified() throws IOException

hasBeenModified	back to summary
pack-priv boolean hasBeenModified() throws IOException

com.sun.faces.config back to summary

private Class ConfigureListener.WebXmlProcessor

Class Inheritance

extends Object

java.lang.Object
com.sun.faces.config.ConfigureListener.WebXmlProcessor

Processes a web application's deployment descriptor looking for a reference to jakarta.faces.webapp.FacesServlet.

Nested and Inner Type Summary

Modifier and Type	Class and Description
private class	ConfigureListener.WebXmlProcessor.WebXmlHandler A simple SAX handler to process the elements of interested within a web application's deployment descriptor.

Field Summary

Modifier and Type	Field and Description
private boolean	distributablePresent
private boolean	errorPagePresent
private boolean	facesServletPresent
private static final String	WEB_FRAGMENT_PATH
private static final String	WEB_XML_PATH

Constructor Summary

Access	Constructor and Description
pack-priv	WebXmlProcessor(ServletContext the `ServletContext` for the application of interest context) When instantiated, the web.xml of the current application will be scanned looking for a references to the `FacesServlet`.

Method Summary

Modifier and Type	Method and Description
private SAXParserFactory	Returns: configured `SAXParserFactory` getConfiguredFactory() Return a `SAXParserFactory` instance that is non-validating and is namespace aware.
public boolean	isDistributablePresent()
pack-priv boolean	Returns: `true` if `WEB-INF/web.xml` contains a `<error-page>` element. isErrorPagePresent()
pack-priv boolean	Returns: `true` if the `WebXmlProcessor` detected a `FacesServlet` entry, otherwise return `false`. isFacesServletPresent()
private void	scanForFacesServlet(ServletContext the ServletContext instance for this application context) Parse the web.xml for the current application and scan for a FacesServlet entry, if found, set the `facesServletPresent` property to true.
private void	warnProcessingError(Exception e, ServletContext servletContext)

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

Field Detail

distributablePresent	back to summary
private boolean distributablePresent

errorPagePresent	back to summary
private boolean errorPagePresent

facesServletPresent	back to summary
private boolean facesServletPresent

WEB_FRAGMENT_PATH	back to summary
private static final String WEB_FRAGMENT_PATH

WEB_XML_PATH	back to summary
private static final String WEB_XML_PATH

Constructor Detail

WebXmlProcessor back to summary

WebXmlProcessor	back to summary
pack-priv WebXmlProcessor(ServletContext context) When instantiated, the web.xml of the current application will be scanned looking for a references to the `FacesServlet`. `isFacesServletPresent()` will return the appropriate value based on the scan. Parameters context:ServletContext the `ServletContext` for the application of interest

pack-priv WebXmlProcessor(ServletContext context)

When instantiated, the web.xml of the current application will be scanned looking for a references to the FacesServlet. isFacesServletPresent() will return the appropriate value based on the scan.

Parameters

context:ServletContext: the ServletContext for the application of interest

Method Detail

getConfiguredFactory back to summary

getConfiguredFactory	back to summary
private SAXParserFactory getConfiguredFactory() Return a `SAXParserFactory` instance that is non-validating and is namespace aware. Returns:SAXParserFactory configured `SAXParserFactory`

private SAXParserFactory getConfiguredFactory()

Return a SAXParserFactory instance that is non-validating and is namespace aware.

Returns:SAXParserFactory: configured SAXParserFactory

isDistributablePresent	back to summary
public boolean isDistributablePresent()

isErrorPagePresent	back to summary
pack-priv boolean isErrorPagePresent() Returns:boolean `true` if `WEB-INF/web.xml` contains a `<error-page>` element.

isFacesServletPresent	back to summary
pack-priv boolean isFacesServletPresent() Returns:boolean `true` if the `WebXmlProcessor` detected a `FacesServlet` entry, otherwise return `false`.

scanForFacesServlet back to summary

private void scanForFacesServlet(ServletContext context)

Parse the web.xml for the current application and scan for a FacesServlet entry, if found, set the facesServletPresent property to true.

Parameters

context:ServletContext: the ServletContext instance for this application

warnProcessingError	back to summary
private void warnProcessingError(Exception e, ServletContext servletContext)

com.sun.faces.config back to summary

private Class ConfigureListener.WebXmlProcessor.WebXmlHandler

Class Inheritance

extends DefaultHandler

java.lang.Object
org.xml.sax.helpers.DefaultHandler
com.sun.faces.config.ConfigureListener.WebXmlProcessor.WebXmlHandler

A simple SAX handler to process the elements of interested within a web application's deployment descriptor.

Field Summary

Modifier and Type	Field and Description
private StringBuffer	content
private static final String	ERROR_PAGE
private static final String	FACES_SERVLET
private static final String	SERVLET_CLASS
private boolean	servletClassFound

Constructor Summary

Access	Constructor and Description
private	WebXmlHandler()

Method Summary

Modifier and Type	Method and Description
public void	characters(char[] The characters. ch, int The start position in the character array. start, int The number of characters to use from the character array. length) Overrides org.xml.sax.helpers.DefaultHandler.characters. Implements org.xml.sax.ContentHandler.characters. Receive notification of character data inside an element.
public void	endElement(String The Namespace URI, or the empty string if the element has no Namespace URI or if Namespace processing is not being performed. uri, String The local name (without prefix), or the empty string if Namespace processing is not being performed. localName, String The qualified name (with prefix), or the empty string if qualified names are not available. qName) Overrides org.xml.sax.helpers.DefaultHandler.endElement. Implements org.xml.sax.ContentHandler.endElement. Receive notification of the end of an element.
public InputSource	resolveEntity(String The public identifier, or null if none is available. publicId, String The system identifier provided in the XML document. systemId) Overrides org.xml.sax.helpers.DefaultHandler.resolveEntity. Implements org.xml.sax.EntityResolver.resolveEntity. Resolve an external entity.
public void	startElement(String The Namespace URI, or the empty string if the element has no Namespace URI or if Namespace processing is not being performed. uri, String The local name (without prefix), or the empty string if Namespace processing is not being performed. localName, String The qualified name (with prefix), or the empty string if qualified names are not available. qName, Attributes The attributes attached to the element. If there are no attributes, it shall be an empty Attributes object. attributes) Overrides org.xml.sax.helpers.DefaultHandler.startElement. Implements org.xml.sax.ContentHandler.startElement. Receive notification of the start of an element.

Inherited from org.xml.sax.helpers.DefaultHandler:: endDocument endPrefixMapping error fatalError ignorableWhitespace notationDecl processingInstruction setDocumentLocator skippedEntity startDocument startPrefixMapping unparsedEntityDecl warning

Field Detail

content	back to summary
private StringBuffer content

ERROR_PAGE	back to summary
private static final String ERROR_PAGE

FACES_SERVLET	back to summary
private static final String FACES_SERVLET

SERVLET_CLASS	back to summary
private static final String SERVLET_CLASS

servletClassFound	back to summary
private boolean servletClassFound

Constructor Detail

WebXmlHandler	back to summary
private WebXmlHandler()

Method Detail

characters

back to summary

public void characters(char[] ch, int start, int length) throws SAXException

Overrides org.xml.sax.helpers.DefaultHandler.characters.

Implements org.xml.sax.ContentHandler.characters.

Doc from org.xml.sax.helpers.DefaultHandler.characters.

Receive notification of character data inside an element.

By default, do nothing. Application writers may override this method to take specific actions for each chunk of character data (such as adding the data to a node or buffer, or printing it to a file).

Parameters

ch:char[]: The characters.
start:int: The start position in the character array.
length:int: The number of characters to use from the character array.

Annotations

@Override

Exceptions

SAXException:: Any SAX exception, possibly wrapping another exception.

endElement

back to summary

public void endElement(String uri, String localName, String qName) throws SAXException

Overrides org.xml.sax.helpers.DefaultHandler.endElement.

Implements org.xml.sax.ContentHandler.endElement.

Doc from org.xml.sax.helpers.DefaultHandler.endElement.

Receive notification of the end of an element.

By default, do nothing. Application writers may override this method in a subclass to take specific actions at the end of each element (such as finalising a tree node or writing output to a file).

Parameters

uri:String: The Namespace URI, or the empty string if the element has no Namespace URI or if Namespace processing is not being performed.
localName:String: The local name (without prefix), or the empty string if Namespace processing is not being performed.
qName:String: The qualified name (with prefix), or the empty string if qualified names are not available.

Annotations

@Override

Exceptions

SAXException:: Any SAX exception, possibly wrapping another exception.

resolveEntity

back to summary

public InputSource resolveEntity(String publicId, String systemId) throws SAXException

Overrides org.xml.sax.helpers.DefaultHandler.resolveEntity.

Implements org.xml.sax.EntityResolver.resolveEntity.

Doc from org.xml.sax.helpers.DefaultHandler.resolveEntity.

Resolve an external entity.

Always return null, so that the parser will use the system identifier provided in the XML document. This method implements the SAX default behaviour: application writers can override it in a subclass to do special translations such as catalog lookups or URI redirection.

Parameters

publicId:String: The public identifier, or null if none is available.
systemId:String: The system identifier provided in the XML document.

Returns:InputSource

The new input source, or null to require the default behaviour.

Annotations

@Override

Exceptions

SAXException:: Any SAX exception, possibly wrapping another exception.

startElement

back to summary

public void startElement(String uri, String localName, String qName, Attributes attributes) throws SAXException

Overrides org.xml.sax.helpers.DefaultHandler.startElement.

Implements org.xml.sax.ContentHandler.startElement.

Doc from org.xml.sax.helpers.DefaultHandler.startElement.

Receive notification of the start of an element.

By default, do nothing. Application writers may override this method in a subclass to take specific actions at the start of each element (such as allocating a new tree node or writing output to a file).

Parameters

uri:String: The Namespace URI, or the empty string if the element has no Namespace URI or if Namespace processing is not being performed.
localName:String: The local name (without prefix), or the empty string if Namespace processing is not being performed.
qName:String: The qualified name (with prefix), or the empty string if qualified names are not available.
attributes:Attributes: The attributes attached to the element. If there are no attributes, it shall be an empty Attributes object.

Annotations

@Override

Exceptions

SAXException:: Any SAX exception, possibly wrapping another exception.

public Class ConfigureListener

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class ConfigureListener.WebConfigResourceMonitor

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class ConfigureListener.WebConfigResourceMonitor.Monitor

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class ConfigureListener.WebXmlProcessor

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class ConfigureListener.WebXmlProcessor.WebXmlHandler

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail