OsgiDynamicServletContext (OPS4J Pax Web - Service SPI (internal) 8.0.27 API)

java.lang.Object
- org.ops4j.pax.web.service.spi.servlet.OsgiDynamicServletContext

All Implemented Interfaces:

javax.servlet.ServletContext
```
public class OsgiDynamicServletContext
extends Object
implements javax.servlet.ServletContext
```
This class wraps OsgiServletContext and is used to perform "dynamic registration operations" of servlets, filters and listeners into single physical ServletContext. This wrapper is passed to ServletContainerInitializers and allows dynamic configuration. While the context that's wrapped doesn't allow this.

Many OsgiServletContexts may point to single container-specific physical servlet context and many ServletContainerInitializers may be used to register dynamic servlets/filters/listeners through many OsgiServletContexts into single ServletContext. We need to keep track of the dynamic web elements registered by multiple SCIs and actually register them later after all SCIs are invoked.

2021-07-29 update: when implementing WebSockets (having problems in Undertow), I realized it's not that easy...
- registration of servlets and filters should always be allowed (chapter 4.4.3.5 of Servlets 4 spec), but for example Jetty calls org.eclipse.jetty.servlet.ServletContextHandler.Context#checkDynamic(), Tomcat checks !context.getState().equals(LifecycleState.STARTING_PREP) and Undertow calls io.undertow.servlet.spec.ServletContextImpl#ensureNotInitialized()
- The basic, most "initial" way of adding listeners is through web.xml, web-fragment.xml or WebListener and such listeners should always be able to add more listeners. Each container has it's own way to mark the point when new listeners can't be added:
  - Jetty calls ContextHandler.Context#setEnabled(false) when invoking first programmatic listener, but new ServletContextListener can't be added if org.eclipse.jetty.server.handler.ContextHandler.Context#_extendedListenerTypes is false
  - Tomcat calls SCIs which can add ServletContextListener, but then inside org.apache.catalina.core.StandardContext#listenerStart(), newServletContextListenerAllowed is set to false. Additionally all programmatic ServletContextListeners are marked as "no pluggability listeners", so they can't add ANY new listener. ServletContextListeners added in SCIs can add other listeners only.
  - Undertow allows listeners to call ServletContext.addListener(java.lang.String) only if the adding listener is NOT programmatic. But new ServletContextListener can never be added anyway

Field Summary

Fields
Modifier and Type Field and Description

static org.slf4j.Logger LOG
- Fields inherited from interface javax.servlet.ServletContext
  ORDERED_LIBS, TEMPDIR

Fields
Modifier and Type	Field and Description
`static org.slf4j.Logger`	`LOG`

Constructor Summary

Constructors
Constructor and Description

OsgiDynamicServletContext(OsgiServletContext osgiContext, DynamicRegistrations registration)

Constructors
Constructor and Description
`OsgiDynamicServletContext(OsgiServletContext osgiContext, DynamicRegistrations registration)`

Method Summary

All Methods Instance Methods Concrete Methods
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)`
`javax.servlet.ServletRegistration.Dynamic`	`addJspFile(String servletName, String jspFile)`
`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`	`getContainerServletContext()`
`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)`
`OsgiContextModel`	`getOsgiContextModel()`
`String`	`getRealPath(String path)`
`String`	`getRequestCharacterEncoding()`
`javax.servlet.RequestDispatcher`	`getRequestDispatcher(String path)`
`URL`	`getResource(String path)`
`InputStream`	`getResourceAsStream(String path)`
`Set<String>`	`getResourcePaths(String path)`
`String`	`getResponseCharacterEncoding()`
`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()`
`int`	`getSessionTimeout()`
`String`	`getVirtualServerName()`
`void`	`log(Exception exception, String msg)`
`void`	`log(String msg)`
`void`	`log(String message, Throwable throwable)`
`void`	`rememberAttributesFromSCIs()` This method has to be called after `SCIWrapper` calls wrapped `ServletContainerInitializer`, so attributes potentially added by the SCI are removed when the context is restarted.
`void`	`removeAttribute(String name)`
`void`	`setAttribute(String name, Object object)`
`boolean`	`setInitParameter(String name, String value)`
`void`	`setRequestCharacterEncoding(String encoding)`
`void`	`setResponseCharacterEncoding(String encoding)`
`void`	`setSessionTimeout(int sessionTimeout)`
`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

- Field Detail
  - LOG
```
public static final org.slf4j.Logger LOG
```
- Constructor Detail
  - OsgiDynamicServletContext
```
public OsgiDynamicServletContext(OsgiServletContext osgiContext,
                                 DynamicRegistrations registration)
```
- Method Detail
  - rememberAttributesFromSCIs
```
public void rememberAttributesFromSCIs()
```
    This method has to be called after SCIWrapper calls wrapped ServletContainerInitializer, so attributes potentially added by the SCI are removed when the context is restarted.
  - getOsgiContextModel
```
public OsgiContextModel getOsgiContextModel()
```
  - getContainerServletContext
```
public javax.servlet.ServletContext getContainerServletContext()
```
  - addFilter
```
public javax.servlet.FilterRegistration.Dynamic addFilter(String filterName,
                                                          String className)
```
    Specified by:
    
    addFilter in interface javax.servlet.ServletContext
  - addFilter
```
public javax.servlet.FilterRegistration.Dynamic addFilter(String filterName,
                                                          javax.servlet.Filter filter)
```
    Specified by:
    
    addFilter in interface javax.servlet.ServletContext
  - addFilter
```
public javax.servlet.FilterRegistration.Dynamic addFilter(String filterName,
                                                          Class<? extends javax.servlet.Filter> filterClass)
```
    Specified by:
    
    addFilter in interface javax.servlet.ServletContext
  - addListener
```
public void addListener(String className)
```
    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> listenerClass)
```
    Specified by:
    
    addListener in interface javax.servlet.ServletContext
  - addServlet
```
public javax.servlet.ServletRegistration.Dynamic addServlet(String servletName,
                                                            String className)
```
    Specified by:
    
    addServlet in interface javax.servlet.ServletContext
  - addServlet
```
public javax.servlet.ServletRegistration.Dynamic addServlet(String servletName,
                                                            javax.servlet.Servlet servlet)
```
    Specified by:
    
    addServlet in interface javax.servlet.ServletContext
  - addServlet
```
public javax.servlet.ServletRegistration.Dynamic addServlet(String servletName,
                                                            Class<? extends javax.servlet.Servlet> servletClass)
```
    Specified by:
    
    addServlet in interface javax.servlet.ServletContext
  - createFilter
```
public <T extends javax.servlet.Filter> T createFilter(Class<T> clazz)
                                                throws javax.servlet.ServletException
```
    Specified by:
    
    createFilter in interface javax.servlet.ServletContext
    
    Throws:
    
    javax.servlet.ServletException
  - createListener
```
public <T extends EventListener> T createListener(Class<T> clazz)
                                           throws javax.servlet.ServletException
```
    Specified by:
    
    createListener in interface javax.servlet.ServletContext
    
    Throws:
    
    javax.servlet.ServletException
  - createServlet
```
public <T extends javax.servlet.Servlet> T createServlet(Class<T> clazz)
                                                  throws javax.servlet.ServletException
```
    Specified by:
    
    createServlet in interface javax.servlet.ServletContext
    
    Throws:
    
    javax.servlet.ServletException
  - declareRoles
```
public void declareRoles(String... roleNames)
```
    Specified by:
    
    declareRoles in interface javax.servlet.ServletContext
  - setInitParameter
```
public boolean setInitParameter(String name,
                                String value)
```
    Specified by:
    
    setInitParameter in interface javax.servlet.ServletContext
  - setSessionTrackingModes
```
public void setSessionTrackingModes(Set<javax.servlet.SessionTrackingMode> sessionTrackingModes)
```
    Specified by:
    
    setSessionTrackingModes in interface javax.servlet.ServletContext
  - addJspFile
```
public javax.servlet.ServletRegistration.Dynamic addJspFile(String servletName,
                                                            String jspFile)
```
    Specified by:
    
    addJspFile in interface javax.servlet.ServletContext
  - 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
  - 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
  - getDefaultSessionTrackingModes
```
public Set<javax.servlet.SessionTrackingMode> getDefaultSessionTrackingModes()
```
    Specified by:
    
    getDefaultSessionTrackingModes 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
  - getEffectiveSessionTrackingModes
```
public Set<javax.servlet.SessionTrackingMode> getEffectiveSessionTrackingModes()
```
    Specified by:
    
    getEffectiveSessionTrackingModes in interface javax.servlet.ServletContext
  - getFilterRegistration
```
public javax.servlet.FilterRegistration getFilterRegistration(String filterName)
```
    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
  - getMajorVersion
```
public int getMajorVersion()
```
    Specified by:
    
    getMajorVersion in interface javax.servlet.ServletContext
  - getMinorVersion
```
public int getMinorVersion()
```
    Specified by:
    
    getMinorVersion 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
  - getServletNames
```
public Enumeration<String> getServletNames()
```
    Specified by:
    
    getServletNames in interface javax.servlet.ServletContext
  - getServletRegistration
```
public javax.servlet.ServletRegistration getServletRegistration(String servletName)
```
    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
  - getServlets
```
public Enumeration<javax.servlet.Servlet> getServlets()
```
    Specified by:
    
    getServlets in interface javax.servlet.ServletContext
  - getVirtualServerName
```
public String getVirtualServerName()
```
    Specified by:
    
    getVirtualServerName in interface javax.servlet.ServletContext
  - getServerInfo
```
public String getServerInfo()
```
    Specified by:
    
    getServerInfo 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
  - getSessionCookieConfig
```
public javax.servlet.SessionCookieConfig getSessionCookieConfig()
```
    Specified by:
    
    getSessionCookieConfig in interface javax.servlet.ServletContext
  - getJspConfigDescriptor
```
public javax.servlet.descriptor.JspConfigDescriptor getJspConfigDescriptor()
```
    Specified by:
    
    getJspConfigDescriptor in interface javax.servlet.ServletContext
  - getSessionTimeout
```
public int getSessionTimeout()
```
    Specified by:
    
    getSessionTimeout in interface javax.servlet.ServletContext
  - setSessionTimeout
```
public void setSessionTimeout(int sessionTimeout)
```
    Specified by:
    
    setSessionTimeout in interface javax.servlet.ServletContext
  - getRequestCharacterEncoding
```
public String getRequestCharacterEncoding()
```
    Specified by:
    
    getRequestCharacterEncoding in interface javax.servlet.ServletContext
  - setRequestCharacterEncoding
```
public void setRequestCharacterEncoding(String encoding)
```
    Specified by:
    
    setRequestCharacterEncoding in interface javax.servlet.ServletContext
  - getResponseCharacterEncoding
```
public String getResponseCharacterEncoding()
```
    Specified by:
    
    getResponseCharacterEncoding in interface javax.servlet.ServletContext
  - setResponseCharacterEncoding
```
public void setResponseCharacterEncoding(String encoding)
```
    Specified by:
    
    setResponseCharacterEncoding in interface javax.servlet.ServletContext
  - getMimeType
```
public String getMimeType(String file)
```
    Specified by:
    
    getMimeType in interface javax.servlet.ServletContext
  - getRealPath
```
public String getRealPath(String path)
```
    Specified by:
    
    getRealPath 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
  - getResourcePaths
```
public Set<String> getResourcePaths(String path)
```
    Specified by:
    
    getResourcePaths 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
  - 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
  - getServletContextName
```
public String getServletContextName()
```
    Specified by:
    
    getServletContextName in interface javax.servlet.ServletContext
  - getClassLoader
```
public ClassLoader getClassLoader()
```
    Specified by:
    
    getClassLoader in interface javax.servlet.ServletContext

Class OsgiDynamicServletContext

Field Summary

Fields inherited from interface javax.servlet.ServletContext

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

LOG

Constructor Detail

OsgiDynamicServletContext

Method Detail

rememberAttributesFromSCIs

getOsgiContextModel

getContainerServletContext

addFilter

addFilter

addFilter

addListener

addListener

addListener

addServlet

addServlet

addServlet

createFilter

createListener

createServlet

declareRoles

setInitParameter

setSessionTrackingModes

addJspFile

getAttribute

getAttributeNames

setAttribute

removeAttribute

getContextPath

getContext

getDefaultSessionTrackingModes

getEffectiveMajorVersion

getEffectiveMinorVersion

getEffectiveSessionTrackingModes

getFilterRegistration

getFilterRegistrations

getMajorVersion

getMinorVersion

getServlet

getServletNames

getServletRegistration

getServletRegistrations

getServlets

getVirtualServerName

getServerInfo

log

log

log

getSessionCookieConfig

getJspConfigDescriptor

getSessionTimeout

setSessionTimeout

getRequestCharacterEncoding

setRequestCharacterEncoding

getResponseCharacterEncoding

setResponseCharacterEncoding

getMimeType

getRealPath

getResource

getResourceAsStream

getResourcePaths

getInitParameter

getInitParameterNames

getRequestDispatcher

getNamedDispatcher

getServletContextName

getClassLoader