java.lang.Object
- org.jivesoftware.openfire.container.PluginServletContext

All Implemented Interfaces:

javax.servlet.ServletContext
```
public class PluginServletContext
extends Object
implements javax.servlet.ServletContext
```
A Servlet Context to be used by Openfire plugins. This implementation is used do load resources from the plugin classpath. Other functionality is delegated to a proxy implementation.

Author:

Guus der Kinderen, guus.der.kinderen@gmail.com

Field Summary

Fields
Modifier and Type Field Description

protected javax.servlet.ServletContext proxy
- Fields inherited from interface javax.servlet.ServletContext
  ORDERED_LIBS, TEMPDIR

Constructor Summary

Constructors
Constructor Description

PluginServletContext(javax.servlet.ServletContext proxy, PluginManager pluginManager, Plugin plugin)

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`javax.servlet.FilterRegistration.Dynamic`	`addFilter(String s, Class<? extends javax.servlet.Filter> aClass)`
`javax.servlet.FilterRegistration.Dynamic`	`addFilter(String s, String s1)`
`javax.servlet.FilterRegistration.Dynamic`	`addFilter(String s, javax.servlet.Filter filter)`
`void`	`addListener(Class<? extends EventListener> aClass)`
`void`	`addListener(String s)`
`<T extends EventListener> void`	`addListener(T t)`
`javax.servlet.ServletRegistration.Dynamic`	`addServlet(String s, Class<? extends javax.servlet.Servlet> aClass)`
`javax.servlet.ServletRegistration.Dynamic`	`addServlet(String s, String s1)`
`javax.servlet.ServletRegistration.Dynamic`	`addServlet(String s, javax.servlet.Servlet servlet)`
`<T extends javax.servlet.Filter> T`	`createFilter(Class<T> aClass)`
`<T extends EventListener> T`	`createListener(Class<T> aClass)`
`<T extends javax.servlet.Servlet> T`	`createServlet(Class<T> aClass)`
`void`	`declareRoles(String... strings)`
`Object`	`getAttribute(String s)`
`Enumeration<String>`	`getAttributeNames()`
`ClassLoader`	`getClassLoader()`
`javax.servlet.ServletContext`	`getContext(String s)`
`String`	`getContextPath()`
`Set<javax.servlet.SessionTrackingMode>`	`getDefaultSessionTrackingModes()`
`int`	`getEffectiveMajorVersion()`
`int`	`getEffectiveMinorVersion()`
`Set<javax.servlet.SessionTrackingMode>`	`getEffectiveSessionTrackingModes()`
`javax.servlet.FilterRegistration`	`getFilterRegistration(String s)`
`Map<String,? extends javax.servlet.FilterRegistration>`	`getFilterRegistrations()`
`String`	`getInitParameter(String s)`
`Enumeration<String>`	`getInitParameterNames()`
`javax.servlet.descriptor.JspConfigDescriptor`	`getJspConfigDescriptor()`
`int`	`getMajorVersion()`
`String`	`getMimeType(String s)`
`int`	`getMinorVersion()`
`javax.servlet.RequestDispatcher`	`getNamedDispatcher(String s)`
`String`	`getRealPath(String s)`
`javax.servlet.RequestDispatcher`	`getRequestDispatcher(String s)`
`URL`	`getResource(String s)`
`InputStream`	`getResourceAsStream(String s)`
`Set<String>`	`getResourcePaths(String s)`
`String`	`getServerInfo()`
`javax.servlet.Servlet`	`getServlet(String s)`
`String`	`getServletContextName()`
`Enumeration<String>`	`getServletNames()`
`javax.servlet.ServletRegistration`	`getServletRegistration(String s)`
`Map<String,? extends javax.servlet.ServletRegistration>`	`getServletRegistrations()`
`Enumeration<javax.servlet.Servlet>`	`getServlets()`
`javax.servlet.SessionCookieConfig`	`getSessionCookieConfig()`
`String`	`getVirtualServerName()`
`void`	`log(Exception e, String s)`
`void`	`log(String s)`
`void`	`log(String s, Throwable throwable)`
`void`	`removeAttribute(String s)`
`void`	`setAttribute(String s, Object o)`
`boolean`	`setInitParameter(String s, String s1)`
`void`	`setSessionTrackingModes(Set<javax.servlet.SessionTrackingMode> set)`
`protected static String`	`stripLeadingSlash(String input)`	The plugin classloader is an URL classloadeer, which will do lookups in directories with entries like these: jar:file:/home/guus/github/Openfire/target/openfire/plugins/oauthresourceserver/lib/plugin-oauthresourceserver.jar!/ (note the trailing slash).

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - proxy
```
protected final javax.servlet.ServletContext proxy
```
- Constructor Detail
  - PluginServletContext
```
public PluginServletContext(javax.servlet.ServletContext proxy,
                            PluginManager pluginManager,
                            Plugin plugin)
```
- Method Detail
  - stripLeadingSlash
```
protected static String stripLeadingSlash(String input)
```
    The plugin classloader is an URL classloadeer, which will do lookups in directories with entries like these: jar:file:/home/guus/github/Openfire/target/openfire/plugins/oauthresourceserver/lib/plugin-oauthresourceserver.jar!/ (note the trailing slash). To prevent lookup failures, strip any leading slash (which, when concatinated, would result "//").
    
    Parameters:
    
    input - A string (cannot be null)
    
    Returns:
    
    The string without the first leading slash.
  - getContextPath
```
public String getContextPath()
```
    Specified by:
    
    getContextPath in interface javax.servlet.ServletContext
  - getContext
```
public javax.servlet.ServletContext getContext(String s)
```
    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 String getMimeType(String s)
```
    Specified by:
    
    getMimeType in interface javax.servlet.ServletContext
  - getResourcePaths
```
public Set<String> getResourcePaths(String s)
```
    Specified by:
    
    getResourcePaths in interface javax.servlet.ServletContext
  - getResource
```
public URL getResource(String s)
                throws MalformedURLException
```
    Specified by:
    
    getResource in interface javax.servlet.ServletContext
    
    Throws:
    
    MalformedURLException
  - getResourceAsStream
```
public InputStream getResourceAsStream(String s)
```
    Specified by:
    
    getResourceAsStream in interface javax.servlet.ServletContext
  - getRequestDispatcher
```
public javax.servlet.RequestDispatcher getRequestDispatcher(String s)
```
    Specified by:
    
    getRequestDispatcher in interface javax.servlet.ServletContext
  - getNamedDispatcher
```
public javax.servlet.RequestDispatcher getNamedDispatcher(String s)
```
    Specified by:
    
    getNamedDispatcher in interface javax.servlet.ServletContext
  - getServlet
```
public javax.servlet.Servlet getServlet(String s)
                                 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 s)
```
    Specified by:
    
    log in interface javax.servlet.ServletContext
  - log
```
public void log(Exception e,
                String s)
```
    Specified by:
    
    log in interface javax.servlet.ServletContext
  - log
```
public void log(String s,
                Throwable throwable)
```
    Specified by:
    
    log in interface javax.servlet.ServletContext
  - getRealPath
```
public String getRealPath(String s)
```
    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 s)
```
    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 s,
                                String s1)
```
    Specified by:
    
    setInitParameter in interface javax.servlet.ServletContext
  - getAttribute
```
public Object getAttribute(String s)
```
    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 s,
                         Object o)
```
    Specified by:
    
    setAttribute in interface javax.servlet.ServletContext
  - removeAttribute
```
public void removeAttribute(String s)
```
    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 s,
                                                            String s1)
```
    Specified by:
    
    addServlet in interface javax.servlet.ServletContext
  - addServlet
```
public javax.servlet.ServletRegistration.Dynamic addServlet(String s,
                                                            javax.servlet.Servlet servlet)
```
    Specified by:
    
    addServlet in interface javax.servlet.ServletContext
  - addServlet
```
public javax.servlet.ServletRegistration.Dynamic addServlet(String s,
                                                            Class<? extends javax.servlet.Servlet> aClass)
```
    Specified by:
    
    addServlet in interface javax.servlet.ServletContext
  - createServlet
```
public <T extends javax.servlet.Servlet> T createServlet(Class<T> aClass)
                                                  throws javax.servlet.ServletException
```
    Specified by:
    
    createServlet in interface javax.servlet.ServletContext
    
    Throws:
    
    javax.servlet.ServletException
  - getServletRegistration
```
public javax.servlet.ServletRegistration getServletRegistration(String s)
```
    Specified by:
    
    getServletRegistration in interface javax.servlet.ServletContext
  - getServletRegistrations
```
public Map<String,? extends javax.servlet.ServletRegistration> getServletRegistrations()
```
    Specified by:
    
    getServletRegistrations in interface javax.servlet.ServletContext
  - addFilter
```
public javax.servlet.FilterRegistration.Dynamic addFilter(String s,
                                                          String s1)
```
    Specified by:
    
    addFilter in interface javax.servlet.ServletContext
  - addFilter
```
public javax.servlet.FilterRegistration.Dynamic addFilter(String s,
                                                          javax.servlet.Filter filter)
```
    Specified by:
    
    addFilter in interface javax.servlet.ServletContext
  - addFilter
```
public javax.servlet.FilterRegistration.Dynamic addFilter(String s,
                                                          Class<? extends javax.servlet.Filter> aClass)
```
    Specified by:
    
    addFilter in interface javax.servlet.ServletContext
  - createFilter
```
public <T extends javax.servlet.Filter> T createFilter(Class<T> aClass)
                                                throws javax.servlet.ServletException
```
    Specified by:
    
    createFilter in interface javax.servlet.ServletContext
    
    Throws:
    
    javax.servlet.ServletException
  - getFilterRegistration
```
public javax.servlet.FilterRegistration getFilterRegistration(String s)
```
    Specified by:
    
    getFilterRegistration in interface javax.servlet.ServletContext
  - getFilterRegistrations
```
public Map<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(Set<javax.servlet.SessionTrackingMode> set)
```
    Specified by:
    
    setSessionTrackingModes in interface javax.servlet.ServletContext
  - getDefaultSessionTrackingModes
```
public Set<javax.servlet.SessionTrackingMode> getDefaultSessionTrackingModes()
```
    Specified by:
    
    getDefaultSessionTrackingModes in interface javax.servlet.ServletContext
  - getEffectiveSessionTrackingModes
```
public Set<javax.servlet.SessionTrackingMode> getEffectiveSessionTrackingModes()
```
    Specified by:
    
    getEffectiveSessionTrackingModes in interface javax.servlet.ServletContext
  - addListener
```
public void addListener(String s)
```
    Specified by:
    
    addListener in interface javax.servlet.ServletContext
  - addListener
```
public <T extends EventListener> void addListener(T t)
```
    Specified by:
    
    addListener in interface javax.servlet.ServletContext
  - addListener
```
public void addListener(Class<? extends EventListener> aClass)
```
    Specified by:
    
    addListener in interface javax.servlet.ServletContext
  - createListener
```
public <T extends EventListener> T createListener(Class<T> aClass)
                                           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 ClassLoader getClassLoader()
```
    Specified by:
    
    getClassLoader in interface javax.servlet.ServletContext
  - declareRoles
```
public void declareRoles(String... strings)
```
    Specified by:
    
    declareRoles in interface javax.servlet.ServletContext
  - getVirtualServerName
```
public String getVirtualServerName()
```
    Specified by:
    
    getVirtualServerName in interface javax.servlet.ServletContext

Class PluginServletContext

Field Summary

Fields inherited from interface javax.servlet.ServletContext

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

proxy

Constructor Detail

PluginServletContext

Method Detail

stripLeadingSlash

getContextPath

getContext

getMajorVersion

getMinorVersion

getEffectiveMajorVersion

getEffectiveMinorVersion

getMimeType

getResourcePaths

getResource

getResourceAsStream

getRequestDispatcher

getNamedDispatcher

getServlet

getServlets

getServletNames

log

log

log

getRealPath

getServerInfo

getInitParameter

getInitParameterNames

setInitParameter

getAttribute

getAttributeNames

setAttribute

removeAttribute

getServletContextName

addServlet

addServlet

addServlet

createServlet

getServletRegistration

getServletRegistrations

addFilter

addFilter

addFilter

createFilter

getFilterRegistration

getFilterRegistrations

getSessionCookieConfig

setSessionTrackingModes

getDefaultSessionTrackingModes

getEffectiveSessionTrackingModes

addListener

addListener

addListener

createListener

getJspConfigDescriptor

getClassLoader

declareRoles

getVirtualServerName