public interface Context extends Container
The parent Container attached to a Context is generally a Host, but may be some other implementation, or may be omitted if it is not necessary.
The child containers attached to a Context are generally implementations of Wrapper (representing individual servlet definitions).
Modifier and Type | Field and Description |
---|---|
static String |
BIND_THREAD_EVENT
The LifecycleEvent type sent to bind context information to the thread.
|
static String |
COMPLETE_CONFIG_EVENT
The LifecycleEvent type sent to complete the configuration
(called after running all listeners and other init callbacks).
|
static String |
RELOAD_EVENT
The LifecycleEvent type sent when a context is reloaded.
|
static String |
UNBIND_THREAD_EVENT
The LifecycleEvent type sent to unbind context information to the thread.
|
ADD_CHILD_EVENT, ADD_MAPPER_EVENT, ADD_VALVE_EVENT, REMOVE_CHILD_EVENT, REMOVE_MAPPER_EVENT, REMOVE_VALVE_EVENT
Modifier and Type | Method and Description |
---|---|
void |
addApplicationListener(String listener)
Add a new Listener class name to the set of Listeners
configured for this application.
|
<T extends EventListener> |
addApplicationListenerInstance(T listener)
Add a new Listener instance to the set of Listeners
configured for this application.
|
void |
addApplicationParameter(ApplicationParameter parameter)
Add a new application parameter for this application.
|
void |
addConstraint(SecurityConstraint constraint)
Add a security constraint to the set for this web application.
|
void |
addErrorPage(ErrorPage errorPage)
Add an error page for the specified error or Java exception.
|
void |
addFilterDef(FilterDef filterDef)
Add a filter definition to this Context.
|
void |
addFilterMap(FilterMap filterMap)
Add a filter mapping to this Context.
|
void |
addFilterMapBefore(FilterMap filterMap)
Add a filter mapping to this Context before current mappings.
|
void |
addInstanceListener(String listener)
Add the classname of an InstanceListener to be added to each
Wrapper appended to this Context.
|
void |
addJspMapping(String pattern)
Add the given URL pattern as a jsp-property-group.
|
void |
addJspPropertyGroup(JspPropertyGroup propertyGroup)
Add the given jsp-property-group.
|
void |
addJspTagLibrary(String uri,
TagLibraryInfo tagLibraryInfo)
Add the given JSP tag library metadata.
|
void |
addJspTagLibrary(TagLibraryInfo tagLibraryInfo)
Add the given JSP tag library metadata.
|
void |
addLocaleEncodingMappingParameter(String locale,
String encoding)
Add a Locale Encoding Mapping (see Sec 5.4 of Servlet spec 2.4)
|
void |
addMimeMapping(String extension,
String mimeType)
Add a new MIME mapping, replacing any existing mapping for
the specified extension.
|
void |
addParameter(String name,
String value)
Add a new context initialization parameter, replacing any existing
value for the specified name.
|
void |
addRoleMapping(String role,
String link)
Add a security role reference for this web application.
|
void |
addSecurityRole(String role)
Add a new security role for this web application.
|
void |
addServletMapping(String pattern,
String name)
Add a new servlet mapping, replacing any existing mapping for
the specified pattern.
|
void |
addSessionTrackingMode(String trackingMode)
Add the given session tracking mode.
|
void |
addTaglib(String uri,
String location)
Add a JSP tag library for the specified URI.
|
void |
addWelcomeFile(String name)
Add a new welcome file to the set recognized by this Context.
|
void |
addWrapperLifecycle(String listener)
Add the classname of a LifecycleListener to be added to each
Wrapper appended to this Context.
|
void |
addWrapperListener(String listener)
Add the classname of a ContainerListener to be added to each
Wrapper appended to this Context.
|
Wrapper |
createWrapper()
Factory method to create and return a new Wrapper instance, of
the Java implementation class appropriate for this Context
implementation.
|
String[] |
findApplicationListeners()
Return the set of application listener class names configured
for this application.
|
ApplicationParameter[] |
findApplicationParameters()
Return the set of application parameters for this application.
|
SecurityConstraint[] |
findConstraints()
Return the set of security constraints for this web application.
|
ErrorPage |
findErrorPage(int errorCode)
Return the error page entry for the specified HTTP error code,
if any; otherwise return
null . |
ErrorPage |
findErrorPage(String exceptionType)
Return the error page entry for the specified Java exception type,
if any; otherwise return
null . |
ErrorPage[] |
findErrorPages()
Return the set of defined error pages for all specified error codes
and exception types.
|
FilterDef |
findFilterDef(String filterName)
Return the filter definition for the specified filter name, if any;
otherwise return
null . |
FilterDef[] |
findFilterDefs()
Return the set of defined filters for this Context.
|
FilterMap[] |
findFilterMaps()
Return the set of filter mappings for this Context.
|
String[] |
findInstanceListeners()
Return the set of InstanceListener classes that will be added to
newly created Wrappers automatically.
|
JspPropertyGroup[] |
findJspPropertyGroups()
Return the set of JSP property groups.
|
String |
findMimeMapping(String extension)
Return the MIME type to which the specified extension is mapped,
if any; otherwise return
null . |
String[] |
findMimeMappings()
Return the extensions for which MIME mappings are defined.
|
String |
findParameter(String name)
Return the value for the specified context initialization
parameter name, if any; otherwise return
null . |
String[] |
findParameters()
Return the names of all defined context initialization parameters
for this Context.
|
String |
findRoleMapping(String role)
For the given security role (as used by an application), return the
corresponding role name (as defined by the underlying Realm) if there
is one.
|
boolean |
findSecurityRole(String role)
Return
true if the specified security role is defined
for this application; otherwise return false . |
String[] |
findSecurityRoles()
Return the security roles defined for this application.
|
String |
findServletMapping(String pattern)
Return the servlet name mapped by the specified pattern (if any);
otherwise return
null . |
String[] |
findServletMappings()
Return the patterns of all defined servlet mappings for this
Context.
|
int[] |
findStatusPages()
Return the set of HTTP status codes for which error pages have
been specified.
|
String |
findTaglib(String uri)
Return the tag library descriptor location for the specified taglib
URI, if any; otherwise, return
null . |
String[] |
findTaglibs()
Return the URIs of all tag libraries for which a tag library
descriptor location has been specified.
|
boolean |
findWelcomeFile(String name)
Return
true if the specified welcome file is defined
for this Context; otherwise return false . |
String[] |
findWelcomeFiles()
Return the set of welcome files defined for this Context.
|
String[] |
findWrapperLifecycles()
Return the set of LifecycleListener classes that will be added to
newly created Wrappers automatically.
|
String[] |
findWrapperListeners()
Return the set of ContainerListener classes that will be added to
newly created Wrappers automatically.
|
String |
getAltDDName()
Return the alternate Deployment Descriptor name.
|
Object[] |
getApplicationEventListeners()
Return the set of initialized application event listener objects,
in the order they were specified in the web application deployment
descriptor, for this application.
|
Object[] |
getApplicationLifecycleListeners()
Return the set of initialized application lifecycle listener objects,
in the order they were specified in the web application deployment
descriptor, for this application.
|
Object[] |
getApplicationSessionLifecycleListeners()
Return the set of initialized application lifecycle listener objects,
in the order they were specified in the web application deployment
descriptor, for this application.
|
Authenticator |
getAuthenticator()
Return the authenticator that is configured for this context, or
null if no authenticator has been configured.
|
boolean |
getAvailable()
Return the application available flag for this Context.
|
CharsetMapper |
getCharsetMapper()
Return the Locale to character set mapper for this Context.
|
boolean |
getConfigured()
Return the "correctly configured" flag for this Context.
|
boolean |
getCookies()
Return the "use cookies for session ids" flag.
|
boolean |
getCrossContext()
Return the "allow crossing servlet contexts" flag.
|
String |
getDisplayName()
Return the display name of this web application.
|
boolean |
getDistributable()
Return the distributable flag for this web application.
|
String |
getDocBase()
Return the document root for this Context.
|
String |
getEncodedPath()
Return the URL encoded context path, using UTF-8.
|
boolean |
getIgnoreAnnotations()
Return the boolean on the annotations parsing.
|
InstanceManager |
getInstanceManager()
Used to create application instances.
|
String |
getLogicalName()
Return the logical name for this web application.
|
LoginConfig |
getLoginConfig()
Return the login configuration descriptor for this web application.
|
Mapper |
getMapper()
Get the request dispatcher mapper.
|
boolean |
getOverride()
Return the override flag for this web application.
|
String |
getPath()
Return the context path for this web application.
|
boolean |
getPrivileged()
Return the privileged flag for this web application.
|
String |
getPublicId()
Return the public identifier of the deployment descriptor DTD that is
currently being parsed.
|
javax.servlet.ServletContext |
getServletContext()
Return the servlet context for which this Context is a facade.
|
SessionCookie |
getSessionCookie()
Return the session cookie configuration.
|
int |
getSessionTimeout()
Return the default session timeout (in minutes) for this
web application.
|
ThreadBindingListener |
getThreadBindingListener()
Get the associated ThreadBindingListener.
|
String |
getVersion()
Return the Servlet API version defined for the webapp.
|
int |
getVersionMajor()
Return the Servlet API version defined for the webapp.
|
int |
getVersionMinor()
Return the Servlet API version defined for the webapp.
|
String |
getWrapperClass()
Return the Java class name of the Wrapper implementation used
for servlets registered in this Context.
|
boolean |
isInitialized()
Return true if the Context has been initialized.
|
boolean |
isStarting()
Return the application starting flag for this Context.
|
void |
reload()
Reload this web application, if reloading is supported.
|
void |
removeApplicationListener(String listener)
Remove the specified application listener class from the set of
listeners for this application.
|
void |
removeApplicationParameter(String name)
Remove the application parameter with the specified name from
the set for this application.
|
void |
removeConstraint(SecurityConstraint constraint)
Remove the specified security constraint from this web application.
|
void |
removeErrorPage(ErrorPage errorPage)
Remove the error page for the specified error code or
Java language exception, if it exists; otherwise, no action is taken.
|
void |
removeFilterDef(FilterDef filterDef)
Remove the specified filter definition from this Context, if it exists;
otherwise, no action is taken.
|
void |
removeFilterMap(FilterMap filterMap)
Remove a filter mapping from this Context.
|
void |
removeInstanceListener(String listener)
Remove a class name from the set of InstanceListener classes that
will be added to newly created Wrappers.
|
void |
removeMimeMapping(String extension)
Remove the MIME mapping for the specified extension, if it exists;
otherwise, no action is taken.
|
void |
removeParameter(String name)
Remove the context initialization parameter with the specified
name, if it exists; otherwise, no action is taken.
|
void |
removeRoleMapping(String role)
Remove any security role reference for the specified name
|
void |
removeSecurityRole(String role)
Remove any security role with the specified name.
|
void |
removeServletMapping(String pattern)
Remove any servlet mapping for the specified pattern, if it exists;
otherwise, no action is taken.
|
void |
removeTaglib(String uri)
Remove the tag library location forthe specified tag library URI.
|
void |
removeWelcomeFile(String name)
Remove the specified welcome file name from the list recognized
by this Context.
|
void |
removeWrapperLifecycle(String listener)
Remove a class name from the set of LifecycleListener classes that
will be added to newly created Wrappers.
|
void |
removeWrapperListener(String listener)
Remove a class name from the set of ContainerListener classes that
will be added to newly created Wrappers.
|
void |
setAltDDName(String altDDName)
Set an alternate Deployment Descriptor name.
|
void |
setApplicationEventListeners(Object[] listeners)
Store the set of initialized application event listener objects,
in the order they were specified in the web application deployment
descriptor, for this application.
|
void |
setApplicationLifecycleListeners(Object[] listeners)
Store the set of initialized application lifecycle listener objects,
in the order they were specified in the web application deployment
descriptor, for this application.
|
void |
setApplicationSessionLifecycleListeners(Object[] listeners)
Store the set of initialized application lifecycle listener objects,
in the order they were specified in the web application deployment
descriptor, for this application.
|
void |
setAuthenticator(Authenticator authenticator)
Set the authenticator for this context.
|
void |
setAvailable(boolean available)
Set the application available flag for this Context.
|
void |
setCharsetMapper(CharsetMapper mapper)
Set the Locale to character set mapper for this Context.
|
void |
setConfigured(boolean configured)
Set the "correctly configured" flag for this Context.
|
void |
setCookies(boolean cookies)
Set the "use cookies for session ids" flag.
|
void |
setCrossContext(boolean crossContext)
Set the "allow crossing servlet contexts" flag.
|
void |
setDisplayName(String displayName)
Set the display name of this web application.
|
void |
setDistributable(boolean distributable)
Set the distributable flag for this web application.
|
void |
setDocBase(String docBase)
Set the document root for this Context.
|
void |
setIgnoreAnnotations(boolean ignoreAnnotations)
Set the boolean on the annotations parsing for this web
application.
|
void |
setInstanceManager(InstanceManager instanceManager)
Set the instance manager associated with this Context.
|
void |
setLogicalName(String logicalName)
Set the logical name for this web application.
|
void |
setLoginConfig(LoginConfig config)
Set the login configuration descriptor for this web application.
|
void |
setOverride(boolean override)
Set the override flag for this web application.
|
void |
setPath(String path)
Set the context path for this web application.
|
void |
setPrivileged(boolean privileged)
Set the privileged flag for this web application.
|
void |
setPublicId(String publicId)
Set the public identifier of the deployment descriptor DTD that is
currently being parsed.
|
void |
setSessionCookie(SessionCookie sessionCookie)
Set the session cookie configuration.
|
void |
setSessionTimeout(int timeout)
Set the default session timeout (in minutes) for this
web application.
|
void |
setStarting(boolean starting)
Set the application starting flag for this Context.
|
void |
setThreadBindingListener(ThreadBindingListener threadBindingListener)
Get the associated ThreadBindingListener.
|
void |
setVersion(String version)
Set the Servlet API version defined for the webapp.
|
void |
setWrapperClass(String wrapperClass)
Set the Java class name of the Wrapper implementation used
for servlets registered in this Context.
|
addChild, addContainerListener, addPropertyChangeListener, backgroundProcess, findChild, findChildren, findContainerListeners, fireContainerEvent, getBackgroundProcessorDelay, getCluster, getInfo, getLoader, getLogger, getManager, getMappingObject, getName, getObjectName, getParent, getParentClassLoader, getPipeline, getRealm, getResources, invoke, isStarted, removeChild, removeContainerListener, removePropertyChangeListener, setBackgroundProcessorDelay, setCluster, setLoader, setManager, setName, setParent, setParentClassLoader, setRealm, setResources
static final String RELOAD_EVENT
static final String COMPLETE_CONFIG_EVENT
static final String BIND_THREAD_EVENT
static final String UNBIND_THREAD_EVENT
void addSessionTrackingMode(String trackingMode)
Authenticator getAuthenticator()
void setAuthenticator(Authenticator authenticator)
authenticator
- the new Authenticator for this contextObject[] getApplicationEventListeners()
IllegalStateException
- if this method is called before
this application has started, or after it has been stoppedvoid setApplicationEventListeners(Object[] listeners)
listeners
- The set of instantiated listener objects.Object[] getApplicationLifecycleListeners()
IllegalStateException
- if this method is called before
this application has started, or after it has been stoppedvoid setApplicationLifecycleListeners(Object[] listeners)
listeners
- The set of instantiated listener objects.Object[] getApplicationSessionLifecycleListeners()
IllegalStateException
- if this method is called before
this application has started, or after it has been stoppedvoid setApplicationSessionLifecycleListeners(Object[] listeners)
listeners
- The set of instantiated listener objects.boolean getAvailable()
void setAvailable(boolean available)
available
- The new application available flagboolean isStarting()
void setStarting(boolean starting)
starting
- The new application starting flagCharsetMapper getCharsetMapper()
void setCharsetMapper(CharsetMapper mapper)
mapper
- The new mapperboolean getConfigured()
void setConfigured(boolean configured)
configured
- The new correctly configured flagboolean getCookies()
void setSessionCookie(SessionCookie sessionCookie)
sessionCookie
- The new valueSessionCookie getSessionCookie()
void setCookies(boolean cookies)
cookies
- The new flagboolean getCrossContext()
String getAltDDName()
void setAltDDName(String altDDName)
void setCrossContext(boolean crossContext)
crossContext
- The new cross contexts flagString getDisplayName()
void setDisplayName(String displayName)
displayName
- The new display nameboolean getDistributable()
void setDistributable(boolean distributable)
distributable
- The new distributable flagString getDocBase()
void setDocBase(String docBase)
docBase
- The new document rootString getEncodedPath()
boolean getIgnoreAnnotations()
void setIgnoreAnnotations(boolean ignoreAnnotations)
ignoreAnnotations
- The boolean on the annotations parsingInstanceManager getInstanceManager()
void setInstanceManager(InstanceManager instanceManager)
instanceManager
- The instance managerString getLogicalName()
void setLogicalName(String logicalName)
logicalName
- The new logical nameLoginConfig getLoginConfig()
void setLoginConfig(LoginConfig config)
config
- The new login configurationMapper getMapper()
String getPath()
void setPath(String path)
path
- The new context pathString getPublicId()
void setPublicId(String publicId)
publicId
- The public identifierString getVersion()
int getVersionMajor()
int getVersionMinor()
void setVersion(String version)
version
- The versionboolean getOverride()
void setOverride(boolean override)
override
- The new override flagboolean getPrivileged()
void setPrivileged(boolean privileged)
privileged
- The new privileged flagjavax.servlet.ServletContext getServletContext()
int getSessionTimeout()
void setSessionTimeout(int timeout)
timeout
- The new default session timeoutString getWrapperClass()
void setWrapperClass(String wrapperClass)
wrapperClass
- The new wrapper classvoid addApplicationListener(String listener)
listener
- Java class name of a listener class<T extends EventListener> void addApplicationListenerInstance(T listener)
listener
- Java instance of a listenervoid addApplicationParameter(ApplicationParameter parameter)
parameter
- The new application parametervoid addConstraint(SecurityConstraint constraint)
void addErrorPage(ErrorPage errorPage)
errorPage
- The error page definition to be addedvoid addFilterDef(FilterDef filterDef)
filterDef
- The filter definition to be addedvoid addFilterMap(FilterMap filterMap)
filterMap
- The filter mapping to be addedvoid addFilterMapBefore(FilterMap filterMap)
filterMap
- The filter mapping to be addedvoid addInstanceListener(String listener)
listener
- Java class name of an InstanceListener classvoid addJspMapping(String pattern)
pattern
- URL pattern to be mappedvoid addJspPropertyGroup(JspPropertyGroup propertyGroup)
propertyGroup
- the property group which will be addedvoid addJspTagLibrary(TagLibraryInfo tagLibraryInfo)
tagLibraryInfo
- the tag library info that will be addedvoid addJspTagLibrary(String uri, TagLibraryInfo tagLibraryInfo)
tagLibraryInfo
- the tag library info that will be addedvoid addLocaleEncodingMappingParameter(String locale, String encoding)
locale
- locale to map an encoding forencoding
- encoding to be used for a give localevoid addMimeMapping(String extension, String mimeType)
extension
- Filename extension being mappedmimeType
- Corresponding MIME typevoid addParameter(String name, String value)
name
- Name of the new parametervalue
- Value of the new parametervoid addRoleMapping(String role, String link)
role
- Security role used in the applicationlink
- Actual security role to check forvoid addSecurityRole(String role)
role
- New security rolevoid addServletMapping(String pattern, String name)
pattern
- URL pattern to be mappedname
- Name of the corresponding servlet to executevoid addTaglib(String uri, String location)
uri
- URI, relative to the web.xml file, of this tag librarylocation
- Location of the tag library descriptorvoid addWelcomeFile(String name)
name
- New welcome file namevoid addWrapperLifecycle(String listener)
listener
- Java class name of a LifecycleListener classvoid addWrapperListener(String listener)
listener
- Java class name of a ContainerListener classWrapper createWrapper()
String[] findApplicationListeners()
ApplicationParameter[] findApplicationParameters()
SecurityConstraint[] findConstraints()
ErrorPage findErrorPage(int errorCode)
null
.errorCode
- Error code to look upErrorPage findErrorPage(String exceptionType)
null
.exceptionType
- Exception type to look upErrorPage[] findErrorPages()
FilterDef findFilterDef(String filterName)
null
.filterName
- Filter name to look upFilterDef[] findFilterDefs()
FilterMap[] findFilterMaps()
String[] findInstanceListeners()
JspPropertyGroup[] findJspPropertyGroups()
String findMimeMapping(String extension)
null
.extension
- Extension to map to a MIME typeString[] findMimeMappings()
String findParameter(String name)
null
.name
- Name of the parameter to returnString[] findParameters()
String findRoleMapping(String role)
role
- Security role to mapboolean findSecurityRole(String role)
true
if the specified security role is defined
for this application; otherwise return false
.role
- Security role to verifyString[] findSecurityRoles()
String findServletMapping(String pattern)
null
.pattern
- Pattern for which a mapping is requestedString[] findServletMappings()
int[] findStatusPages()
String findTaglib(String uri)
null
.uri
- URI, relative to the web.xml fileString[] findTaglibs()
boolean findWelcomeFile(String name)
true
if the specified welcome file is defined
for this Context; otherwise return false
.name
- Welcome file to verifyString[] findWelcomeFiles()
String[] findWrapperLifecycles()
String[] findWrapperListeners()
void reload()
IllegalStateException
- if the reloadable
property is set to false
.void removeApplicationListener(String listener)
listener
- Java class name of the listener to be removedvoid removeApplicationParameter(String name)
name
- Name of the application parameter to removevoid removeConstraint(SecurityConstraint constraint)
constraint
- Constraint to be removedvoid removeErrorPage(ErrorPage errorPage)
errorPage
- The error page definition to be removedvoid removeFilterDef(FilterDef filterDef)
filterDef
- Filter definition to be removedvoid removeFilterMap(FilterMap filterMap)
filterMap
- The filter mapping to be removedvoid removeInstanceListener(String listener)
listener
- Class name of an InstanceListener class to be removedvoid removeMimeMapping(String extension)
extension
- Extension to remove the mapping forvoid removeParameter(String name)
name
- Name of the parameter to removevoid removeRoleMapping(String role)
role
- Security role (as used in the application) to removevoid removeSecurityRole(String role)
role
- Security role to removevoid removeServletMapping(String pattern)
pattern
- URL pattern of the mapping to removevoid removeTaglib(String uri)
uri
- URI, relative to the web.xml filevoid removeWelcomeFile(String name)
name
- Name of the welcome file to be removedvoid removeWrapperLifecycle(String listener)
listener
- Class name of a LifecycleListener class to be removedvoid removeWrapperListener(String listener)
listener
- Class name of a ContainerListener class to be removedboolean isInitialized()
ThreadBindingListener getThreadBindingListener()
void setThreadBindingListener(ThreadBindingListener threadBindingListener)
Copyright © 2016 JBoss by Red Hat. All rights reserved.