org.apache.felix.http.base.internal.context
Class ServletContextImpl

java.lang.Object
  extended by org.apache.felix.http.base.internal.context.ServletContextImpl
All Implemented Interfaces:
ServletContext, ExtServletContext

public final class ServletContextImpl
extends Object
implements ExtServletContext


Constructor Summary
ServletContextImpl(Bundle bundle, ServletContext context, HttpContext httpContext, javax.servlet.ServletContextAttributeListener attributeListener, boolean sharedAttributes)
           
 
Method Summary
 Object getAttribute(String name)
          Returns the servlet container attribute with the given name, or null if there is no attribute by that name.
 Enumeration getAttributeNames()
          Returns an Enumeration containing the attribute names available within this servlet context.
 ServletContext getContext(String uri)
          Returns a ServletContext object that corresponds to a specified URL on the server.
 String getContextPath()
           
 String getInitParameter(String name)
           
 Enumeration getInitParameterNames()
           
 int getMajorVersion()
          Returns the major version of the Java Servlet API that this servlet container supports.
 String getMimeType(String file)
          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.
 RequestDispatcher getNamedDispatcher(String name)
           
 String getRealPath(String name)
          Returns a String containing the real path for a given virtual path.
 RequestDispatcher getRequestDispatcher(String uri)
          Returns a RequestDispatcher object that acts as a wrapper for the resource located at the given path.
 URL getResource(String path)
          Returns a URL to the resource that is mapped to a specified path.
 InputStream getResourceAsStream(String path)
          Returns the resource located at the named path as an InputStream object.
 Set getResourcePaths(String path)
           
 String getServerInfo()
          Returns the name and version of the servlet container on which the servlet is running.
 Servlet getServlet(String name)
           
 String getServletContextName()
           
 Enumeration getServletNames()
           
 Enumeration getServlets()
           
 boolean handleSecurity(HttpServletRequest req, HttpServletResponse res)
           
 void log(Exception cause, String message)
           
 void log(String message)
          Writes the specified message to a servlet log file, usually an event log.
 void log(String message, Throwable cause)
          Writes an explanatory message and a stack trace for a given Throwable exception to the servlet log file.
 void removeAttribute(String name)
          Removes the attribute with the given name from the servlet context.
 void setAttribute(String name, Object value)
          Binds an object to a given attribute name in this servlet context.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ServletContextImpl

public ServletContextImpl(Bundle bundle,
                          ServletContext context,
                          HttpContext httpContext,
                          javax.servlet.ServletContextAttributeListener attributeListener,
                          boolean sharedAttributes)
Method Detail

getContextPath

public String getContextPath()

getContext

public ServletContext getContext(String uri)
Description copied from interface: ServletContext
Returns a ServletContext object that corresponds to a specified URL on the server.

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.

Specified by:
getContext in interface ServletContext
Parameters:
uri - a String specifying the context path of another web application in the container.
Returns:
the ServletContext object that corresponds to the named URL, or null if either none exists or the container wishes to restrict this access.
See Also:
RequestDispatcher

getMajorVersion

public int getMajorVersion()
Description copied from interface: ServletContext
Returns the major version of the Java Servlet API that this servlet container supports. All implementations that comply with Version 2.1 must have this method return the integer 2.

Specified by:
getMajorVersion in interface ServletContext
Returns:
2

getMinorVersion

public int getMinorVersion()
Description copied from interface: ServletContext
Returns the minor version of the Servlet API that this servlet container supports. All implementations that comply with Version 2.1 must have this method return the integer 1.

Specified by:
getMinorVersion in interface ServletContext
Returns:
1

getResourcePaths

public Set getResourcePaths(String path)

getResource

public URL getResource(String path)
Description copied from interface: ServletContext
Returns a URL to the resource that is mapped to a specified path. The path must begin with a "/" and is interpreted as relative to the current context root.

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 java.lang.Class.getResource, which looks up resources based on a class loader. This method does not use class loaders.

Specified by:
getResource in interface ServletContext
Parameters:
path - a String specifying the path to the resource
Returns:
the resource located at the named path, or null if there is no resource at that path

getResourceAsStream

public InputStream getResourceAsStream(String path)
Description copied from interface: ServletContext
Returns the resource located at the named path as an InputStream object.

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 java.lang.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.

Specified by:
getResourceAsStream in interface ServletContext
Parameters:
path - a String specifying the path to the resource
Returns:
the InputStream returned to the servlet, or null if no resource exists at the specified path

getRequestDispatcher

public RequestDispatcher getRequestDispatcher(String uri)
Description copied from interface: ServletContext
Returns a RequestDispatcher object that acts as a wrapper for the resource located at the given path. A RequestDispatcher object can be used to forward a request to the resource or to include the resource in a response. The resource can be dynamic or static.

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.

Specified by:
getRequestDispatcher in interface ServletContext
Parameters:
uri - a String specifying the pathname to the resource
Returns:
a RequestDispatcher object that acts as a wrapper for the resource at the specified path
See Also:
RequestDispatcher, ServletContext.getContext(java.lang.String)

getNamedDispatcher

public RequestDispatcher getNamedDispatcher(String name)

getInitParameter

public String getInitParameter(String name)

getInitParameterNames

public Enumeration getInitParameterNames()

getAttribute

public Object getAttribute(String name)
Description copied from interface: ServletContext
Returns the servlet container attribute with the given name, or null if there is no attribute by that name. An attribute allows a servlet container to give the servlet additional information not already provided by this interface. See your server documentation for information about its attributes. A list of supported attributes can be retrieved using getAttributeNames.

The attribute is returned as a java.lang.Object or some subclass. Attribute names should follow the same convention as package names. The Java Servlet API specification reserves names matching java.*, javax.*, and sun.*.

Specified by:
getAttribute in interface ServletContext
Parameters:
name - a String specifying the name of the attribute
Returns:
an Object containing the value of the attribute, or null if no attribute exists matching the given name
See Also:
ServletContext.getAttributeNames()

getAttributeNames

public Enumeration getAttributeNames()
Description copied from interface: ServletContext
Returns an Enumeration containing the attribute names available within this servlet context. Use the ServletContext.getAttribute(java.lang.String) method with an attribute name to get the value of an attribute.

Specified by:
getAttributeNames in interface ServletContext
Returns:
an Enumeration of attribute names
See Also:
ServletContext.getAttribute(java.lang.String)

setAttribute

public void setAttribute(String name,
                         Object value)
Description copied from interface: ServletContext
Binds an object to a given attribute name in this servlet context. If the name specified is already used for an attribute, this method will replace the attribute with the new to the new attribute.

Attribute names should follow the same convention as package names. The Java Servlet API specification reserves names matching java.*, javax.*, and sun.*.

Specified by:
setAttribute in interface ServletContext
Parameters:
name - a String specifying the name of the attribute
value - an Object representing the attribute to be bound

removeAttribute

public void removeAttribute(String name)
Description copied from interface: ServletContext
Removes the attribute with the given name from the servlet context. After removal, subsequent calls to ServletContext.getAttribute(java.lang.String) to retrieve the attribute's value will return null.

Specified by:
removeAttribute in interface ServletContext
Parameters:
name - a String specifying the name of the attribute to be removed

getServlet

public Servlet getServlet(String name)
                   throws ServletException
Specified by:
getServlet in interface ServletContext
Throws:
ServletException

getServlets

public Enumeration getServlets()
Specified by:
getServlets in interface ServletContext

getServletNames

public Enumeration getServletNames()
Specified by:
getServletNames in interface ServletContext

log

public void log(String message)
Description copied from interface: ServletContext
Writes the specified message to a servlet log file, usually an event log. The name and type of the servlet log file is specific to the servlet container.

Specified by:
log in interface ServletContext
Parameters:
message - a String specifying the message to be written to the log file

log

public void log(Exception cause,
                String message)
Specified by:
log in interface ServletContext

log

public void log(String message,
                Throwable cause)
Description copied from interface: ServletContext
Writes an explanatory message and a stack trace for a given Throwable exception to the servlet log file. The name and type of the servlet log file is specific to the servlet container, usually an event log.

Specified by:
log in interface ServletContext
Parameters:
message - a String that describes the error or exception
cause - the Throwable error or exception

getServletContextName

public String getServletContextName()

getRealPath

public String getRealPath(String name)
Description copied from interface: ServletContext
Returns a String containing the real path for a given virtual path. For example, the path "/index.html" returns the absolute file path on the server's filesystem would be served by a request for "http://host/contextPath/index.html", where contextPath is the context path of this ServletContext..

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).

Specified by:
getRealPath in interface ServletContext
Parameters:
name - a String specifying a virtual path
Returns:
a String specifying the real path, or null if the translation cannot be performed

getServerInfo

public String getServerInfo()
Description copied from interface: ServletContext
Returns the name and version of the servlet container on which the servlet is running.

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).

Specified by:
getServerInfo in interface ServletContext
Returns:
a String containing at least the servlet container name and version number

getMimeType

public String getMimeType(String file)
Description copied from interface: ServletContext
Returns the MIME type of the specified file, or null if the MIME type is not known. The MIME type is determined by the configuration of the servlet container, and may be specified in a web application deployment descriptor. Common MIME types are "text/html" and "image/gif".

Specified by:
getMimeType in interface ServletContext
Parameters:
file - a String specifying the name of a file
Returns:
a String specifying the file's MIME type

handleSecurity

public boolean handleSecurity(HttpServletRequest req,
                              HttpServletResponse res)
                       throws IOException
Specified by:
handleSecurity in interface ExtServletContext
Throws:
IOException


Copyright © 2013 The Apache Software Foundation. All Rights Reserved.