info.magnolia.servlet

Class ServletContextWrapper

java.lang.Object

info.magnolia.servlet.ServletContextWrapper

All Implemented Interfaces:

javax.servlet.ServletContext

public class ServletContextWrapper
extends Object
implements javax.servlet.ServletContext

A general-purpose wrapper around ServletContext to help reducing boilerplate for servlet decorators.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ServletContextWrapper(javax.servlet.ServletContext parentServletContext)

Method Summary

Modifier and Type	Method and Description
javax.servlet.FilterRegistration.Dynamic	addFilter(String filterName, Class<? extends javax.servlet.Filter> filterClass)
javax.servlet.FilterRegistration.Dynamic	addFilter(String filterName, javax.servlet.Filter filter)
javax.servlet.FilterRegistration.Dynamic	addFilter(String filterName, String className)
void	addListener(Class<? extends EventListener> listenerClass)
void	addListener(String className)
<T extends EventListener> void	addListener(T t)
javax.servlet.ServletRegistration.Dynamic	addServlet(String servletName, Class<? extends javax.servlet.Servlet> servletClass)
javax.servlet.ServletRegistration.Dynamic	addServlet(String servletName, javax.servlet.Servlet servlet)
javax.servlet.ServletRegistration.Dynamic	addServlet(String servletName, String className)
<T extends javax.servlet.Filter> T	createFilter(Class<T> clazz)
<T extends EventListener> T	createListener(Class<T> clazz)
<T extends javax.servlet.Servlet> T	createServlet(Class<T> clazz)
void	declareRoles(String... roleNames)
Object	getAttribute(String name)
Enumeration<String>	getAttributeNames()
ClassLoader	getClassLoader()
javax.servlet.ServletContext	getContext(String uripath)
String	getContextPath()
Set<javax.servlet.SessionTrackingMode>	getDefaultSessionTrackingModes()
int	getEffectiveMajorVersion()
int	getEffectiveMinorVersion()
Set<javax.servlet.SessionTrackingMode>	getEffectiveSessionTrackingModes()
javax.servlet.FilterRegistration	getFilterRegistration(String filterName)
Map<String,? extends javax.servlet.FilterRegistration>	getFilterRegistrations()
String	getInitParameter(String name)
Enumeration<String>	getInitParameterNames()
javax.servlet.descriptor.JspConfigDescriptor	getJspConfigDescriptor()
int	getMajorVersion()
String	getMimeType(String file)
int	getMinorVersion()
javax.servlet.RequestDispatcher	getNamedDispatcher(String name)
String	getRealPath(String path)
javax.servlet.RequestDispatcher	getRequestDispatcher(String path)
URL	getResource(String path)
InputStream	getResourceAsStream(String path)
Set<String>	getResourcePaths(String path)
String	getServerInfo()
javax.servlet.Servlet	getServlet(String name)
String	getServletContextName()
Enumeration<String>	getServletNames()
javax.servlet.ServletRegistration	getServletRegistration(String servletName)
Map<String,? extends javax.servlet.ServletRegistration>	getServletRegistrations()
Enumeration<javax.servlet.Servlet>	getServlets()
javax.servlet.SessionCookieConfig	getSessionCookieConfig()
void	log(Exception exception, String msg)
void	log(String msg)
void	log(String message, Throwable throwable)
void	removeAttribute(String name)
void	setAttribute(String name, Object object)
boolean	setInitParameter(String name, String value)
void	setSessionTrackingModes(Set<javax.servlet.SessionTrackingMode> sessionTrackingModes)

Methods inherited from class java.lang.Object

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

Constructor Detail

ServletContextWrapper

protected ServletContextWrapper(javax.servlet.ServletContext parentServletContext)

Method Detail

getContextPath

public String getContextPath()

Specified by:

getContextPath in interface javax.servlet.ServletContext

getContext

public javax.servlet.ServletContext getContext(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()

getEffectiveMinorVersion

public int getEffectiveMinorVersion()

getMimeType

public String getMimeType(String file)

Specified by:

getMimeType in interface javax.servlet.ServletContext

getResourcePaths

public Set<String> getResourcePaths(String path)

Specified by:

getResourcePaths in interface javax.servlet.ServletContext

getResource

public URL getResource(String path)
                throws MalformedURLException

Specified by:

getResource in interface javax.servlet.ServletContext

Throws:

MalformedURLException

getResourceAsStream

public InputStream getResourceAsStream(String path)

Specified by:

getResourceAsStream in interface javax.servlet.ServletContext

getRequestDispatcher

public javax.servlet.RequestDispatcher getRequestDispatcher(String path)

Specified by:

getRequestDispatcher in interface javax.servlet.ServletContext

getNamedDispatcher

public javax.servlet.RequestDispatcher getNamedDispatcher(String name)

Specified by:

getNamedDispatcher in interface javax.servlet.ServletContext

getServlet

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

Specified by:

getServlet in interface javax.servlet.ServletContext

Throws:

javax.servlet.ServletException

getServlets

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

Specified by:

getServlets in interface javax.servlet.ServletContext

getServletNames

public Enumeration<String> getServletNames()

Specified by:

getServletNames in interface javax.servlet.ServletContext

log

public void log(String msg)

Specified by:

log in interface javax.servlet.ServletContext

log

public void log(Exception exception,
                String msg)

Specified by:

log in interface javax.servlet.ServletContext

log

public void log(String message,
                Throwable throwable)

Specified by:

log in interface javax.servlet.ServletContext

getRealPath

public String getRealPath(String path)

Specified by:

getRealPath in interface javax.servlet.ServletContext

getServerInfo

public String getServerInfo()

Specified by:

getServerInfo in interface javax.servlet.ServletContext

getInitParameter

public String getInitParameter(String name)

Specified by:

getInitParameter in interface javax.servlet.ServletContext

getInitParameterNames

public Enumeration<String> getInitParameterNames()

Specified by:

getInitParameterNames in interface javax.servlet.ServletContext

setInitParameter

public boolean setInitParameter(String name,
                                String value)

getAttribute

public Object getAttribute(String name)

Specified by:

getAttribute in interface javax.servlet.ServletContext

getAttributeNames

public Enumeration<String> getAttributeNames()

Specified by:

getAttributeNames in interface javax.servlet.ServletContext

setAttribute

public void setAttribute(String name,
                         Object object)

Specified by:

setAttribute in interface javax.servlet.ServletContext

removeAttribute

public void removeAttribute(String name)

Specified by:

removeAttribute in interface javax.servlet.ServletContext

getServletContextName

public String getServletContextName()

Specified by:

getServletContextName in interface javax.servlet.ServletContext

addServlet

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

addServlet

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

addServlet

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

createServlet

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

Throws:

javax.servlet.ServletException

getServletRegistration

public javax.servlet.ServletRegistration getServletRegistration(String servletName)

getServletRegistrations

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

addFilter

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

addFilter

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

addFilter

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

createFilter

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

Throws:

javax.servlet.ServletException

getFilterRegistration

public javax.servlet.FilterRegistration getFilterRegistration(String filterName)

getFilterRegistrations

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

getSessionCookieConfig

public javax.servlet.SessionCookieConfig getSessionCookieConfig()

setSessionTrackingModes

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

getDefaultSessionTrackingModes

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

getEffectiveSessionTrackingModes

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

addListener

public void addListener(String className)

addListener

public <T extends EventListener> void addListener(T t)

addListener

public void addListener(Class<? extends EventListener> listenerClass)

createListener

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

Throws:

javax.servlet.ServletException

getJspConfigDescriptor

public javax.servlet.descriptor.JspConfigDescriptor getJspConfigDescriptor()

getClassLoader

public ClassLoader getClassLoader()

declareRoles

public void declareRoles(String... roleNames)