public class FailedContext extends LifecycleMBeanBase implements Context
Context
that is used as a place-holder for
deployed applications when their deployment fails and a Context instance
(usually StandardContext
but may be any
Context implementation) cannot be created.Lifecycle.SingleUse
Modifier and Type | Field and Description |
---|---|
protected static StringManager |
sm |
mserver
ADD_WELCOME_FILE_EVENT, CHANGE_SESSION_ID_EVENT, CLEAR_WELCOME_FILES_EVENT, REMOVE_WELCOME_FILE_EVENT
ADD_CHILD_EVENT, ADD_VALVE_EVENT, REMOVE_CHILD_EVENT, REMOVE_VALVE_EVENT
AFTER_DESTROY_EVENT, AFTER_INIT_EVENT, AFTER_START_EVENT, AFTER_STOP_EVENT, BEFORE_DESTROY_EVENT, BEFORE_INIT_EVENT, BEFORE_START_EVENT, BEFORE_STOP_EVENT, CONFIGURE_START_EVENT, CONFIGURE_STOP_EVENT, PERIODIC_EVENT, START_EVENT, STOP_EVENT
Constructor and Description |
---|
FailedContext() |
Modifier and Type | Method and Description |
---|---|
void |
addApplicationListener(java.lang.String listener)
Add a new Listener class name to the set of Listeners
configured for this application.
|
void |
addApplicationParameter(ApplicationParameter parameter)
Add a new application parameter for this application.
|
void |
addChild(Container child)
Add a new child Container to those associated with this Container,
if supported.
|
void |
addConstraint(SecurityConstraint constraint)
Add a security constraint to the set for this web application.
|
void |
addContainerListener(ContainerListener listener)
Add a container event listener to this component.
|
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 the mappings defined in the
deployment descriptor but after any other mappings added via this method.
|
void |
addInstanceListener(java.lang.String listener)
Add the classname of an InstanceListener to be added to each
Wrapper appended to this Context.
|
void |
addLocaleEncodingMappingParameter(java.lang.String locale,
java.lang.String encoding)
Add a Locale Encoding Mapping (see Sec 5.4 of Servlet spec 2.4)
|
void |
addMimeMapping(java.lang.String extension,
java.lang.String mimeType)
Add a new MIME mapping, replacing any existing mapping for
the specified extension.
|
void |
addParameter(java.lang.String name,
java.lang.String value)
Add a new context initialization parameter, replacing any existing
value for the specified name.
|
void |
addPostConstructMethod(java.lang.String clazz,
java.lang.String method)
Add a post construct method definition for the given class, if there is
an existing definition for the specified class - IllegalArgumentException
will be thrown.
|
void |
addPreDestroyMethod(java.lang.String clazz,
java.lang.String method)
Add a pre destroy method definition for the given class, if there is an
existing definition for the specified class - IllegalArgumentException
will be thrown.
|
void |
addPropertyChangeListener(java.beans.PropertyChangeListener listener)
Add a property change listener to this component.
|
void |
addRoleMapping(java.lang.String role,
java.lang.String link)
Add a security role reference for this web application.
|
void |
addSecurityRole(java.lang.String role)
Add a new security role for this web application.
|
void |
addServletContainerInitializer(ServletContainerInitializer sci,
java.util.Set<java.lang.Class<?>> classes)
Add a ServletContainerInitializer instance to this web application.
|
void |
addServletMapping(java.lang.String pattern,
java.lang.String name)
Add a new servlet mapping, replacing any existing mapping for
the specified pattern.
|
void |
addServletMapping(java.lang.String pattern,
java.lang.String name,
boolean jspWildcard)
Add a new servlet mapping, replacing any existing mapping for
the specified pattern.
|
void |
addServletMappingDecoded(java.lang.String pattern,
java.lang.String name)
Add a new servlet mapping, replacing any existing mapping for
the specified pattern.
|
void |
addServletMappingDecoded(java.lang.String pattern,
java.lang.String name,
boolean jspWildcard)
Add a new servlet mapping, replacing any existing mapping for
the specified pattern.
|
java.util.Set<java.lang.String> |
addServletSecurity(ServletRegistration.Dynamic registration,
ServletSecurityElement servletSecurityElement)
Notification that servlet security has been dynamically set in a
ServletRegistration.Dynamic |
void |
addValve(Valve valve) |
void |
addWatchedResource(java.lang.String name)
Add a resource which will be watched for reloading by the host auto
deployer.
|
void |
addWelcomeFile(java.lang.String name)
Add a new welcome file to the set recognized by this Context.
|
void |
addWrapperLifecycle(java.lang.String listener)
Add the classname of a LifecycleListener to be added to each
Wrapper appended to this Context.
|
void |
addWrapperListener(java.lang.String listener)
Add the classname of a ContainerListener to be added to each
Wrapper appended to this Context.
|
void |
backgroundProcess()
Execute a periodic task, such as reloading, etc.
|
java.lang.ClassLoader |
bind(boolean usePrivilegedAction,
java.lang.ClassLoader originalClassLoader)
Change the current thread context class loader to the web application
class loader.
|
Wrapper |
createWrapper()
Factory method to create and return a new Wrapper instance, of
the Java implementation class appropriate for this Context
implementation.
|
java.lang.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.
|
Container |
findChild(java.lang.String name)
Obtain a child Container by name.
|
Container[] |
findChildren()
Obtain the child Containers associated with this Container.
|
SecurityConstraint[] |
findConstraints()
Return the set of security constraints for this web application.
|
ContainerListener[] |
findContainerListeners()
Obtain the container listeners associated with this Container.
|
ErrorPage |
findErrorPage(int errorCode)
Return the error page entry for the specified HTTP error code,
if any; otherwise return
null . |
ErrorPage |
findErrorPage(java.lang.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(java.lang.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.
|
java.lang.String[] |
findInstanceListeners()
Return the set of InstanceListener classes that will be added to
newly created Wrappers automatically.
|
java.lang.String |
findMimeMapping(java.lang.String extension)
Return the MIME type to which the specified extension is mapped,
if any; otherwise return
null . |
java.lang.String[] |
findMimeMappings()
Return the extensions for which MIME mappings are defined.
|
java.lang.String |
findParameter(java.lang.String name)
Return the value for the specified context initialization
parameter name, if any; otherwise return
null . |
java.lang.String[] |
findParameters()
Return the names of all defined context initialization parameters
for this Context.
|
java.lang.String |
findPostConstructMethod(java.lang.String clazz)
Returns the method name that is specified as post construct method for
the given class, if it exists; otherwise
NULL will be
returned. |
java.util.Map<java.lang.String,java.lang.String> |
findPostConstructMethods()
Returns a map with keys - fully qualified class names of the classes that
have post construct methods and the values are the corresponding method
names.
|
java.lang.String |
findPreDestroyMethod(java.lang.String clazz)
Returns the method name that is specified as pre destroy method for the
given class, if it exists; otherwise
NULL will be returned. |
java.util.Map<java.lang.String,java.lang.String> |
findPreDestroyMethods()
Returns a map with keys - fully qualified class names of the classes that
have pre destroy methods and the values are the corresponding method
names.
|
java.lang.String |
findRoleMapping(java.lang.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(java.lang.String role)
Return
true if the specified security role is defined
for this application; otherwise return false . |
java.lang.String[] |
findSecurityRoles()
Return the security roles defined for this application.
|
java.lang.String |
findServletMapping(java.lang.String pattern)
Return the servlet name mapped by the specified pattern (if any);
otherwise return
null . |
java.lang.String[] |
findServletMappings()
Return the patterns of all defined servlet mappings for this
Context.
|
java.lang.String |
findStatusPage(int status)
Return the context-relative URI of the error page for the specified
HTTP status code, if any; otherwise return
null . |
int[] |
findStatusPages()
Return the set of HTTP status codes for which error pages have
been specified.
|
java.lang.String[] |
findWatchedResources()
Return the set of watched resources for this Context.
|
boolean |
findWelcomeFile(java.lang.String name)
Return
true if the specified welcome file is defined
for this Context; otherwise return false . |
java.lang.String[] |
findWelcomeFiles()
Return the set of welcome files defined for this Context.
|
java.lang.String[] |
findWrapperLifecycles()
Return the set of LifecycleListener classes that will be added to
newly created Wrappers automatically.
|
java.lang.String[] |
findWrapperListeners()
Return the set of ContainerListener classes that will be added to
newly created Wrappers automatically.
|
void |
fireContainerEvent(java.lang.String type,
java.lang.Object data)
Notify all container event listeners that a particular event has
occurred for this Container.
|
boolean |
fireRequestDestroyEvent(ServletRequest request)
Notify all
ServletRequestListener s that a request
has ended. |
boolean |
fireRequestInitEvent(ServletRequest request)
Notify all
ServletRequestListener s that a request
has started. |
AccessLog |
getAccessLog()
Obtain the AccessLog to use to log a request/response that is destined
for this container.
|
boolean |
getAddWebinfClassesResources()
Gets the flag that indicates if /WEB-INF/classes should be treated like
an exploded JAR and JAR resources made available as if they were in a
JAR.
|
boolean |
getAllowCasualMultipartParsing()
Returns
true if requests mapped to servlets without
"multipart config" to parse multipart/form-data requests anyway. |
boolean |
getAllowMultipleLeadingForwardSlashInPath()
When returning a context path from
HttpServletRequest.getContextPath() , is it allowed to
contain multiple leading '/' characters? |
java.lang.String |
getAltDDName()
Return the alternate Deployment Descriptor name.
|
java.lang.Object[] |
getApplicationEventListeners()
Obtain the registered application event listeners.
|
java.lang.Object[] |
getApplicationLifecycleListeners()
Obtain the registered application lifecycle listeners.
|
Authenticator |
getAuthenticator()
Obtain the
Authenticator that is used by this context or
null if none is used. |
int |
getBackgroundProcessorDelay()
Get the delay between the invocation of the backgroundProcess method on
this container and its children.
|
java.lang.String |
getBaseName()
Return the base name to use for WARs, directories or context.xml files
for this context.
|
java.io.File |
getCatalinaBase()
Obtain the location of CATALINA_BASE.
|
java.io.File |
getCatalinaHome()
Obtain the location of CATALINA_HOME.
|
java.lang.String |
getCharset(java.util.Locale locale)
Obtain the character set name to use with the given Locale.
|
Cluster |
getCluster()
Get the Cluster for this container.
|
java.net.URL |
getConfigFile()
Return the URL of the XML descriptor for this context.
|
boolean |
getConfigured()
Return the "correctly configured" flag for this Context.
|
java.lang.String |
getContainerSciFilter()
Obtains the regular expression that specifies which container provided
SCIs should be filtered out and not used for this context.
|
CookieProcessor |
getCookieProcessor()
Obtains the
CookieProcessor that will be used to process cookies
for this Context. |
boolean |
getCookies()
Return the "use cookies for session ids" flag.
|
boolean |
getCrossContext()
Return the "allow crossing servlet contexts" flag.
|
boolean |
getDenyUncoveredHttpMethods()
Return the deny-uncovered-http-methods flag for this web application.
|
boolean |
getDispatchersUseEncodedPaths()
Are paths used in calls to obtain a request dispatcher expected to be
encoded?
|
java.lang.String |
getDisplayName()
Return the display name of this web application.
|
boolean |
getDistributable()
Return the distributable flag for this web application.
|
java.lang.String |
getDocBase()
Return the document root for this Context.
|
protected java.lang.String |
getDomainInternal()
Method implemented by sub-classes to identify the domain in which MBeans
should be registered.
|
int |
getEffectiveMajorVersion()
Return the effective major version of the Servlet spec used by this
context.
|
int |
getEffectiveMinorVersion()
Return the effective minor version of the Servlet spec used by this
context.
|
java.lang.String |
getEncodedPath()
Return the URL encoded context path, using UTF-8.
|
boolean |
getFireRequestListenersOnForwards()
Determine whether or not requests listeners will be fired on forwards for
this Context.
|
boolean |
getIgnoreAnnotations()
Return the boolean on the annotations parsing.
|
InstanceManager |
getInstanceManager()
Get the instance manager associated with this context.
|
JarScanner |
getJarScanner()
Get the Jar Scanner to be used to scan for JAR resources for this
context.
|
JspConfigDescriptor |
getJspConfigDescriptor()
Obtain the JSP configuration for this context.
|
Loader |
getLoader()
Return the Loader with which this Context is associated.
|
boolean |
getLogEffectiveWebXml()
Should the effective web.xml for this context be logged on context start?
|
Log |
getLogger()
Obtain the log to which events for this container should be logged.
|
LoginConfig |
getLoginConfig()
Return the login configuration descriptor for this web application.
|
java.lang.String |
getLogName()
Return the logger name that the container will use.
|
Manager |
getManager()
Return the Manager with which this Context is associated.
|
boolean |
getMapperContextRootRedirectEnabled()
Determines if requests for a web application context root will be
redirected (adding a trailing slash) by the Mapper.
|
boolean |
getMapperDirectoryRedirectEnabled()
Determines if requests for a directory will be redirected (adding a
trailing slash) by the Mapper.
|
java.lang.String |
getMBeanKeyProperties()
Calculate the key properties string to be added to an object's
ObjectName to indicate that it is associated with this container. |
java.lang.String |
getName()
Return a name string (suitable for use by humans) that describes this
Container.
|
NamingResourcesImpl |
getNamingResources()
Return the naming resources associated with this web application.
|
java.lang.Object |
getNamingToken()
Obtain the token necessary for operations on the associated JNDI naming
context.
|
protected java.lang.String |
getObjectNameKeyProperties()
Allow sub-classes to specify the key properties component of the
ObjectName that will be used to register this component. |
boolean |
getOverride()
Return the override flag for this web application.
|
Container |
getParent()
Get the parent container.
|
java.lang.ClassLoader |
getParentClassLoader()
Get the parent class loader.
|
java.lang.String |
getPath()
Return the context path for this web application.
|
boolean |
getPaused()
Is this Context paused whilst it is reloaded?
|
Pipeline |
getPipeline()
Return the Pipeline object that manages the Valves associated with
this Container.
|
boolean |
getPreemptiveAuthentication()
Determines if a user presents authentication credentials, will the
context will process them when the request is for a non-protected
resource.
|
boolean |
getPrivileged()
Return the privileged flag for this web application.
|
java.lang.String |
getPublicId()
Return the public identifier of the deployment descriptor DTD that is
currently being parsed.
|
Realm |
getRealm()
Obtain the Realm with which this Container is associated.
|
java.lang.String |
getRealPath(java.lang.String path)
Return the real path for a given virtual path, if possible; otherwise
return
null . |
boolean |
getReloadable()
Return the reloadable flag for this web application.
|
java.lang.String |
getResourceOnlyServlets()
Obtains the list of Servlets that expect a resource to be present.
|
WebResourceRoot |
getResources()
Return the Resources with which this Context is associated.
|
boolean |
getSendRedirectBody()
Determines if the context is configured to include a response body as
part of a redirect response.
|
ServletContext |
getServletContext()
Return the servlet context for which this Context is a facade.
|
java.lang.String |
getSessionCookieDomain()
Gets the domain to use for session cookies.
|
java.lang.String |
getSessionCookieName()
Gets the name to use for session cookies.
|
java.lang.String |
getSessionCookiePath()
Gets the path to use for session cookies.
|
boolean |
getSessionCookiePathUsesTrailingSlash()
Is a / added to the end of the session cookie path to ensure browsers,
particularly IE, don't send a session cookie for context /foo with
requests intended for context /foobar.
|
int |
getSessionTimeout()
Return the default session timeout (in minutes) for this
web application.
|
int |
getStartStopThreads()
Obtain the number of threads available for starting and stopping any
children associated with this container.
|
boolean |
getSwallowAbortedUploads()
Returns
true if remaining request data will be read
(swallowed) even the request violates a data size constraint. |
boolean |
getSwallowOutput()
Return the value of the swallowOutput flag.
|
ThreadBindingListener |
getThreadBindingListener()
Get the associated ThreadBindingListener.
|
boolean |
getTldValidation()
Will the parsing of *.tld files for this Context be performed by a
validating parser?
|
boolean |
getUseHttpOnly()
Gets the value of the use HttpOnly cookies for session cookies flag.
|
boolean |
getUseRelativeRedirects()
Will HTTP 1.1 and later location headers generated by a call to
HttpServletResponse.sendRedirect(String) use
relative or absolute redirects. |
boolean |
getValidateClientProvidedNewSessionId()
Will client provided session IDs be validated (see
Context.setValidateClientProvidedNewSessionId(boolean) ) before use? |
java.lang.String |
getWebappVersion()
Set the version of this web application - used to differentiate
different versions of the same web application when using parallel
deployment.
|
java.lang.String |
getWrapperClass()
Return the Java class name of the Wrapper implementation used
for servlets registered in this Context.
|
boolean |
getXmlBlockExternal()
Will the parsing of web.xml, web-fragment.xml, *.tld, *.jspx, *.tagx and
tagplugin.xml files for this Context block the use of external entities?
|
boolean |
getXmlNamespaceAware()
Will the parsing of web.xml and web-fragment.xml files for this Context
be performed by a namespace aware parser?
|
boolean |
getXmlValidation()
Will the parsing of web.xml and web-fragment.xml files for this Context
be performed by a validating parser?
|
boolean |
isResourceOnlyServlet(java.lang.String servletName)
Checks the named Servlet to see if it expects a resource to be present.
|
boolean |
isServlet22()
Is this context using version 2.2 of the Servlet spec?
|
void |
logAccess(Request request,
Response response,
long time,
boolean useDefault)
Log a request/response that was destined for this container but has been
handled earlier in the processing chain so that the request/response
still appears in the correct access logs.
|
void |
reload()
Reload this web application, if reloading is supported.
|
void |
removeApplicationListener(java.lang.String listener)
Remove the specified application listener class from the set of
listeners for this application.
|
void |
removeApplicationParameter(java.lang.String name)
Remove the application parameter with the specified name from
the set for this application.
|
void |
removeChild(Container child)
Remove an existing child Container from association with this parent
Container.
|
void |
removeConstraint(SecurityConstraint constraint)
Remove the specified security constraint from this web application.
|
void |
removeContainerListener(ContainerListener listener)
Remove a container event listener from this component.
|
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(java.lang.String listener)
Remove a class name from the set of InstanceListener classes that
will be added to newly created Wrappers.
|
void |
removeMimeMapping(java.lang.String extension)
Remove the MIME mapping for the specified extension, if it exists;
otherwise, no action is taken.
|
void |
removeParameter(java.lang.String name)
Remove the context initialization parameter with the specified
name, if it exists; otherwise, no action is taken.
|
void |
removePostConstructMethod(java.lang.String clazz)
Removes the post construct method definition for the given class, if it
exists; otherwise, no action is taken.
|
void |
removePreDestroyMethod(java.lang.String clazz)
Removes the pre destroy method definition for the given class, if it
exists; otherwise, no action is taken.
|
void |
removePropertyChangeListener(java.beans.PropertyChangeListener listener)
Remove a property change listener from this component.
|
void |
removeRoleMapping(java.lang.String role)
Remove any security role reference for the specified name
|
void |
removeSecurityRole(java.lang.String role)
Remove any security role with the specified name.
|
void |
removeServletMapping(java.lang.String pattern)
Remove any servlet mapping for the specified pattern, if it exists;
otherwise, no action is taken.
|
void |
removeWatchedResource(java.lang.String name)
Remove the specified watched resource name from the list associated
with this Context.
|
void |
removeWelcomeFile(java.lang.String name)
Remove the specified welcome file name from the list recognized
by this Context.
|
void |
removeWrapperLifecycle(java.lang.String listener)
Remove a class name from the set of LifecycleListener classes that
will be added to newly created Wrappers.
|
void |
removeWrapperListener(java.lang.String listener)
Remove a class name from the set of ContainerListener classes that
will be added to newly created Wrappers.
|
void |
setAddWebinfClassesResources(boolean addWebinfClassesResources)
Sets the flag that indicates if /WEB-INF/classes should be treated like
an exploded JAR and JAR resources made available as if they were in a
JAR.
|
void |
setAllowCasualMultipartParsing(boolean allowCasualMultipartParsing)
Set to
true to allow requests mapped to servlets that
do not explicitly declare @MultipartConfig or have
<multipart-config> specified in web.xml to parse
multipart/form-data requests. |
void |
setAllowMultipleLeadingForwardSlashInPath(boolean allowMultipleLeadingForwardSlashInPath)
Configure if, when returning a context path from
HttpServletRequest.getContextPath() , the return value
is allowed to contain multiple leading '/' characters. |
void |
setAltDDName(java.lang.String altDDName)
Set an alternate Deployment Descriptor name.
|
void |
setApplicationEventListeners(java.lang.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(java.lang.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 |
setBackgroundProcessorDelay(int delay)
Set the delay between the invocation of the execute method on this
container and its children.
|
void |
setCluster(Cluster cluster)
Set the Cluster with which this Container is associated.
|
void |
setConfigFile(java.net.URL configFile)
Set the URL of the XML descriptor for this context.
|
void |
setConfigured(boolean configured)
Set the "correctly configured" flag for this Context.
|
void |
setContainerSciFilter(java.lang.String containerSciFilter)
Sets the regular expression that specifies which container provided SCIs
should be filtered out and not used for this context.
|
void |
setCookieProcessor(CookieProcessor cookieProcessor)
Sets the
CookieProcessor that will be used to process cookies
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 |
setDenyUncoveredHttpMethods(boolean denyUncoveredHttpMethods)
Set the deny-uncovered-http-methods flag for this web application.
|
void |
setDispatchersUseEncodedPaths(boolean dispatchersUseEncodedPaths)
Are paths used in calls to obtain a request dispatcher expected to be
encoded?
|
void |
setDisplayName(java.lang.String displayName)
Set the display name of this web application.
|
void |
setDistributable(boolean distributable)
Set the distributable flag for this web application.
|
void |
setDocBase(java.lang.String docBase)
Set the document root for this Context.
|
void |
setEffectiveMajorVersion(int major)
Set the effective major version of the Servlet spec used by this
context.
|
void |
setEffectiveMinorVersion(int minor)
Set the effective minor version of the Servlet spec used by this
context.
|
void |
setFireRequestListenersOnForwards(boolean enable)
Configure whether or not requests listeners will be fired on forwards 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 |
setJarScanner(JarScanner jarScanner)
Set the Jar Scanner to be used to scan for JAR resources for this
context.
|
void |
setJspConfigDescriptor(JspConfigDescriptor descriptor)
Set the JspConfigDescriptor for this context.
|
void |
setLoader(Loader loader)
Set the Loader with which this Context is associated.
|
void |
setLogEffectiveWebXml(boolean logEffectiveWebXml)
Set whether or not the effective web.xml for this context should be
logged on context start.
|
void |
setLoginConfig(LoginConfig config)
Set the login configuration descriptor for this web application.
|
void |
setManager(Manager manager)
Set the Manager with which this Context is associated.
|
void |
setMapperContextRootRedirectEnabled(boolean mapperContextRootRedirectEnabled)
If enabled, requests for a web application context root will be
redirected (adding a trailing slash) by the Mapper.
|
void |
setMapperDirectoryRedirectEnabled(boolean mapperDirectoryRedirectEnabled)
If enabled, requests for a directory will be redirected (adding a
trailing slash) by the Mapper.
|
void |
setName(java.lang.String name)
Set a name string (suitable for use by humans) that describes this
Container.
|
void |
setNamingResources(NamingResourcesImpl namingResources)
Set the naming resources for this web application.
|
void |
setOverride(boolean override)
Set the override flag for this web application.
|
void |
setParent(Container parent)
Set the parent Container to which this Container is being added as a
child.
|
void |
setParentClassLoader(java.lang.ClassLoader parent)
Set the parent class loader for this component.
|
void |
setPath(java.lang.String path)
Set the context path for this web application.
|
void |
setPreemptiveAuthentication(boolean enable)
Configures if a user presents authentication credentials, whether the
context will process them when the request is for a non-protected
resource.
|
void |
setPrivileged(boolean privileged)
Set the privileged flag for this web application.
|
void |
setPublicId(java.lang.String publicId)
Set the public identifier of the deployment descriptor DTD that is
currently being parsed.
|
void |
setRealm(Realm realm)
Set the Realm with which this Container is associated.
|
void |
setReloadable(boolean reloadable)
Set the reloadable flag for this web application.
|
void |
setResourceOnlyServlets(java.lang.String resourceOnlyServlets)
Sets the (comma separated) list of Servlets that expect a resource to be
present.
|
void |
setResources(WebResourceRoot resources)
Set the Resources object with which this Context is associated.
|
void |
setSendRedirectBody(boolean enable)
Configures if a response body is included when a redirect response is
sent to the client.
|
void |
setSessionCookieDomain(java.lang.String sessionCookieDomain)
Sets the domain to use for session cookies.
|
void |
setSessionCookieName(java.lang.String sessionCookieName)
Sets the name to use for session cookies.
|
void |
setSessionCookiePath(java.lang.String sessionCookiePath)
Sets the path to use for session cookies.
|
void |
setSessionCookiePathUsesTrailingSlash(boolean sessionCookiePathUsesTrailingSlash)
Configures if a / is added to the end of the session cookie path to
ensure browsers, particularly IE, don't send a session cookie for context
/foo with requests intended for context /foobar.
|
void |
setSessionTimeout(int timeout)
Set the default session timeout (in minutes) for this
web application.
|
void |
setStartStopThreads(int startStopThreads)
Sets the number of threads available for starting and stopping any
children associated with this container.
|
void |
setSwallowAbortedUploads(boolean swallowAbortedUploads)
Set to
false to disable request data swallowing
after an upload was aborted due to size constraints. |
void |
setSwallowOutput(boolean swallowOutput)
Set the value of the swallowOutput flag.
|
void |
setThreadBindingListener(ThreadBindingListener threadBindingListener)
Get the associated ThreadBindingListener.
|
void |
setTldValidation(boolean tldValidation)
Controls whether the parsing of *.tld files for this Context will be
performed by a validating parser.
|
void |
setUseHttpOnly(boolean useHttpOnly)
Sets the use HttpOnly cookies for session cookies flag.
|
void |
setUseRelativeRedirects(boolean useRelativeRedirects)
Controls whether HTTP 1.1 and later location headers generated by a call
to
HttpServletResponse.sendRedirect(String)
will use relative or absolute redirects. |
void |
setValidateClientProvidedNewSessionId(boolean validateClientProvidedNewSessionId)
When a client provides the ID for a new session, should that ID be
validated?
|
void |
setWebappVersion(java.lang.String webappVersion)
Set the version of this web application - used to differentiate
different versions of the same web application when using parallel
deployment.
|
void |
setWrapperClass(java.lang.String wrapperClass)
Set the Java class name of the Wrapper implementation used
for servlets registered in this Context.
|
void |
setXmlBlockExternal(boolean xmlBlockExternal)
Controls whether the parsing of web.xml, web-fragment.xml, *.tld, *.jspx,
*.tagx and tagplugin.xml files for this Context will block the use of
external entities.
|
void |
setXmlNamespaceAware(boolean xmlNamespaceAware)
Controls whether the parsing of web.xml and web-fragment.xml files for
this Context will be performed by a namespace aware parser.
|
void |
setXmlValidation(boolean xmlValidation)
Controls whether the parsing of web.xml and web-fragment.xml files
for this Context will be performed by a validating parser.
|
protected void |
startInternal()
Sub-classes must ensure that the state is changed to
LifecycleState.STARTING during the execution of this method. |
protected void |
stopInternal()
Sub-classes must ensure that the state is changed to
LifecycleState.STOPPING during the execution of this method. |
java.lang.String |
toString() |
void |
unbind(boolean usePrivilegedAction,
java.lang.ClassLoader originalClassLoader)
Restore the current thread context class loader to the original class
loader in used before
ContextBind.bind(boolean, ClassLoader) was called. |
destroyInternal, getDomain, getObjectName, initInternal, postDeregister, postRegister, preDeregister, preRegister, register, setDomain, unregister
addLifecycleListener, destroy, findLifecycleListeners, fireLifecycleEvent, getState, getStateName, init, removeLifecycleListener, setState, setState, start, stop
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
getDomain, getObjectName
addLifecycleListener, destroy, findLifecycleListeners, getState, getStateName, init, removeLifecycleListener, start, stop
protected static final StringManager sm
public java.net.URL getConfigFile()
Context
getConfigFile
in interface Context
public void setConfigFile(java.net.URL configFile)
Context
setConfigFile
in interface Context
configFile
- The URL of the XML descriptor for this context.public java.lang.String getDocBase()
Context
getDocBase
in interface Context
public void setDocBase(java.lang.String docBase)
Context
setDocBase
in interface Context
docBase
- The new document rootpublic java.lang.String getName()
Container
public void setName(java.lang.String name)
Container
public Container getParent()
Container
public void setParent(Container parent)
Container
public java.lang.String getPath()
Context
public void setPath(java.lang.String path)
Context
public java.lang.String getWebappVersion()
Context
getWebappVersion
in interface Context
public void setWebappVersion(java.lang.String webappVersion)
Context
setWebappVersion
in interface Context
protected java.lang.String getDomainInternal()
LifecycleMBeanBase
getDomainInternal
in class LifecycleMBeanBase
public java.lang.String getMBeanKeyProperties()
Container
ObjectName
to indicate that it is associated with this container.getMBeanKeyProperties
in interface Container
protected java.lang.String getObjectNameKeyProperties()
LifecycleMBeanBase
ObjectName
that will be used to register this component.getObjectNameKeyProperties
in class LifecycleMBeanBase
ObjectName
protected void startInternal() throws LifecycleException
LifecycleBase
LifecycleState.STARTING
during the execution of this method.
Changing state will trigger the Lifecycle.START_EVENT
event.
If a component fails to start it may either throw a
LifecycleException
which will cause it's parent to fail to start
or it can place itself in the error state in which case LifecycleBase.stop()
will be called on the failed component but the parent component will
continue to start normally.startInternal
in class LifecycleBase
LifecycleException
protected void stopInternal() throws LifecycleException
LifecycleBase
LifecycleState.STOPPING
during the execution of this method.
Changing state will trigger the Lifecycle.STOP_EVENT
event.stopInternal
in class LifecycleBase
LifecycleException
public void addWatchedResource(java.lang.String name)
Context
addWatchedResource
in interface Context
name
- Path to the resource, relative to docBasepublic java.lang.String[] findWatchedResources()
Context
findWatchedResources
in interface Context
public void removeWatchedResource(java.lang.String name)
Context
removeWatchedResource
in interface Context
name
- Name of the watched resource to be removedpublic void addChild(Container child)
Container
setParent()
method must be called, with this
Container as an argument. This method may thrown an
IllegalArgumentException
if this Container chooses not
to be attached to the specified Container, in which case it is not addedpublic Container findChild(java.lang.String name)
Container
public Container[] findChildren()
Container
findChildren
in interface Container
public void removeChild(Container child)
Container
removeChild
in interface Container
child
- Existing child Container to be removedpublic java.lang.String toString()
toString
in class java.lang.Object
public Loader getLoader()
Context
public void setLoader(Loader loader)
Context
public Log getLogger()
Container
public java.lang.String getLogName()
Container
getLogName
in interface Container
public Manager getManager()
Context
null
.getManager
in interface Context
public void setManager(Manager manager)
Context
setManager
in interface Context
manager
- The newly associated Managerpublic Pipeline getPipeline()
Container
getPipeline
in interface Container
public Cluster getCluster()
Container
getCluster
in interface Container
null
.public void setCluster(Cluster cluster)
Container
setCluster
in interface Container
cluster
- the Cluster with which this Container is associated.public int getBackgroundProcessorDelay()
Container
Container.backgroundProcess()
method on this container and all
children with non-positive delay values.getBackgroundProcessorDelay
in interface Container
public void setBackgroundProcessorDelay(int delay)
Container
setBackgroundProcessorDelay
in interface Container
delay
- The delay in seconds between the invocation of
backgroundProcess methodspublic java.lang.ClassLoader getParentClassLoader()
Container
getParentClassLoader
in interface Container
Container.getParent()
.Container.getParentClassLoader()
. If no
parent has been set, return the system class loader.public void setParentClassLoader(java.lang.ClassLoader parent)
Container
Context
s
this call is meaningful only before a Loader has
been configured, and the specified value (if non-null) should be
passed as an argument to the class loader constructor.setParentClassLoader
in interface Container
parent
- The new parent class loaderpublic Realm getRealm()
Container
public void setRealm(Realm realm)
Container
public WebResourceRoot getResources()
Context
getResources
in interface Context
public void setResources(WebResourceRoot resources)
Context
setResources
in interface Context
resources
- The newly associated Resourcespublic void backgroundProcess()
Container
backgroundProcess
in interface Container
public void addContainerListener(ContainerListener listener)
Container
addContainerListener
in interface Container
listener
- The listener to addpublic ContainerListener[] findContainerListeners()
Container
findContainerListeners
in interface Container
public void removeContainerListener(ContainerListener listener)
Container
removeContainerListener
in interface Container
listener
- The listener to removepublic void addPropertyChangeListener(java.beans.PropertyChangeListener listener)
Container
addPropertyChangeListener
in interface Container
listener
- The listener to addpublic void removePropertyChangeListener(java.beans.PropertyChangeListener listener)
Container
removePropertyChangeListener
in interface Container
listener
- The listener to removepublic void fireContainerEvent(java.lang.String type, java.lang.Object data)
Container
fireContainerEvent
in interface Container
type
- Event typedata
- Event datapublic void logAccess(Request request, Response response, long time, boolean useDefault)
Container
logAccess
in interface Container
request
- Request (associated with the response) to logresponse
- Response (associated with the request) to logtime
- Time taken to process the request/response in
milliseconds (use 0 if not known)useDefault
- Flag that indicates that the request/response should
be logged in the engine's default access logpublic AccessLog getAccessLog()
Container
getAccessLog
in interface Container
public int getStartStopThreads()
Container
getStartStopThreads
in interface Container
public void setStartStopThreads(int startStopThreads)
Container
setStartStopThreads
in interface Container
startStopThreads
- The new number of threads to be usedpublic boolean getAllowCasualMultipartParsing()
Context
true
if requests mapped to servlets without
"multipart config" to parse multipart/form-data requests anyway.getAllowCasualMultipartParsing
in interface Context
true
if requests mapped to servlets without
"multipart config" to parse multipart/form-data requests,
false
otherwise.public void setAllowCasualMultipartParsing(boolean allowCasualMultipartParsing)
Context
true
to allow requests mapped to servlets that
do not explicitly declare @MultipartConfig or have
<multipart-config> specified in web.xml to parse
multipart/form-data requests.setAllowCasualMultipartParsing
in interface Context
allowCasualMultipartParsing
- true
to allow such
casual parsing, false
otherwise.public java.lang.Object[] getApplicationEventListeners()
Context
getApplicationEventListeners
in interface Context
public void setApplicationEventListeners(java.lang.Object[] listeners)
Context
setApplicationEventListeners
in interface Context
listeners
- The set of instantiated listener objects.public java.lang.Object[] getApplicationLifecycleListeners()
Context
getApplicationLifecycleListeners
in interface Context
public void setApplicationLifecycleListeners(java.lang.Object[] listeners)
Context
setApplicationLifecycleListeners
in interface Context
listeners
- The set of instantiated listener objects.public java.lang.String getCharset(java.util.Locale locale)
Context
getCharset
in interface Context
locale
- The locale for which the mapped character set should be
returnedpublic boolean getConfigured()
Context
getConfigured
in interface Context
true
if the Context has been correctly configured,
otherwise false
public void setConfigured(boolean configured)
Context
setConfigured
in interface Context
configured
- The new correctly configured flagpublic boolean getCookies()
Context
getCookies
in interface Context
true
if it is permitted to use cookies to track
session IDs for this web application, otherwise
false
public void setCookies(boolean cookies)
Context
setCookies
in interface Context
cookies
- The new flagpublic java.lang.String getSessionCookieName()
Context
getSessionCookieName
in interface Context
public void setSessionCookieName(java.lang.String sessionCookieName)
Context
setSessionCookieName
in interface Context
sessionCookieName
- The name to usepublic boolean getUseHttpOnly()
Context
getUseHttpOnly
in interface Context
true
if the HttpOnly flag should be set on session
cookiespublic void setUseHttpOnly(boolean useHttpOnly)
Context
setUseHttpOnly
in interface Context
useHttpOnly
- Set to true
to use HttpOnly cookies
for session cookiespublic java.lang.String getSessionCookieDomain()
Context
getSessionCookieDomain
in interface Context
public void setSessionCookieDomain(java.lang.String sessionCookieDomain)
Context
setSessionCookieDomain
in interface Context
sessionCookieDomain
- The domain to usepublic java.lang.String getSessionCookiePath()
Context
getSessionCookiePath
in interface Context
public void setSessionCookiePath(java.lang.String sessionCookiePath)
Context
setSessionCookiePath
in interface Context
sessionCookiePath
- The path to usepublic boolean getSessionCookiePathUsesTrailingSlash()
Context
getSessionCookiePathUsesTrailingSlash
in interface Context
true
if the slash is added, otherwise
false
public void setSessionCookiePathUsesTrailingSlash(boolean sessionCookiePathUsesTrailingSlash)
Context
setSessionCookiePathUsesTrailingSlash
in interface Context
sessionCookiePathUsesTrailingSlash
- true
if the
slash is should be added,
otherwise false
public boolean getCrossContext()
Context
getCrossContext
in interface Context
true
if cross-contest requests are allowed from this
web applications, otherwise false
public void setCrossContext(boolean crossContext)
Context
setCrossContext
in interface Context
crossContext
- The new cross contexts flagpublic java.lang.String getAltDDName()
Context
getAltDDName
in interface Context
public void setAltDDName(java.lang.String altDDName)
Context
setAltDDName
in interface Context
public boolean getDenyUncoveredHttpMethods()
Context
getDenyUncoveredHttpMethods
in interface Context
public void setDenyUncoveredHttpMethods(boolean denyUncoveredHttpMethods)
Context
setDenyUncoveredHttpMethods
in interface Context
denyUncoveredHttpMethods
- The new deny-uncovered-http-methods flagpublic java.lang.String getDisplayName()
Context
getDisplayName
in interface Context
public void setDisplayName(java.lang.String displayName)
Context
setDisplayName
in interface Context
displayName
- The new display namepublic boolean getDistributable()
Context
getDistributable
in interface Context
public void setDistributable(boolean distributable)
Context
setDistributable
in interface Context
distributable
- The new distributable flagpublic java.lang.String getEncodedPath()
Context
getEncodedPath
in interface Context
public boolean getIgnoreAnnotations()
Context
getIgnoreAnnotations
in interface Context
public void setIgnoreAnnotations(boolean ignoreAnnotations)
Context
setIgnoreAnnotations
in interface Context
ignoreAnnotations
- The boolean on the annotations parsingpublic LoginConfig getLoginConfig()
Context
getLoginConfig
in interface Context
public void setLoginConfig(LoginConfig config)
Context
setLoginConfig
in interface Context
config
- The new login configurationpublic NamingResourcesImpl getNamingResources()
Context
getNamingResources
in interface Context
public void setNamingResources(NamingResourcesImpl namingResources)
Context
setNamingResources
in interface Context
namingResources
- The new naming resourcespublic java.lang.String getPublicId()
Context
getPublicId
in interface Context
public void setPublicId(java.lang.String publicId)
Context
setPublicId
in interface Context
publicId
- The public identifierpublic boolean getReloadable()
Context
getReloadable
in interface Context
public void setReloadable(boolean reloadable)
Context
setReloadable
in interface Context
reloadable
- The new reloadable flagpublic boolean getOverride()
Context
getOverride
in interface Context
public void setOverride(boolean override)
Context
setOverride
in interface Context
override
- The new override flagpublic boolean getPrivileged()
Context
getPrivileged
in interface Context
public void setPrivileged(boolean privileged)
Context
setPrivileged
in interface Context
privileged
- The new privileged flagpublic ServletContext getServletContext()
Context
getServletContext
in interface Context
public int getSessionTimeout()
Context
getSessionTimeout
in interface Context
public void setSessionTimeout(int timeout)
Context
setSessionTimeout
in interface Context
timeout
- The new default session timeoutpublic boolean getSwallowAbortedUploads()
Context
true
if remaining request data will be read
(swallowed) even the request violates a data size constraint.getSwallowAbortedUploads
in interface Context
true
if data will be swallowed (default),
false
otherwise.public void setSwallowAbortedUploads(boolean swallowAbortedUploads)
Context
false
to disable request data swallowing
after an upload was aborted due to size constraints.setSwallowAbortedUploads
in interface Context
swallowAbortedUploads
- false
to disable
swallowing, true
otherwise (default).public boolean getSwallowOutput()
Context
getSwallowOutput
in interface Context
public void setSwallowOutput(boolean swallowOutput)
Context
setSwallowOutput
in interface Context
swallowOutput
- The new valuepublic java.lang.String getWrapperClass()
Context
getWrapperClass
in interface Context
public void setWrapperClass(java.lang.String wrapperClass)
Context
setWrapperClass
in interface Context
wrapperClass
- The new wrapper classpublic boolean getXmlNamespaceAware()
Context
getXmlNamespaceAware
in interface Context
public void setXmlNamespaceAware(boolean xmlNamespaceAware)
Context
setXmlNamespaceAware
in interface Context
xmlNamespaceAware
- true to enable namespace awarenesspublic boolean getXmlValidation()
Context
getXmlValidation
in interface Context
public void setXmlValidation(boolean xmlValidation)
Context
setXmlValidation
in interface Context
xmlValidation
- true to enable xml validationpublic boolean getXmlBlockExternal()
Context
getXmlBlockExternal
in interface Context
public void setXmlBlockExternal(boolean xmlBlockExternal)
Context
setXmlBlockExternal
in interface Context
xmlBlockExternal
- true to block external entitiespublic boolean getTldValidation()
Context
getTldValidation
in interface Context
public void setTldValidation(boolean tldValidation)
Context
setTldValidation
in interface Context
tldValidation
- true to enable xml validationpublic JarScanner getJarScanner()
Context
getJarScanner
in interface Context
public void setJarScanner(JarScanner jarScanner)
Context
setJarScanner
in interface Context
jarScanner
- The Jar Scanner to be used for this context.public Authenticator getAuthenticator()
Context
Authenticator
that is used by this context or
null
if none is used.getAuthenticator
in interface Context
public void setLogEffectiveWebXml(boolean logEffectiveWebXml)
Context
setLogEffectiveWebXml
in interface Context
public boolean getLogEffectiveWebXml()
Context
getLogEffectiveWebXml
in interface Context
public void addApplicationListener(java.lang.String listener)
Context
addApplicationListener
in interface Context
listener
- Java class name of a listener classpublic java.lang.String[] findApplicationListeners()
Context
findApplicationListeners
in interface Context
public void removeApplicationListener(java.lang.String listener)
Context
removeApplicationListener
in interface Context
listener
- Java class name of the listener to be removedpublic void addApplicationParameter(ApplicationParameter parameter)
Context
addApplicationParameter
in interface Context
parameter
- The new application parameterpublic ApplicationParameter[] findApplicationParameters()
Context
findApplicationParameters
in interface Context
public void removeApplicationParameter(java.lang.String name)
Context
removeApplicationParameter
in interface Context
name
- Name of the application parameter to removepublic void addConstraint(SecurityConstraint constraint)
Context
addConstraint
in interface Context
public SecurityConstraint[] findConstraints()
Context
findConstraints
in interface Context
public void removeConstraint(SecurityConstraint constraint)
Context
removeConstraint
in interface Context
constraint
- Constraint to be removedpublic void addErrorPage(ErrorPage errorPage)
Context
addErrorPage
in interface Context
errorPage
- The error page definition to be addedpublic ErrorPage findErrorPage(int errorCode)
Context
null
.findErrorPage
in interface Context
errorCode
- Error code to look uppublic ErrorPage findErrorPage(java.lang.String exceptionType)
Context
null
.findErrorPage
in interface Context
exceptionType
- Exception type to look uppublic ErrorPage[] findErrorPages()
Context
findErrorPages
in interface Context
public void removeErrorPage(ErrorPage errorPage)
Context
removeErrorPage
in interface Context
errorPage
- The error page definition to be removedpublic void addFilterDef(FilterDef filterDef)
Context
addFilterDef
in interface Context
filterDef
- The filter definition to be addedpublic FilterDef findFilterDef(java.lang.String filterName)
Context
null
.findFilterDef
in interface Context
filterName
- Filter name to look uppublic FilterDef[] findFilterDefs()
Context
findFilterDefs
in interface Context
public void removeFilterDef(FilterDef filterDef)
Context
removeFilterDef
in interface Context
filterDef
- Filter definition to be removedpublic void addFilterMap(FilterMap filterMap)
Context
addFilterMap
in interface Context
filterMap
- The filter mapping to be addedpublic void addFilterMapBefore(FilterMap filterMap)
Context
addFilterMapBefore
in interface Context
filterMap
- The filter mapping to be addedpublic FilterMap[] findFilterMaps()
Context
findFilterMaps
in interface Context
public void removeFilterMap(FilterMap filterMap)
Context
removeFilterMap
in interface Context
filterMap
- The filter mapping to be removedpublic void addInstanceListener(java.lang.String listener)
Context
addInstanceListener
in interface Context
listener
- Java class name of an InstanceListener classpublic java.lang.String[] findInstanceListeners()
Context
findInstanceListeners
in interface Context
public void removeInstanceListener(java.lang.String listener)
Context
removeInstanceListener
in interface Context
listener
- Class name of an InstanceListener class to be removedpublic void addLocaleEncodingMappingParameter(java.lang.String locale, java.lang.String encoding)
Context
addLocaleEncodingMappingParameter
in interface Context
locale
- locale to map an encoding forencoding
- encoding to be used for a give localepublic void addMimeMapping(java.lang.String extension, java.lang.String mimeType)
Context
addMimeMapping
in interface Context
extension
- Filename extension being mappedmimeType
- Corresponding MIME typepublic java.lang.String findMimeMapping(java.lang.String extension)
Context
null
.findMimeMapping
in interface Context
extension
- Extension to map to a MIME typepublic java.lang.String[] findMimeMappings()
Context
findMimeMappings
in interface Context
public void removeMimeMapping(java.lang.String extension)
Context
removeMimeMapping
in interface Context
extension
- Extension to remove the mapping forpublic void addParameter(java.lang.String name, java.lang.String value)
Context
addParameter
in interface Context
name
- Name of the new parametervalue
- Value of the new parameterpublic java.lang.String findParameter(java.lang.String name)
Context
null
.findParameter
in interface Context
name
- Name of the parameter to returnpublic java.lang.String[] findParameters()
Context
findParameters
in interface Context
public void removeParameter(java.lang.String name)
Context
removeParameter
in interface Context
name
- Name of the parameter to removepublic void addRoleMapping(java.lang.String role, java.lang.String link)
Context
addRoleMapping
in interface Context
role
- Security role used in the applicationlink
- Actual security role to check forpublic java.lang.String findRoleMapping(java.lang.String role)
Context
findRoleMapping
in interface Context
role
- Security role to mappublic void removeRoleMapping(java.lang.String role)
Context
removeRoleMapping
in interface Context
role
- Security role (as used in the application) to removepublic void addSecurityRole(java.lang.String role)
Context
addSecurityRole
in interface Context
role
- New security rolepublic boolean findSecurityRole(java.lang.String role)
Context
true
if the specified security role is defined
for this application; otherwise return false
.findSecurityRole
in interface Context
role
- Security role to verifypublic java.lang.String[] findSecurityRoles()
Context
findSecurityRoles
in interface Context
public void removeSecurityRole(java.lang.String role)
Context
removeSecurityRole
in interface Context
role
- Security role to removepublic void addServletMapping(java.lang.String pattern, java.lang.String name)
Context
addServletMapping
in interface Context
pattern
- URL pattern to be mapped. The pattern will be % decoded
using UTF-8name
- Name of the corresponding servlet to executepublic void addServletMapping(java.lang.String pattern, java.lang.String name, boolean jspWildcard)
Context
addServletMapping
in interface Context
pattern
- URL pattern to be mapped. The pattern will be %
decoded using UTF-8name
- Name of the corresponding servlet to executejspWildcard
- true if name identifies the JspServlet and pattern
contains a wildcard; false otherwisepublic void addServletMappingDecoded(java.lang.String pattern, java.lang.String name)
Context
addServletMappingDecoded
in interface Context
pattern
- URL pattern to be mappedname
- Name of the corresponding servlet to executepublic void addServletMappingDecoded(java.lang.String pattern, java.lang.String name, boolean jspWildcard)
Context
addServletMappingDecoded
in interface Context
pattern
- URL pattern to be mappedname
- Name of the corresponding servlet to executejspWildcard
- true if name identifies the JspServlet
and pattern contains a wildcard; false otherwisepublic java.lang.String findServletMapping(java.lang.String pattern)
Context
null
.findServletMapping
in interface Context
pattern
- Pattern for which a mapping is requestedpublic java.lang.String[] findServletMappings()
Context
findServletMappings
in interface Context
public void removeServletMapping(java.lang.String pattern)
Context
removeServletMapping
in interface Context
pattern
- URL pattern of the mapping to removepublic void addWelcomeFile(java.lang.String name)
Context
addWelcomeFile
in interface Context
name
- New welcome file namepublic boolean findWelcomeFile(java.lang.String name)
Context
true
if the specified welcome file is defined
for this Context; otherwise return false
.findWelcomeFile
in interface Context
name
- Welcome file to verifypublic java.lang.String[] findWelcomeFiles()
Context
findWelcomeFiles
in interface Context
public void removeWelcomeFile(java.lang.String name)
Context
removeWelcomeFile
in interface Context
name
- Name of the welcome file to be removedpublic void addWrapperLifecycle(java.lang.String listener)
Context
addWrapperLifecycle
in interface Context
listener
- Java class name of a LifecycleListener classpublic java.lang.String[] findWrapperLifecycles()
Context
findWrapperLifecycles
in interface Context
public void removeWrapperLifecycle(java.lang.String listener)
Context
removeWrapperLifecycle
in interface Context
listener
- Class name of a LifecycleListener class to be removedpublic void addWrapperListener(java.lang.String listener)
Context
addWrapperListener
in interface Context
listener
- Java class name of a ContainerListener classpublic java.lang.String[] findWrapperListeners()
Context
findWrapperListeners
in interface Context
public void removeWrapperListener(java.lang.String listener)
Context
removeWrapperListener
in interface Context
listener
- Class name of a ContainerListener class to be removedpublic Wrapper createWrapper()
Context
createWrapper
in interface Context
public java.lang.String findStatusPage(int status)
Context
null
.findStatusPage
in interface Context
status
- HTTP status code to look uppublic int[] findStatusPages()
Context
findStatusPages
in interface Context
public boolean fireRequestInitEvent(ServletRequest request)
Context
ServletRequestListener
s that a request
has started.fireRequestInitEvent
in interface Context
true
if the listeners fire successfully, else
false
public boolean fireRequestDestroyEvent(ServletRequest request)
Context
ServletRequestListener
s that a request
has ended.fireRequestDestroyEvent
in interface Context
true
if the listeners fire successfully, else
false
public void reload()
Context
public java.lang.String getRealPath(java.lang.String path)
Context
null
.getRealPath
in interface Context
path
- The path to the desired resourcepublic int getEffectiveMajorVersion()
Context
getEffectiveMajorVersion
in interface Context
public void setEffectiveMajorVersion(int major)
Context
setEffectiveMajorVersion
in interface Context
public int getEffectiveMinorVersion()
Context
getEffectiveMinorVersion
in interface Context
public void setEffectiveMinorVersion(int minor)
Context
setEffectiveMinorVersion
in interface Context
public JspConfigDescriptor getJspConfigDescriptor()
Context
getJspConfigDescriptor
in interface Context
public void setJspConfigDescriptor(JspConfigDescriptor descriptor)
Context
setJspConfigDescriptor
in interface Context
public void addServletContainerInitializer(ServletContainerInitializer sci, java.util.Set<java.lang.Class<?>> classes)
Context
addServletContainerInitializer
in interface Context
sci
- The instance to addclasses
- The classes in which the initializer expressed an
interestpublic boolean getPaused()
Context
public boolean isServlet22()
Context
isServlet22
in interface Context
public java.util.Set<java.lang.String> addServletSecurity(ServletRegistration.Dynamic registration, ServletSecurityElement servletSecurityElement)
Context
ServletRegistration.Dynamic
addServletSecurity
in interface Context
registration
- servlet security was modified forservletSecurityElement
- new security constraints for this servletpublic void setResourceOnlyServlets(java.lang.String resourceOnlyServlets)
Context
setResourceOnlyServlets
in interface Context
public java.lang.String getResourceOnlyServlets()
Context
getResourceOnlyServlets
in interface Context
public boolean isResourceOnlyServlet(java.lang.String servletName)
Context
isResourceOnlyServlet
in interface Context
servletName
- Name of the Servlet (as per web.xml) to checktrue
if the Servlet expects a resource,
otherwise false
public java.lang.String getBaseName()
Context
getBaseName
in interface Context
public void setFireRequestListenersOnForwards(boolean enable)
Context
setFireRequestListenersOnForwards
in interface Context
public boolean getFireRequestListenersOnForwards()
Context
getFireRequestListenersOnForwards
in interface Context
public void setPreemptiveAuthentication(boolean enable)
Context
setPreemptiveAuthentication
in interface Context
public boolean getPreemptiveAuthentication()
Context
getPreemptiveAuthentication
in interface Context
public void setSendRedirectBody(boolean enable)
Context
setSendRedirectBody
in interface Context
public boolean getSendRedirectBody()
Context
getSendRedirectBody
in interface Context
public void addValve(Valve valve)
public java.io.File getCatalinaBase()
Container
getCatalinaBase
in interface Container
public java.io.File getCatalinaHome()
Container
getCatalinaHome
in interface Container
public void setAddWebinfClassesResources(boolean addWebinfClassesResources)
Context
setAddWebinfClassesResources
in interface Context
addWebinfClassesResources
- The new value for the flagpublic boolean getAddWebinfClassesResources()
Context
getAddWebinfClassesResources
in interface Context
public void addPostConstructMethod(java.lang.String clazz, java.lang.String method)
Context
addPostConstructMethod
in interface Context
clazz
- Fully qualified class namemethod
- Post construct method namepublic void addPreDestroyMethod(java.lang.String clazz, java.lang.String method)
Context
addPreDestroyMethod
in interface Context
clazz
- Fully qualified class namemethod
- Post construct method namepublic void removePostConstructMethod(java.lang.String clazz)
Context
removePostConstructMethod
in interface Context
clazz
- Fully qualified class namepublic void removePreDestroyMethod(java.lang.String clazz)
Context
removePreDestroyMethod
in interface Context
clazz
- Fully qualified class namepublic java.lang.String findPostConstructMethod(java.lang.String clazz)
Context
NULL
will be
returned.findPostConstructMethod
in interface Context
clazz
- Fully qualified class nameNULL
will
be returned.public java.lang.String findPreDestroyMethod(java.lang.String clazz)
Context
NULL
will be returned.findPreDestroyMethod
in interface Context
clazz
- Fully qualified class nameNULL
will be
returned.public java.util.Map<java.lang.String,java.lang.String> findPostConstructMethods()
Context
findPostConstructMethods
in interface Context
public java.util.Map<java.lang.String,java.lang.String> findPreDestroyMethods()
Context
findPreDestroyMethods
in interface Context
public InstanceManager getInstanceManager()
Context
getInstanceManager
in interface Context
public void setInstanceManager(InstanceManager instanceManager)
Context
setInstanceManager
in interface Context
public void setContainerSciFilter(java.lang.String containerSciFilter)
Context
Matcher.find()
so the regular expression only has
to match a sub-string of the fully qualified class name of the container
provided SCI for it to be filtered out.setContainerSciFilter
in interface Context
containerSciFilter
- The regular expression against which the fully
qualified class name of each container provided
SCI should be checkedpublic java.lang.String getContainerSciFilter()
Context
Matcher.find()
so the regular expression only has
to match a sub-string of the fully qualified class name of the container
provided SCI for it to be filtered out.getContainerSciFilter
in interface Context
public ThreadBindingListener getThreadBindingListener()
Context
getThreadBindingListener
in interface Context
public void setThreadBindingListener(ThreadBindingListener threadBindingListener)
Context
setThreadBindingListener
in interface Context
public java.lang.ClassLoader bind(boolean usePrivilegedAction, java.lang.ClassLoader originalClassLoader)
ContextBind
ThreadBindingListener
is configured then
ThreadBindingListener.bind()
will be called
after the change has been made.bind
in interface ContextBind
usePrivilegedAction
- Should a PrivilegedAction
be used when
obtaining the current thread context class loader and setting
the new one?originalClassLoader
- The current class loader if known to save this method having to
look it uppublic void unbind(boolean usePrivilegedAction, java.lang.ClassLoader originalClassLoader)
ContextBind
ContextBind.bind(boolean, ClassLoader)
was called. If
no original class loader is passed to this method then no change will be
made. If the class loader is changed and a
ThreadBindingListener
is configured then
ThreadBindingListener.unbind()
will be called
before the change is made.unbind
in interface ContextBind
usePrivilegedAction
- Should a PrivilegedAction
be used when
setting the current thread context class loader?originalClassLoader
- The class loader to restore as the thread context class loaderpublic java.lang.Object getNamingToken()
Context
getNamingToken
in interface Context
public void setCookieProcessor(CookieProcessor cookieProcessor)
Context
CookieProcessor
that will be used to process cookies
for this Context.setCookieProcessor
in interface Context
cookieProcessor
- The new cookie processorpublic CookieProcessor getCookieProcessor()
Context
CookieProcessor
that will be used to process cookies
for this Context.getCookieProcessor
in interface Context
public void setValidateClientProvidedNewSessionId(boolean validateClientProvidedNewSessionId)
Context
/
setValidateClientProvidedNewSessionId
in interface Context
validateClientProvidedNewSessionId
- true
if validation should be appliedpublic boolean getValidateClientProvidedNewSessionId()
Context
Context.setValidateClientProvidedNewSessionId(boolean)
) before use?getValidateClientProvidedNewSessionId
in interface Context
true
if validation will be applied. Otherwise, false
public void setMapperContextRootRedirectEnabled(boolean mapperContextRootRedirectEnabled)
Context
setMapperContextRootRedirectEnabled
in interface Context
mapperContextRootRedirectEnabled
- Should the redirects be enabled?public boolean getMapperContextRootRedirectEnabled()
Context
getMapperContextRootRedirectEnabled
in interface Context
true
if the Mapper level redirect is enabled for this
Context.public void setMapperDirectoryRedirectEnabled(boolean mapperDirectoryRedirectEnabled)
Context
setMapperDirectoryRedirectEnabled
in interface Context
mapperDirectoryRedirectEnabled
- Should the redirects be enabled?public boolean getMapperDirectoryRedirectEnabled()
Context
getMapperDirectoryRedirectEnabled
in interface Context
true
if the Mapper level redirect is enabled for this
Context.public void setUseRelativeRedirects(boolean useRelativeRedirects)
Context
HttpServletResponse.sendRedirect(String)
will use relative or absolute redirects.
Relative redirects are more efficient but may not work with reverse proxies that change the context path. It should be noted that it is not recommended to use a reverse proxy to change the context path because of the multiple issues it creates.
Absolute redirects should work with reverse proxies that change the
context path but may cause issues with the
RemoteIpFilter
if the filter is
changing the scheme and/or port.
setUseRelativeRedirects
in interface Context
useRelativeRedirects
- true
to use relative redirects and
false
to use absolute redirectspublic boolean getUseRelativeRedirects()
Context
HttpServletResponse.sendRedirect(String)
use
relative or absolute redirects.getUseRelativeRedirects
in interface Context
true
if relative redirects will be used false
if
absolute redirects are used.Context.setUseRelativeRedirects(boolean)
public void setDispatchersUseEncodedPaths(boolean dispatchersUseEncodedPaths)
Context
setDispatchersUseEncodedPaths
in interface Context
dispatchersUseEncodedPaths
- true
to use encoded paths,
otherwise false
public boolean getDispatchersUseEncodedPaths()
Context
getDispatchersUseEncodedPaths
in interface Context
true
if encoded paths will be used, otherwise
false
public void setAllowMultipleLeadingForwardSlashInPath(boolean allowMultipleLeadingForwardSlashInPath)
Context
HttpServletRequest.getContextPath()
, the return value
is allowed to contain multiple leading '/' characters.setAllowMultipleLeadingForwardSlashInPath
in interface Context
allowMultipleLeadingForwardSlashInPath
- The new value for the flagpublic boolean getAllowMultipleLeadingForwardSlashInPath()
Context
HttpServletRequest.getContextPath()
, is it allowed to
contain multiple leading '/' characters?getAllowMultipleLeadingForwardSlashInPath
in interface Context
true
if multiple leading '/' characters are allowed,
otherwise false
Copyright © 2000-2018 Apache Software Foundation. All Rights Reserved.