de.aristaflow.adept2.base.servletcontainer.dynamic

Class BaseResourceServletContext

java.lang.Object

de.aristaflow.adept2.base.servletcontainer.dynamic.BaseResourceServletContext

All Implemented Interfaces:

javax.servlet.ServletContext

public class BaseResourceServletContext
extends java.lang.Object
implements javax.servlet.ServletContext

A wrapping servlet context that loads resources relative to a provided class.

Author:

Ulrich Kreher

Field Summary

Fields

Modifier and Type	Field and Description
protected javax.servlet.ServletContext	context The servlet context to which to delegate to.
static java.lang.String	FILE_PROTOCOL The protocol for a file.
static java.lang.String	JAR_FILE_PROTOCOL The protocol for a Jar-file.
protected java.lang.Class<?>	loader The class relative to which we try to load resources.
protected java.net.URL	loaderBase The URL that is the base of our loader (class) .
protected java.util.logging.Logger	logger The logger for logging exception messages and important proceed information.

Fields inherited from interface javax.servlet.ServletContext

ORDERED_LIBS, TEMPDIR

Constructor Summary

Constructors

Constructor and Description
BaseResourceServletContext(javax.servlet.ServletContext context, java.lang.Class<?> loader, java.util.logging.Logger logger)

Method Summary

Modifier and Type	Method and Description
javax.servlet.FilterRegistration.Dynamic	addFilter(java.lang.String filterName, java.lang.Class<? extends javax.servlet.Filter> filterClass)
javax.servlet.FilterRegistration.Dynamic	addFilter(java.lang.String filterName, javax.servlet.Filter filter)
javax.servlet.FilterRegistration.Dynamic	addFilter(java.lang.String filterName, java.lang.String className)
void	addListener(java.lang.Class<? extends java.util.EventListener> listenerClass)
void	addListener(java.lang.String className)
<T extends java.util.EventListener> void	addListener(T t)
javax.servlet.ServletRegistration.Dynamic	addServlet(java.lang.String servletName, java.lang.Class<? extends javax.servlet.Servlet> servletClass)
javax.servlet.ServletRegistration.Dynamic	addServlet(java.lang.String servletName, javax.servlet.Servlet servlet)
javax.servlet.ServletRegistration.Dynamic	addServlet(java.lang.String servletName, java.lang.String className)
<T extends javax.servlet.Filter> T	createFilter(java.lang.Class<T> clazz)
<T extends java.util.EventListener> T	createListener(java.lang.Class<T> clazz)
<T extends javax.servlet.Servlet> T	createServlet(java.lang.Class<T> clazz)
void	declareRoles(java.lang.String... roleNames)
java.lang.Object	getAttribute(java.lang.String name)
java.util.Enumeration<java.lang.String>	getAttributeNames()
protected java.util.Set<java.lang.String>	getChildren(java.lang.String entryPath, java.util.jar.JarFile file) Gets the children for the designated path in the designated jar-file.
java.lang.ClassLoader	getClassLoader()
javax.servlet.ServletContext	getContext(java.lang.String uripath)
java.lang.String	getContextPath()
java.util.Set<javax.servlet.SessionTrackingMode>	getDefaultSessionTrackingModes()
int	getEffectiveMajorVersion()
int	getEffectiveMinorVersion()
java.util.Set<javax.servlet.SessionTrackingMode>	getEffectiveSessionTrackingModes()
javax.servlet.FilterRegistration	getFilterRegistration(java.lang.String filterName)
java.util.Map<java.lang.String,? extends javax.servlet.FilterRegistration>	getFilterRegistrations()
java.lang.String	getInitParameter(java.lang.String name)
java.util.Enumeration<java.lang.String>	getInitParameterNames()
javax.servlet.descriptor.JspConfigDescriptor	getJspConfigDescriptor()
int	getMajorVersion()
java.lang.String	getMimeType(java.lang.String file)
int	getMinorVersion()
javax.servlet.RequestDispatcher	getNamedDispatcher(java.lang.String name)
java.lang.String	getRealPath(java.lang.String path)
javax.servlet.RequestDispatcher	getRequestDispatcher(java.lang.String path)
java.net.URL	getResource(java.lang.String path)
java.io.InputStream	getResourceAsStream(java.lang.String path)
protected java.net.URL	getResourceFromLoader(java.lang.String path) Tries to retrieve the designated path from our loader (class).
java.util.Set<java.lang.String>	getResourcePaths(java.lang.String path)
java.lang.String	getServerInfo()
javax.servlet.Servlet	getServlet(java.lang.String name)
java.lang.String	getServletContextName()
java.util.Enumeration<java.lang.String>	getServletNames()
javax.servlet.ServletRegistration	getServletRegistration(java.lang.String servletName)
java.util.Map<java.lang.String,? extends javax.servlet.ServletRegistration>	getServletRegistrations()
java.util.Enumeration<javax.servlet.Servlet>	getServlets()
javax.servlet.SessionCookieConfig	getSessionCookieConfig()
java.lang.String	getVirtualServerName()
protected java.util.Set<java.lang.String>	listContentOfUrl(java.net.URL resource, java.net.URL base) Lists the content of the designated URL.
protected java.util.Set<java.lang.String>	listContentOfUrlExt(java.net.URL resource, java.net.URL base, java.lang.String relResPath) Lists the content of the designated URL and thus extends listContentOfUrl(URL, URL).
void	log(java.lang.Exception exception, java.lang.String msg)
void	log(java.lang.String msg)
void	log(java.lang.String message, java.lang.Throwable throwable)
void	removeAttribute(java.lang.String name)
void	setAttribute(java.lang.String name, java.lang.Object object)
boolean	setInitParameter(java.lang.String name, java.lang.String value)
void	setSessionTrackingModes(java.util.Set<javax.servlet.SessionTrackingMode> sessionTrackingModes)

Methods inherited from class java.lang.Object

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

Field Detail

FILE_PROTOCOL

public static final java.lang.String FILE_PROTOCOL

The protocol for a file.

See Also:

Constant Field Values

JAR_FILE_PROTOCOL

public static final java.lang.String JAR_FILE_PROTOCOL

The protocol for a Jar-file.

See Also:

Constant Field Values

context

protected final javax.servlet.ServletContext context

The servlet context to which to delegate to.

loader

protected final java.lang.Class<?> loader

The class relative to which we try to load resources.

loaderBase

protected final java.net.URL loaderBase

The URL that is the base of our loader (class) .

logger

protected final java.util.logging.Logger logger

The logger for logging exception messages and important proceed information.

Constructor Detail

BaseResourceServletContext

public BaseResourceServletContext(javax.servlet.ServletContext context,
                                  java.lang.Class<?> loader,
                                  java.util.logging.Logger logger)
                           throws java.net.MalformedURLException

Parameters:

context - The servlet context to which to delegate to.

loader - The class relative to which we try to load resources.

logger - The logger for logging exception messages and important proceed information.

Throws:

java.net.MalformedURLException - If there are problems creating the base URL, that is the URL relative to which to load resources, a MalformedURLException will be thrown.

Method Detail

getContextPath

public java.lang.String getContextPath()

Specified by:

getContextPath in interface javax.servlet.ServletContext

getContext

public javax.servlet.ServletContext getContext(java.lang.String uripath)

Specified by:

getContext in interface javax.servlet.ServletContext

getMajorVersion

public int getMajorVersion()

Specified by:

getMajorVersion in interface javax.servlet.ServletContext

getMinorVersion

public int getMinorVersion()

Specified by:

getMinorVersion in interface javax.servlet.ServletContext

getEffectiveMajorVersion

public int getEffectiveMajorVersion()

Specified by:

getEffectiveMajorVersion in interface javax.servlet.ServletContext

getEffectiveMinorVersion

public int getEffectiveMinorVersion()

Specified by:

getEffectiveMinorVersion in interface javax.servlet.ServletContext

getMimeType

public java.lang.String getMimeType(java.lang.String file)

Specified by:

getMimeType in interface javax.servlet.ServletContext

getResourcePaths

public java.util.Set<java.lang.String> getResourcePaths(java.lang.String path)

Specified by:

getResourcePaths in interface javax.servlet.ServletContext

getResource

public java.net.URL getResource(java.lang.String path)
                         throws java.net.MalformedURLException

Specified by:

getResource in interface javax.servlet.ServletContext

Throws:

java.net.MalformedURLException

listContentOfUrl

protected java.util.Set<java.lang.String> listContentOfUrl(java.net.URL resource,
                                                           java.net.URL base)

Lists the content of the designated URL. The URL is retrieved from loading a resource relative to a class. It may be specific to the servlet container that embeds this servlet. This method does not need to delegate to the underlying context. This will be done if this method does not return valid content.

Usually you do not override this method but listContentOfUrlExt(URL, URL, String). If a file or Jar-file protocol is encountered, this implementation will usually suit your needs. In case of other protocols, listContentOfUrlExt(URL, URL, String) will be called.

Parameters:

resource - The URL identifying a resource as retrieved from our loader (class).

base - The URL identifying the top-level path of our loader.

Returns:

The content of the designated URL (usually the content of the directory specified by the designated URL relative to the loader URL. If the directory for the resource is empty, the empty list will be returned, if no content can be retrieved, e.g. the resource URL cannot be interpreted as directory, null will be returned. Directories need to have a trailing slash.

listContentOfUrlExt

protected java.util.Set<java.lang.String> listContentOfUrlExt(java.net.URL resource,
                                                              java.net.URL base,
                                                              java.lang.String relResPath)

Lists the content of the designated URL and thus extends listContentOfUrl(URL, URL). This method will be called if the URL protocol cannot be handled there. Subclasses should override this method to support further protocols.

This default implementation just returns null indicating that the resource cannot be interpreted as directory.

Parameters:

resource - The URL identifying a resource as retrieved from our loader (class).

base - The URL identifying the top-level path of our loader.

relResPath - The path to the resource URL relative to the base URL. Obviously this will only be valid if the designated resource is part of the designated base.

Returns:

The content of the designated URL (usually the content of the directory specified by the designated URL relative to the loader URL. If the directory for the resource is empty, the empty list will be returned, if no content can be retrieved, e.g. the resource URL cannot be interpreted as directory, null will be returned. Directories need to have a trailing slash.

getChildren

protected java.util.Set<java.lang.String> getChildren(java.lang.String entryPath,
                                                      java.util.jar.JarFile file)

Gets the children for the designated path in the designated jar-file.

Parameters:

entryPath - The entry for which to get the direct children. The path is relative to the designated jar-file.

file - The jar-file from which to retrieve the children.

Returns:

The paths of the children of the designated entry relative to the designated jar-file. Note that directories must have a trailing "/".

getResourceFromLoader

protected java.net.URL getResourceFromLoader(java.lang.String path)

Tries to retrieve the designated path from our loader (class). The path is tried relatively and absolutely. If the loader does not know the designated path, null will be returned.

Parameters:

path - The path which to search in our loader (class).

Returns:

The URL retrieved from our loader (class) or null if the loader does not know the path.

getResourceAsStream

public java.io.InputStream getResourceAsStream(java.lang.String path)

Specified by:

getResourceAsStream in interface javax.servlet.ServletContext

getRequestDispatcher

public javax.servlet.RequestDispatcher getRequestDispatcher(java.lang.String path)

Specified by:

getRequestDispatcher in interface javax.servlet.ServletContext

getNamedDispatcher

public javax.servlet.RequestDispatcher getNamedDispatcher(java.lang.String name)

Specified by:

getNamedDispatcher in interface javax.servlet.ServletContext

getServlet

public javax.servlet.Servlet getServlet(java.lang.String name)
                                 throws javax.servlet.ServletException

Specified by:

getServlet in interface javax.servlet.ServletContext

Throws:

javax.servlet.ServletException

getServlets

public java.util.Enumeration<javax.servlet.Servlet> getServlets()

Specified by:

getServlets in interface javax.servlet.ServletContext

getServletNames

public java.util.Enumeration<java.lang.String> getServletNames()

Specified by:

getServletNames in interface javax.servlet.ServletContext

log

public void log(java.lang.String msg)

Specified by:

log in interface javax.servlet.ServletContext

log

public void log(java.lang.Exception exception,
                java.lang.String msg)

Specified by:

log in interface javax.servlet.ServletContext

log

public void log(java.lang.String message,
                java.lang.Throwable throwable)

Specified by:

log in interface javax.servlet.ServletContext

getRealPath

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

Specified by:

getRealPath in interface javax.servlet.ServletContext

getServerInfo

public java.lang.String getServerInfo()

Specified by:

getServerInfo in interface javax.servlet.ServletContext

getInitParameter

public java.lang.String getInitParameter(java.lang.String name)

Specified by:

getInitParameter in interface javax.servlet.ServletContext

getInitParameterNames

public java.util.Enumeration<java.lang.String> getInitParameterNames()

Specified by:

getInitParameterNames in interface javax.servlet.ServletContext

setInitParameter

public boolean setInitParameter(java.lang.String name,
                                java.lang.String value)

Specified by:

setInitParameter in interface javax.servlet.ServletContext

getAttribute

public java.lang.Object getAttribute(java.lang.String name)

Specified by:

getAttribute in interface javax.servlet.ServletContext

getAttributeNames

public java.util.Enumeration<java.lang.String> getAttributeNames()

Specified by:

getAttributeNames in interface javax.servlet.ServletContext

setAttribute

public void setAttribute(java.lang.String name,
                         java.lang.Object object)

Specified by:

setAttribute in interface javax.servlet.ServletContext

removeAttribute

public void removeAttribute(java.lang.String name)

Specified by:

removeAttribute in interface javax.servlet.ServletContext

getServletContextName

public java.lang.String getServletContextName()

Specified by:

getServletContextName in interface javax.servlet.ServletContext

addServlet

public javax.servlet.ServletRegistration.Dynamic addServlet(java.lang.String servletName,
                                                            java.lang.String className)

Specified by:

addServlet in interface javax.servlet.ServletContext

addServlet

public javax.servlet.ServletRegistration.Dynamic addServlet(java.lang.String servletName,
                                                            javax.servlet.Servlet servlet)

Specified by:

addServlet in interface javax.servlet.ServletContext

addServlet

public javax.servlet.ServletRegistration.Dynamic addServlet(java.lang.String servletName,
                                                            java.lang.Class<? extends javax.servlet.Servlet> servletClass)

Specified by:

addServlet in interface javax.servlet.ServletContext

createServlet

public <T extends javax.servlet.Servlet> T createServlet(java.lang.Class<T> clazz)
                                                  throws javax.servlet.ServletException

Specified by:

createServlet in interface javax.servlet.ServletContext

Throws:

javax.servlet.ServletException

getServletRegistration

public javax.servlet.ServletRegistration getServletRegistration(java.lang.String servletName)

Specified by:

getServletRegistration in interface javax.servlet.ServletContext

getServletRegistrations

public java.util.Map<java.lang.String,? extends javax.servlet.ServletRegistration> getServletRegistrations()

Specified by:

getServletRegistrations in interface javax.servlet.ServletContext

addFilter

public javax.servlet.FilterRegistration.Dynamic addFilter(java.lang.String filterName,
                                                          java.lang.String className)

Specified by:

addFilter in interface javax.servlet.ServletContext

addFilter

public javax.servlet.FilterRegistration.Dynamic addFilter(java.lang.String filterName,
                                                          javax.servlet.Filter filter)

Specified by:

addFilter in interface javax.servlet.ServletContext

addFilter

public javax.servlet.FilterRegistration.Dynamic addFilter(java.lang.String filterName,
                                                          java.lang.Class<? extends javax.servlet.Filter> filterClass)

Specified by:

addFilter in interface javax.servlet.ServletContext

createFilter

public <T extends javax.servlet.Filter> T createFilter(java.lang.Class<T> clazz)
                                                throws javax.servlet.ServletException

Specified by:

createFilter in interface javax.servlet.ServletContext

Throws:

javax.servlet.ServletException

getFilterRegistration

public javax.servlet.FilterRegistration getFilterRegistration(java.lang.String filterName)

Specified by:

getFilterRegistration in interface javax.servlet.ServletContext

getFilterRegistrations

public java.util.Map<java.lang.String,? extends javax.servlet.FilterRegistration> getFilterRegistrations()

Specified by:

getFilterRegistrations in interface javax.servlet.ServletContext

getSessionCookieConfig

public javax.servlet.SessionCookieConfig getSessionCookieConfig()

Specified by:

getSessionCookieConfig in interface javax.servlet.ServletContext

setSessionTrackingModes

public void setSessionTrackingModes(java.util.Set<javax.servlet.SessionTrackingMode> sessionTrackingModes)

Specified by:

setSessionTrackingModes in interface javax.servlet.ServletContext

getDefaultSessionTrackingModes

public java.util.Set<javax.servlet.SessionTrackingMode> getDefaultSessionTrackingModes()

Specified by:

getDefaultSessionTrackingModes in interface javax.servlet.ServletContext

getEffectiveSessionTrackingModes

public java.util.Set<javax.servlet.SessionTrackingMode> getEffectiveSessionTrackingModes()

Specified by:

getEffectiveSessionTrackingModes in interface javax.servlet.ServletContext

addListener

public void addListener(java.lang.String className)

Specified by:

addListener in interface javax.servlet.ServletContext

addListener

public <T extends java.util.EventListener> void addListener(T t)

Specified by:

addListener in interface javax.servlet.ServletContext

addListener

public void addListener(java.lang.Class<? extends java.util.EventListener> listenerClass)

Specified by:

addListener in interface javax.servlet.ServletContext

createListener

public <T extends java.util.EventListener> T createListener(java.lang.Class<T> clazz)
                                                     throws javax.servlet.ServletException

Specified by:

createListener in interface javax.servlet.ServletContext

Throws:

javax.servlet.ServletException

getJspConfigDescriptor

public javax.servlet.descriptor.JspConfigDescriptor getJspConfigDescriptor()

Specified by:

getJspConfigDescriptor in interface javax.servlet.ServletContext

getClassLoader

public java.lang.ClassLoader getClassLoader()

Specified by:

getClassLoader in interface javax.servlet.ServletContext

declareRoles

public void declareRoles(java.lang.String... roleNames)

Specified by:

declareRoles in interface javax.servlet.ServletContext

getVirtualServerName

public java.lang.String getVirtualServerName()

Specified by:

getVirtualServerName in interface javax.servlet.ServletContext