public class ServletContextWrapper extends Object implements javax.servlet.ServletContext
Modifier and Type | Class and Description |
---|---|
class |
ServletContextWrapper.ServletContextMapListener
Inner class: A listener to listen to the clustered servlet context attributes and make those same changes to the local ServletContext.
|
Constructor and Description |
---|
ServletContextWrapper(SessionHelper helper, javax.servlet.ServletContext ctx)
Construct a Coherence ServletContext that will optionally provide clustered storage for ServletContext attributes.
|
Modifier and Type | Method and Description |
---|---|
protected void |
ensureCluster()
Ensure that the cluster setup for context attributes is done.
|
boolean |
equals(Object obj)
Indicates whether some other object is "equal to" this one.
|
Object |
getAttribute(String sName)
Returns the servlet container attribute with the given name, or null if there is no attribute by that name.
|
protected NamedCache |
getAttributeMap()
Get the clustered attribute map.
|
Enumeration |
getAttributeNames()
Returns an Enumeration containing the attribute names available within this servlet context.
|
javax.servlet.ServletContext |
getContext(String sUriPath)
Returns a ServletContext object that corresponds to a specified URL on the server.
|
String |
getContextPath()
Returns the context path of the web application, if available.
|
protected String |
getDescription()
Returns a string representation of this object's attributes.
|
String |
getInitParameter(String sName)
Returns a String containing the value of the named context-wide initialization parameter, or null if the parameter does not exist.
|
Enumeration |
getInitParameterNames()
Returns the names of the context's initialization parameters as an Enumeration of String objects, or an empty Enumeration if the context has no initialization parameters.
|
int |
getMajorVersion()
Returns the major version of the Java Servlet API that this servlet container supports.
|
String |
getMimeType(String sFile)
Returns the MIME type of the specified file, or null if the MIME type is not known.
|
int |
getMinorVersion()
Returns the minor version of the Servlet API that this servlet container supports.
|
javax.servlet.RequestDispatcher |
getNamedDispatcher(String sName)
Returns a RequestDispatcher object that acts as a wrapper for the named servlet.
|
String |
getRealPath(String sPath)
Returns a String containing the real path for a given virtual path.
|
javax.servlet.RequestDispatcher |
getRequestDispatcher(String sPath)
Returns a RequestDispatcher object that acts as a wrapper for the resource located at the given path.
|
URL |
getResource(String sPath)
Returns a URL to the resource that is mapped to a specified path.
|
InputStream |
getResourceAsStream(String sPath)
Returns the resource located at the named path as an InputStream object.
|
Set |
getResourcePaths(String sPath)
Returns a directory-like listing of all the paths to resources within the web application whose longest sub-path matches the supplied path argument.
|
String |
getServerInfo()
Returns the name and version of the servlet container on which the servlet is running.
|
javax.servlet.Servlet |
getServlet(String sName)
Deprecated.
As of Java Servlet API 2.1, with no direct replacement.
|
protected javax.servlet.ServletContext |
getServletContext()
Get the application server's ServletContext.
|
String |
getServletContextName()
Returns the name of this web application correponding to this ServletContext as specified in the deployment descriptor for this web application by the display-name element.
|
Enumeration |
getServletNames()
Deprecated.
As of Java Servlet API 2.1, with no replacement.
|
Enumeration |
getServlets()
Deprecated.
As of Java Servlet API 2.0, with no replacement.
|
protected SessionHelper |
getSessionHelper()
Get the SessionHelper for this ServletContext wrapper.
|
int |
hashCode()
Returns a hash code value for the object.
|
protected MapListener |
instantiateServletContextMapListener()
Factory method: Instantiate a listener to listen to the clustered servlet context attributes and make those same changes to the local ServletContext.
|
protected boolean |
isClustered()
Determine if the context clusters attributes.
|
void |
log(Exception e, String sMsg)
Deprecated.
As of Java Servlet API 2.1, use
log(String, Throwable) instead. |
void |
log(String sMsg)
Writes the specified message to a servlet log file, usually an event log.
|
void |
log(String sMsg, Throwable e)
Writes an explanatory message and a stack trace for a given Throwable exception to the servlet log file.
|
void |
removeAttribute(String sName)
Removes the attribute with the given name from the servlet context.
|
void |
setAttribute(String sName, Object oValue)
Binds an object to a given attribute name in this servlet context.
|
String |
toString()
Returns a string representation of the object.
|
public ServletContextWrapper(SessionHelper helper, javax.servlet.ServletContext ctx)
helper
- the application's session helperctx
- the application server's ServletContext objectpublic Object getAttribute(String sName)
getAttribute
in interface javax.servlet.ServletContext
sName
- a String specifying the name of the attributepublic Enumeration getAttributeNames()
getAttributeNames
in interface javax.servlet.ServletContext
public javax.servlet.ServletContext getContext(String sUriPath)
This method allows servlets to gain access to the context for various parts of the server, and as needed obtain RequestDispatcher objects from the context. The given path must be begin with "/", is interpreted relative to the server's document root and is matched against the context roots of other web applications hosted on this container.
In a security conscious environment, the servlet container may return null for a given URL.
getContext
in interface javax.servlet.ServletContext
sUriPath
- a String specifying the context path of another web application in the containerpublic String getInitParameter(String sName)
This method can make available configuration information useful to an entire "web application". For example, it can provide a webmaster's email address or the name of a system that holds critical data.
getInitParameter
in interface javax.servlet.ServletContext
sName
- a String containing the name of the parameter whose value is requestedpublic Enumeration getInitParameterNames()
getInitParameterNames
in interface javax.servlet.ServletContext
public int getMajorVersion()
getMajorVersion
in interface javax.servlet.ServletContext
public String getMimeType(String sFile)
getMimeType
in interface javax.servlet.ServletContext
sFile
- a String specifying the name of a filepublic int getMinorVersion()
getMinorVersion
in interface javax.servlet.ServletContext
public javax.servlet.RequestDispatcher getNamedDispatcher(String sName)
Servlets (and JSP pages also) may be given names via server administration or via a web application deployment descriptor. A servlet instance can determine its name using ServletConfig.getServletName()
.
This method returns null if the ServletContext cannot return a RequestDispatcher for any reason.
getNamedDispatcher
in interface javax.servlet.ServletContext
sName
- a String specifying the name of a servlet to wrappublic String getRealPath(String sPath)
The real path returned will be in a form appropriate to the computer and operating system on which the servlet container is running, including the proper path separators. This method returns null if the servlet container cannot translate the virtual path to a real path for any reason (such as when the content is being made available from a .war archive).
getRealPath
in interface javax.servlet.ServletContext
sPath
- a String specifying a virtual pathpublic javax.servlet.RequestDispatcher getRequestDispatcher(String sPath)
The pathname must begin with a "/" and is interpreted as relative to the current context root. Use getContext to obtain a RequestDispatcher for resources in foreign contexts. This method returns null if the ServletContext cannot return a RequestDispatcher.
getRequestDispatcher
in interface javax.servlet.ServletContext
sPath
- a String specifying the pathname to the resourcepublic URL getResource(String sPath) throws MalformedURLException
This method allows the servlet container to make a resource available to servlets from any source. Resources can be located on a local or remote file system, in a database, or in a .war file.
The servlet container must implement the URL handlers and URLConnection objects that are necessary to access the resource.
This method returns null if no resource is mapped to the pathname.
Some containers may allow writing to the URL returned by this method using the methods of the URL class.
The resource content is returned directly, so be aware that requesting a .jsp page returns the JSP source code. Use a RequestDispatcher instead to include results of an execution.
This method has a different purpose than Class.getResource, which looks up resources based on a class loader. This method does not use class loaders.
getResource
in interface javax.servlet.ServletContext
sPath
- a String specifying the path to the resourceMalformedURLException
- if the pathname is not given in the correct formpublic InputStream getResourceAsStream(String sPath)
The data in the InputStream can be of any type or length. The path must be specified according to the rules given in getResource. This method returns null if no resource exists at the specified path.
Meta-information such as content length and content type that is available via getResource method is lost when using this method.
The servlet container must implement the URL handlers and URLConnection objects necessary to access the resource.
This method is different from Class.getResourceAsStream, which uses a class loader. This method allows servlet containers to make a resource available to a servlet from any location, without using a class loader.
getResourceAsStream
in interface javax.servlet.ServletContext
sPath
- a String specifying the path to the resourcepublic Set getResourcePaths(String sPath)
getResourcePaths
in interface javax.servlet.ServletContext
sPath
- partial path used to match the resources, which must start with a '/'public String getServerInfo()
The form of the returned string is servername/versionnumber. For example, the JavaServer Web Development Kit may return the string JavaServer Web Dev Kit/1.0.
The servlet container may return other optional information after the primary string in parentheses, for example, JavaServer Web Dev Kit/1.0 (JDK 1.1.6; Windows NT 4.0 x86).
getServerInfo
in interface javax.servlet.ServletContext
public javax.servlet.Servlet getServlet(String sName) throws javax.servlet.ServletException
In lieu of this method, servlets can share information using the ServletContext class and can perform shared business logic by invoking methods on common non-servlet classes.
getServlet
in interface javax.servlet.ServletContext
sName
- a servlet namejavax.servlet.ServletException
public String getServletContextName()
getServletContextName
in interface javax.servlet.ServletContext
public Enumeration getServletNames()
getServletNames
in interface javax.servlet.ServletContext
public Enumeration getServlets()
getServlets
in interface javax.servlet.ServletContext
public void log(String sMsg)
log
in interface javax.servlet.ServletContext
sMsg
- a String specifying the message to be written to the log filepublic void log(Exception e, String sMsg)
log(String, Throwable)
instead.log
in interface javax.servlet.ServletContext
e
- an exception to logsMsg
- a message to logpublic void log(String sMsg, Throwable e)
log
in interface javax.servlet.ServletContext
sMsg
- a String that describes the error or exceptione
- the Throwable error or exceptionpublic void removeAttribute(String sName)
If listeners are configured on the ServletContext the container notifies them accordingly.
removeAttribute
in interface javax.servlet.ServletContext
sName
- a String specifying the name of the attribute to be removedpublic void setAttribute(String sName, Object oValue)
If listeners are configured on the ServletContext the container notifies them accordingly.
If a null value is passed, the effect is the same as calling removeAttribute().
setAttribute
in interface javax.servlet.ServletContext
sName
- a String specifying the name of the attributeoValue
- an Object representing the attribute to be boundpublic int hashCode()
public boolean equals(Object obj)
public String toString()
public String getContextPath()
getContextPath
in interface javax.servlet.ServletContext
protected String getDescription()
protected SessionHelper getSessionHelper()
protected javax.servlet.ServletContext getServletContext()
protected boolean isClustered()
protected void ensureCluster()
protected NamedCache getAttributeMap()
protected MapListener instantiateServletContextMapListener()