com.sun.enterprise.web
Class WebModule

java.lang.Object
  org.apache.catalina.core.ContainerBase
      org.apache.catalina.core.StandardContext
          com.sun.enterprise.web.pwc.PwcWebModule
              com.sun.enterprise.web.WebModule

All Implemented Interfaces:

java.io.Serializable, javax.management.MBeanRegistration, javax.servlet.ServletContext, Container, Context, Lifecycle, Pipeline

Direct Known Subclasses:

AdHocWebModule, ContextFacade

public class WebModule
extends PwcWebModule
implements Context

Class representing a web module for use by the Application Server.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.catalina.core.StandardContext

StandardContext.RestrictedServletContextListener

Nested classes/interfaces inherited from class org.apache.catalina.core.ContainerBase

ContainerBase.ContainerBackgroundProcessor, ContainerBase.PrivilegedAddChild

Field Summary

protected java.lang.Object[]	cachedFinds Cached findXXX results
protected static java.util.ResourceBundle	rb

Fields inherited from class com.sun.enterprise.web.pwc.PwcWebModule

_id, defaultCharset, formHintField, webSessionCookieConfig

Fields inherited from class org.apache.catalina.core.StandardContext

allowLinking, cacheMaxSize, cacheTTL, caseSensitive, caseSensitiveMapping, context, contextListeners, directoryListing, filterRegisMap, isJsfApplication, servletRegisMap, urlEncoder

Fields inherited from class org.apache.catalina.core.ContainerBase

backgroundProcessorDelay, checkIfRequestIsSecure, children, controller, debug, domain, hasCustomPipeline, initialized, lifecycle, listeners, loader, manager, mserver, name, notifyContainerListeners, oname, parent, parentClassLoader, pipeline, readLock, realm, resources, sm, started, suffix, support, type, writeLock

Fields inherited from interface javax.servlet.ServletContext

ORDERED_LIBS, TEMPDIR

Fields inherited from interface org.apache.catalina.Context

RELOAD_EVENT

Fields inherited from interface org.apache.catalina.Container

ADD_CHILD_EVENT, ADD_MAPPER_EVENT, ADD_VALVE_EVENT, REMOVE_CHILD_EVENT, REMOVE_MAPPER_EVENT, REMOVE_VALVE_EVENT

Fields inherited from interface org.apache.catalina.Lifecycle

AFTER_START_EVENT, AFTER_STOP_EVENT, BEFORE_START_EVENT, BEFORE_STOP_EVENT, INIT_EVENT, START_EVENT, STOP_EVENT

Constructor Summary

WebModule()
Constructor.

WebModule(org.jvnet.hk2.component.Habitat habitat)

Method Summary

void	addAdHocValve(GlassFishValve valve) Adds the given valve to this web module's ad-hoc pipeline.
protected void	addCatalinaListener(java.lang.String listenerName) Adds the Catalina listener with the given class name to this WebModule.
protected void	addValve(java.lang.String className) Instantiates a Valve from the given className and adds it to the Pipeline of this WebModule.
protected void	addValve(Valve valveDescriptor) Constructs a Valve from the given valveDescriptor and adds it to the Pipeline of this WebModule.
void	afterServiceEvent(java.lang.String servletName, int status)
void	beforeServiceEvent(java.lang.String servletName)
protected void	callServletContainerInitializers()
protected void	configureCatalinaProperties() Configure the WebModule
protected void	configureCatalinaProperties(java.lang.String propName, java.lang.String propValue) Configure the WebModule
protected void	configureSessionSettings(WebBundleDescriptor wbd, WebModuleConfig wmInfo) Create and configure the session manager for this web application according to the persistence type specified.
protected void	configureValves() Configure the WebModule valves.
protected void	contextListenerStart()
protected ServletRegistrationImpl	createDynamicServletRegistrationImpl(StandardWrapper wrapper)
protected <T extends javax.servlet.Filter> T	createFilterInstance(java.lang.Class<T> clazz) Instantiates the given Filter class.
<T extends java.util.EventListener> T	createListenerInstance(java.lang.Class<T> clazz) Instantiates the given EventListener class.
java.io.ObjectInputStream	createObjectInputStream(java.io.InputStream is) Creates an ObjectInputStream that provides special deserialization logic for classes that are normally not serializable (such as javax.naming.Context).
java.io.ObjectOutputStream	createObjectOutputStream(java.io.OutputStream os) Creates an ObjectOutputStream that provides special serialization logic for classes that are normally not serializable (such as javax.naming.Context).
protected <T extends javax.servlet.Servlet> T	createServletInstance(java.lang.Class<T> clazz) Instantiates the given Servlet class.
protected ServletRegistrationImpl	createServletRegistrationImpl(StandardWrapper wrapper)
Pipeline	getAdHocPipeline() Gets this web module's ad-hoc pipeline.
java.lang.String	getAdHocServletName(java.lang.String path) Returns the name of the ad-hoc servlet responsible for servicing the given path.
Application	getBean()
java.lang.Object[]	getCachedFindOperation() Return the cached result of doing findXX on this object NOTE: this method MUST be used only when loading/using the content of default-web.xml
java.lang.String	getComponentId() Gets ComponentId for Invocation.
java.lang.String	getFileEncoding() Gets the file encoding of all static resources of this web module.
SunWebApp	getIasWebAppConfigBean() gets the sun-web.xml config bean
LocaleCharsetMap[]	getLocaleCharsetMap() return locale-charset-map
java.lang.String	getMonitoringNodeName()
SecurityConfig	getSecurityConfig()
ServerContext	getServerContext() Gets ServerContext.
protected org.glassfish.hk2.classmodel.reflect.Types	getTypes()
WebBundleDescriptor	getWebBundleDescriptor() Gets the WebBundleDesciptor (web.xml) for this WebModule.
WebContainer	getWebContainer() Gets the web container in which this web module was loaded.
WebModuleConfig	getWebModuleConfig()
boolean	hasAdHocPaths() Indicates whether this web module contains any ad-hoc paths.
boolean	hasAdHocSubtrees() Indicates whether this web module contains any ad-hoc subtrees.
boolean	hasBeenXmlConfigured() Return true if the default=web.xml has been read for this module.
boolean	hasLocaleToCharsetMapping() Returns true if this web module specifies a locale-charset-map in its sun-web.xml, false otherwise.
protected java.util.EventListener	loadListener(java.lang.ClassLoader loader, java.lang.String listenerClassName) Loads and instantiates the listener with the specified classname.
java.lang.String	mapLocalesToCharset(java.util.Enumeration locales) Matches the given request locales against the charsets specified in the locale-charset-map of this web module's sun-web.xml, and returns the first matching charset.
void	removeAdHocValve(GlassFishValve valve) Removes the given valve from this web module's ad-hoc pipeline.
protected void	removePatternFromServlet(Wrapper wrapper, java.lang.String pattern)
void	servletDestroyedEvent(java.lang.String servletName)
void	servletInitializedEvent(java.lang.String servletName)
void	sessionActivatedEndEvent(javax.servlet.http.HttpSession session)
void	sessionActivatedStartEvent(javax.servlet.http.HttpSession session)
void	sessionCreatedEvent(javax.servlet.http.HttpSession session)
void	sessionDestroyedEvent(javax.servlet.http.HttpSession session)
void	sessionExpiredEvent(javax.servlet.http.HttpSession session)
void	sessionPassivatedEndEvent(javax.servlet.http.HttpSession session)
void	sessionPassivatedStartEvent(javax.servlet.http.HttpSession session)
void	sessionPersistedEndEvent(javax.servlet.http.HttpSession session)
void	sessionPersistedStartEvent(javax.servlet.http.HttpSession session)
void	sessionRejectedEvent(int maxSessions)
void	setBean(Application bean)
void	setCachedFindOperation(java.lang.Object[] cachedFinds) Cache the result of doing findXX on this object NOTE: this method MUST be used only when loading/using the content of default-web.xml
void	setFileEncoding(java.lang.String enc) Sets the file encoding of all static resources of this web module.
void	setI18nInfo() Sets the parameter encoding (i18n) info from sun-web.xml.
void	setIasWebAppConfigBean(SunWebApp iasBean) set the sun-web.xml config bean
void	setParent(Container container) Sets the virtual server parent of this web module, and passes it on to this web module's realm adapter..
void	setRealm(Realm realm)
void	setSecurityConfig(SecurityConfig config)
void	setWebContainer(WebContainer webContainer) Sets the web container in which this web module was loaded.
void	setWebModuleConfig(WebModuleConfig wmInfo)
void	setXmlConfigured(boolean hasBeenXmlConfigured) Set to true when the default-web.xml has been read for this module.
void	start() Starts this web module.
void	stop() Stops this web module.
void	webModuleStartedEvent()
void	webModuleStoppedEvent()

Methods inherited from class com.sun.enterprise.web.pwc.PwcWebModule

createWrapper, getCacheControls, getContextRoot, getDefaultCharset, getEncodeCookies, getEndpointAddresses, getFormHintField, getHasWebServices, getID, getModuleName, getResponseCTForHeaders, getSessionCookieConfig, getSessionCookieConfigFromSunWebXml, getSTMPoolSize, hasWebXml, setCacheControls, setContextRoot, setEncodeCookies, setEndpointAddresses, setHasWebServices, setHasWebXml, setID, setModuleName, setResponseCTForHeaders, setSessionCookieConfigFromSunWebXml, setSTMPoolSize

Methods inherited from class org.apache.catalina.core.StandardContext

addAlternateDocBase, addApplicationListener, addApplicationParameter, addChild, addChild, addConstraint, addEjb, addEnvironment, addEnvironment, addErrorPage, addFilter, addFilter, addFilter, addFilterDef, addFilterDef, addFilterMap, addFilterMap, addFilterMaps, addInstanceListener, addInstanceListener, addJspMapping, addListener, addListener, addListener, addLocaleEncodingMappingParameter, addLocalEjb, addMessageDestination, addMessageDestinationRef, addMimeMapping, addParameter, addResource, addResource, addResourceEnvRef, addResourceLink, addResourceLink, addResourceParams, addRoleMapping, addSecurityRole, addServlet, addServlet, addServlet, addServlet, addServlet, addServletMapping, addServletMapping, addServletMapping, addServletMapping, addWatchedResource, addWelcomeFile, addWrapperLifecycle, addWrapperListener, adjustURLPattern, alternateResourcesStart, alternateResourcesStop, backgroundProcess, create, createFilter, createListener, createLoader, createObjectName, createServlet, declareRoles, destroy, engineBase, filterStart, filterStop, findApplicationParameters, findEjb, findEjbs, findEnvironment, findEnvironments, findErrorPage, findErrorPage, findFilterConfig, findFilterDef, findFilterDefs, findFilterMaps, findInstanceListeners, findLocalEjb, findLocalEjbs, findMappingObject, findMessageDestination, findMessageDestinationRef, findMessageDestinationRefs, findMessageDestinations, findMimeMapping, findMimeMappings, findParameter, findParameters, findResource, findResourceEnvRef, findResourceEnvRefs, findResourceLink, findResourceLinks, findResources, findRoleMapping, findServletMapping, findServletMappings, findStaticResources, findStatusPage, findStatusPages, findWelcomeFile, findWelcomeFiles, findWrapperLifecycles, findWrapperListeners, fireRequestDestroyedEvent, fireRequestInitializedEvent, getAllowRelativeRedirect, getAltDDName, getAlternateDocBases, getApplicationEventListeners, getAttribute, getAttributeNames, getAuditors, getAuthenticator, getAvailable, getCacheMaxSize, getCacheTTL, getCharsetMapper, getCharsetMapperClass, getClassLoader, getCompilerClasspath, getConfigFile, getConfigured, getConstraints, getContext, getContextPath, getCookies, getCrossContext, getDefaultConfigFile, getDefaultErrorPage, getDefaultSessionTrackingModes, getDefaultWebXml, getDelegate, getDisplayName, getDistributable, getDocBase, getEffectiveMajorVersion, getEffectiveMinorVersion, getEffectiveSessionTrackingModes, getEncodedPath, getEngineName, getEnvironments, getFilterRegistration, getFilterRegistrations, getHostname, getInfo, getInitParameter, getInitParameterNames, getJ2EEApplication, getJ2EEServer, getJspConfigDescriptor, getJvmRoute, getLoginConfig, getMajorVersion, getManagerChecksFrequency, getMapper, getMimeType, getMinorVersion, getNamedDispatcher, getNamingContextName, getNamingResources, getOriginalDocBase, getOverride, getParentName, getPath, getPaused, getPrivileged, getPublicId, getRealPath, getReloadable, getRequestDispatcher, getResource, getResourceAsStream, getResourceLinks, getResourceNames, getResourcePaths, getReuseSessionID, getServerInfo, getServlet, getServletContext, getServletContextName, getServletNameFilterMappings, getServletNames, getServletRegistration, getServletRegistrations, getServlets, getSessionCookieName, getSessionListeners, getSessionParameterName, getSessionTimeout, getStartTimeMillis, getStartupTime, getState, getStaticResources, getTldNamespaceAware, getTldScanTime, getTldValidation, getUnpackWAR, getUrlPatternFilterMappings, getWatchedResources, getWelcomeFiles, getWorkDir, getWorkPath, getXmlNamespaceAware, getXmlValidation, hasConstraints, hasFilter, hasSecurityRole, hasServlet, hasWatchedResources, init, isAllowLinking, isCachingAllowed, isCaseSensitive, isCaseSensitiveMapping, isDirectoryListing, isEmbedded, isEnableURLRewriting, isEventProvider, isFilesystemBased, isJsfApplication, isReload, isReplaceWelcomeFiles, isSecurePagesWithPragma, isServlet22, isSessionTimeoutOveridden, isStatisticsProvider, isUseMyFaces, isUseNaming, loadOnStartup, log, log, log, managerStart, managerStop, preDeregister, preRegister, reload, removeApplicationParameter, removeAttribute, removeChild, removeConstraints, removeEjb, removeEnvironment, removeErrorPages, removeFilterDef, removeFilterMaps, removeInstanceListener, removeLocalEjb, removeMessageDestination, removeMessageDestinationRef, removeMimeMapping, removeParameter, removeResource, removeResourceEnvRef, removeResourceLink, removeRoleMapping, removeSecurityRoles, removeServletMapping, removeWatchedResources, removeWelcomeFiles, removeWrapperLifecycles, removeWrapperListeners, resourcesStart, resourcesStop, restrictedSetPipeline, setAllowLinking, setAllowRelativeRedirect, setAltDDName, setAttribute, setAuditors, setAvailable, setCacheMaxSize, setCacheTTL, setCachingAllowed, setCaseSensitive, setCaseSensitiveMapping, setCharsetMapper, setCharsetMapperClass, setCompilerClasspath, setConfigFile, setConfigured, setCookies, setCrossContext, setDefaultWebXml, setDelegate, setDirectoryListing, setDisplayName, setDistributable, setDocBase, setEffectiveMajorVersion, setEffectiveMinorVersion, setEmbedded, setEnableURLRewriting, setEngineName, setInitParameter, setJ2EEApplication, setJ2EEServer, setJspConfigDescriptor, setJvmRoute, setLoginConfig, setManagerChecksFrequency, setName, setNamingResources, setOrderedLibs, setOriginalDocBase, setOverride, setPath, setPrivileged, setPublicId, setReload, setReloadable, setReplaceWelcomeFiles, setResources, setReuseSessionID, setSecurePagesWithPragma, setServletContainerInitializerInterestList, setSessionTimeout, setSessionTrackingModes, setStartupTime, setTldNamespaceAware, setTldScanTime, setTldValidation, setUnpackWAR, setUseMyFaces, setUseNaming, setWorkDir, setXmlNamespaceAware, setXmlValidation, startRecursive, stop, toString, updateObjectName, validateURLPattern

Methods inherited from class org.apache.catalina.core.ContainerBase

addContainerListener, addLifecycleListener, addPropertyChangeListener, addValve, addValve, findChild, findChildren, findContainerListeners, findLifecycleListeners, fireContainerEvent, getBackgroundProcessorDelay, getBasic, getChildren, getContainerSuffix, getDebug, getDomain, getJmxName, getJSR77Suffix, getLoader, getLogger, getManager, getMappingObject, getName, getObjectName, getParent, getParentClassLoader, getPipeline, getRealm, getResources, getType, getValveObjectNames, getValves, hasCustomPipeline, hasNonBasicValves, invoke, isCheckIfRequestIsSecure, logName, postDeregister, postRegister, removeContainerListener, removeLifecycleListener, removeLifecycleListeners, removePropertyChangeListener, removeValve, setBackgroundProcessorDelay, setBasic, setCheckIfRequestIsSecure, setDebug, setDomain, setLoader, setLogger, setManager, setParentClassLoader, startChildren, threadStart, threadStop

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.glassfish.embeddable.web.Context

addListener, addListener, getPath, isDirectoryListing, setDefaultWebXml, setDirectoryListing, setPath

Methods inherited from interface javax.servlet.ServletContext

addFilter, addFilter, addFilter, addListener, addServlet, addServlet, addServlet, createFilter, createListener, createServlet, declareRoles, getAttribute, getAttributeNames, getClassLoader, getContext, getContextPath, getDefaultSessionTrackingModes, getEffectiveMajorVersion, getEffectiveMinorVersion, getEffectiveSessionTrackingModes, getFilterRegistration, getFilterRegistrations, getInitParameter, getInitParameterNames, getJspConfigDescriptor, getMajorVersion, getMimeType, getMinorVersion, getNamedDispatcher, getRealPath, getRequestDispatcher, getResource, getResourceAsStream, getResourcePaths, getServerInfo, getServlet, getServletContextName, getServletNames, getServletRegistration, getServletRegistrations, getServlets, getSessionCookieConfig, log, log, log, removeAttribute, setAttribute, setInitParameter, setSessionTrackingModes

Methods inherited from interface org.apache.catalina.Container

addContainerListener, addPropertyChangeListener, findChild, findChildren, findContainerListeners, fireContainerEvent, getBackgroundProcessorDelay, getLoader, getLogger, getManager, getMappingObject, getName, getParent, getParentClassLoader, getPipeline, getRealm, getResources, hasCustomPipeline, invoke, isCheckIfRequestIsSecure, removeContainerListener, removePropertyChangeListener, setBackgroundProcessorDelay, setCheckIfRequestIsSecure, setLoader, setLogger, setManager, setParentClassLoader

Field Detail

rb

protected static final java.util.ResourceBundle rb

cachedFinds

protected java.lang.Object[] cachedFinds

Cached findXXX results

Constructor Detail

WebModule

public WebModule()

Constructor.

WebModule

public WebModule(org.jvnet.hk2.component.Habitat habitat)

Method Detail

setIasWebAppConfigBean

public void setIasWebAppConfigBean(SunWebApp iasBean)

set the sun-web.xml config bean

getIasWebAppConfigBean

public SunWebApp getIasWebAppConfigBean()

gets the sun-web.xml config bean

getWebContainer

public WebContainer getWebContainer()

Gets the web container in which this web module was loaded.

Returns:

the web container in which this web module was loaded

setWebContainer

public void setWebContainer(WebContainer webContainer)

Sets the web container in which this web module was loaded.

setWebModuleConfig

public void setWebModuleConfig(WebModuleConfig wmInfo)

getWebModuleConfig

public WebModuleConfig getWebModuleConfig()

getMonitoringNodeName

public java.lang.String getMonitoringNodeName()

setI18nInfo

public void setI18nInfo()

Sets the parameter encoding (i18n) info from sun-web.xml.

getLocaleCharsetMap

public LocaleCharsetMap[] getLocaleCharsetMap()

return locale-charset-map

hasLocaleToCharsetMapping

public boolean hasLocaleToCharsetMapping()

Returns true if this web module specifies a locale-charset-map in its sun-web.xml, false otherwise.

Specified by:

hasLocaleToCharsetMapping in class PwcWebModule

Returns:

true if this web module specifies a locale-charset-map in its sun-web.xml, false otherwise

mapLocalesToCharset

public java.lang.String mapLocalesToCharset(java.util.Enumeration locales)

Matches the given request locales against the charsets specified in the locale-charset-map of this web module's sun-web.xml, and returns the first matching charset.

Specified by:

mapLocalesToCharset in class PwcWebModule

Parameters:

locales - Request locales

Returns:

First matching charset, or null if this web module does not specify any locale-charset-map in its sun-web.xml, or no match was found

createObjectInputStream

public java.io.ObjectInputStream createObjectInputStream(java.io.InputStream is)
                                                  throws java.io.IOException

Creates an ObjectInputStream that provides special deserialization logic for classes that are normally not serializable (such as javax.naming.Context).

Overrides:

createObjectInputStream in class StandardContext

Throws:

java.io.IOException

createObjectOutputStream

public java.io.ObjectOutputStream createObjectOutputStream(java.io.OutputStream os)
                                                    throws java.io.IOException

Creates an ObjectOutputStream that provides special serialization logic for classes that are normally not serializable (such as javax.naming.Context).

Overrides:

createObjectOutputStream in class StandardContext

Throws:

java.io.IOException

setXmlConfigured

public void setXmlConfigured(boolean hasBeenXmlConfigured)

Set to true when the default-web.xml has been read for this module.

hasBeenXmlConfigured

public boolean hasBeenXmlConfigured()

Return true if the default=web.xml has been read for this module.

setCachedFindOperation

public void setCachedFindOperation(java.lang.Object[] cachedFinds)

Cache the result of doing findXX on this object NOTE: this method MUST be used only when loading/using the content of default-web.xml

getCachedFindOperation

public java.lang.Object[] getCachedFindOperation()

Return the cached result of doing findXX on this object NOTE: this method MUST be used only when loading/using the content of default-web.xml

setRealm

public void setRealm(Realm realm)

Specified by:

setRealm in interface Container

Overrides:

setRealm in class ContainerBase

start

public void start()
           throws LifecycleException

Starts this web module.

Specified by:

start in interface Lifecycle

Overrides:

start in class StandardContext

Throws:

LifecycleException

stop

public void stop()
          throws LifecycleException

Stops this web module.

Specified by:

stop in interface Lifecycle

Overrides:

stop in class StandardContext

Throws:

LifecycleException

contextListenerStart

protected void contextListenerStart()

Overrides:

contextListenerStart in class StandardContext

getTypes

protected org.glassfish.hk2.classmodel.reflect.Types getTypes()

Overrides:

getTypes in class StandardContext

callServletContainerInitializers

protected void callServletContainerInitializers()
                                         throws LifecycleException

Overrides:

callServletContainerInitializers in class StandardContext

Throws:

LifecycleException

setParent

public void setParent(Container container)

Sets the virtual server parent of this web module, and passes it on to this web module's realm adapter..

Specified by:

setParent in interface Container

Overrides:

setParent in class ContainerBase

Parameters:

container - The virtual server parent

hasAdHocPaths

public boolean hasAdHocPaths()

Indicates whether this web module contains any ad-hoc paths. An ad-hoc path is a servlet path that is mapped to a servlet not declared in the web module's deployment descriptor. A web module all of whose mappings are for ad-hoc paths is called an ad-hoc web module.

Specified by:

hasAdHocPaths in interface Context

Overrides:

hasAdHocPaths in class StandardContext

Returns:

true if this web module contains any ad-hoc paths, false otherwise

hasAdHocSubtrees

public boolean hasAdHocSubtrees()

Indicates whether this web module contains any ad-hoc subtrees.

Returns:

true if this web module contains any ad-hoc subtrees, false otherwise

getAdHocServletName

public java.lang.String getAdHocServletName(java.lang.String path)

Returns the name of the ad-hoc servlet responsible for servicing the given path.

Specified by:

getAdHocServletName in interface Context

Overrides:

getAdHocServletName in class StandardContext

Parameters:

path - The path whose associated ad-hoc servlet is needed

Returns:

The name of the ad-hoc servlet responsible for servicing the given path, or null if the given path does not represent an ad-hoc path

addAdHocValve

public void addAdHocValve(GlassFishValve valve)

Adds the given valve to this web module's ad-hoc pipeline.

Parameters:

valve - The valve to add

removeAdHocValve

public void removeAdHocValve(GlassFishValve valve)

Removes the given valve from this web module's ad-hoc pipeline.

Parameters:

valve - The valve to remove

getAdHocPipeline

public Pipeline getAdHocPipeline()

Gets this web module's ad-hoc pipeline.

Returns:

This web module's ad-hoc pipeline

setFileEncoding

public void setFileEncoding(java.lang.String enc)

Sets the file encoding of all static resources of this web module.

Parameters:

enc - The file encoding of static resources of this web module

getFileEncoding

public java.lang.String getFileEncoding()

Gets the file encoding of all static resources of this web module.

Returns:

The file encoding of static resources of this web module

configureValves

protected void configureValves()

Configure the WebModule valves.

configureCatalinaProperties

protected void configureCatalinaProperties()

Configure the WebModule

configureCatalinaProperties

protected void configureCatalinaProperties(java.lang.String propName,
                                           java.lang.String propValue)

Configure the WebModule

Parameters:

propName - the property name

propValue - the property value

addValve

protected void addValve(java.lang.String className)

Instantiates a Valve from the given className and adds it to the Pipeline of this WebModule.

Parameters:

className - the fully qualified class name of the Valve

addValve

protected void addValve(Valve valveDescriptor)

Constructs a Valve from the given valveDescriptor and adds it to the Pipeline of this WebModule.

Parameters:

valveDescriptor - the object containing the information to create the valve.

addCatalinaListener

protected void addCatalinaListener(java.lang.String listenerName)

Adds the Catalina listener with the given class name to this WebModule.

Parameters:

listenerName - The fully qualified class name of the listener

getBean

public Application getBean()

setBean

public void setBean(Application bean)

getWebBundleDescriptor

public WebBundleDescriptor getWebBundleDescriptor()

Gets the WebBundleDesciptor (web.xml) for this WebModule.

getComponentId

public java.lang.String getComponentId()

Gets ComponentId for Invocation.

getServerContext

public ServerContext getServerContext()

Gets ServerContext.

loadListener

protected java.util.EventListener loadListener(java.lang.ClassLoader loader,
                                               java.lang.String listenerClassName)
                                        throws java.lang.Exception

Loads and instantiates the listener with the specified classname.

Overrides:

loadListener in class StandardContext

Parameters:

loader - the classloader to use

listenerClassName - the fully qualified classname to instantiate

Returns:

the instantiated listener

Throws:

java.lang.Exception - if the specified classname fails to be loaded or instantiated

configureSessionSettings

protected void configureSessionSettings(WebBundleDescriptor wbd,
                                        WebModuleConfig wmInfo)

Create and configure the session manager for this web application according to the persistence type specified. Also configure the other aspects of session management for this web application according to the values specified in the session-config element of sun-web.xml (and whether app is distributable)

createServletRegistrationImpl

protected ServletRegistrationImpl createServletRegistrationImpl(StandardWrapper wrapper)

Overrides:

createServletRegistrationImpl in class StandardContext

createDynamicServletRegistrationImpl

protected ServletRegistrationImpl createDynamicServletRegistrationImpl(StandardWrapper wrapper)

Overrides:

createDynamicServletRegistrationImpl in class StandardContext

removePatternFromServlet

protected void removePatternFromServlet(Wrapper wrapper,
                                        java.lang.String pattern)

Overrides:

removePatternFromServlet in class StandardContext

createServletInstance

protected <T extends javax.servlet.Servlet> T createServletInstance(java.lang.Class<T> clazz)
                                                         throws java.lang.Exception

Instantiates the given Servlet class.

Overrides:

createServletInstance in class StandardContext

Returns:

the new Servlet instance

Throws:

java.lang.Exception

createFilterInstance

protected <T extends javax.servlet.Filter> T createFilterInstance(java.lang.Class<T> clazz)
                                                       throws java.lang.Exception

Instantiates the given Filter class.

Overrides:

createFilterInstance in class StandardContext

Returns:

the new Filter instance

Throws:

java.lang.Exception

createListenerInstance

public <T extends java.util.EventListener> T createListenerInstance(java.lang.Class<T> clazz)
                                                         throws java.lang.Exception

Instantiates the given EventListener class.

Overrides:

createListenerInstance in class StandardContext

Returns:

the new EventListener instance

Throws:

java.lang.Exception

servletInitializedEvent

public void servletInitializedEvent(java.lang.String servletName)

servletDestroyedEvent

public void servletDestroyedEvent(java.lang.String servletName)

beforeServiceEvent

public void beforeServiceEvent(java.lang.String servletName)

afterServiceEvent

public void afterServiceEvent(java.lang.String servletName,
                              int status)

sessionCreatedEvent

public void sessionCreatedEvent(javax.servlet.http.HttpSession session)

Overrides:

sessionCreatedEvent in class StandardContext

sessionDestroyedEvent

public void sessionDestroyedEvent(javax.servlet.http.HttpSession session)

Overrides:

sessionDestroyedEvent in class StandardContext

sessionRejectedEvent

public void sessionRejectedEvent(int maxSessions)

Overrides:

sessionRejectedEvent in class StandardContext

sessionExpiredEvent

public void sessionExpiredEvent(javax.servlet.http.HttpSession session)

Overrides:

sessionExpiredEvent in class StandardContext

sessionPersistedStartEvent

public void sessionPersistedStartEvent(javax.servlet.http.HttpSession session)

Overrides:

sessionPersistedStartEvent in class StandardContext

sessionPersistedEndEvent

public void sessionPersistedEndEvent(javax.servlet.http.HttpSession session)

Overrides:

sessionPersistedEndEvent in class StandardContext

sessionActivatedStartEvent

public void sessionActivatedStartEvent(javax.servlet.http.HttpSession session)

Overrides:

sessionActivatedStartEvent in class StandardContext

sessionActivatedEndEvent

public void sessionActivatedEndEvent(javax.servlet.http.HttpSession session)

Overrides:

sessionActivatedEndEvent in class StandardContext

sessionPassivatedStartEvent

public void sessionPassivatedStartEvent(javax.servlet.http.HttpSession session)

Overrides:

sessionPassivatedStartEvent in class StandardContext

sessionPassivatedEndEvent

public void sessionPassivatedEndEvent(javax.servlet.http.HttpSession session)

Overrides:

sessionPassivatedEndEvent in class StandardContext

webModuleStartedEvent

public void webModuleStartedEvent()

webModuleStoppedEvent

public void webModuleStoppedEvent()

getSecurityConfig

public SecurityConfig getSecurityConfig()

setSecurityConfig

public void setSecurityConfig(SecurityConfig config)