PortletServletContext (The ZKoss Web Library 9.6.6 API)

java.lang.Object
- org.zkoss.web.portlet.PortletServletContext

All Implemented Interfaces:

jakarta.servlet.ServletContext
```
public class PortletServletContext
extends Object
implements jakarta.servlet.ServletContext
```
A facade servlet context based on a given portlet context.

Author:

tomyeh

Field Summary
- Fields inherited from interface jakarta.servlet.ServletContext
  ORDERED_LIBS, TEMPDIR

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`jakarta.servlet.FilterRegistration.Dynamic`	`addFilter(String s, Class<? extends jakarta.servlet.Filter> aClass)`
`jakarta.servlet.FilterRegistration.Dynamic`	`addFilter(String s, jakarta.servlet.Filter filter)`
`jakarta.servlet.FilterRegistration.Dynamic`	`addFilter(String s, String s1)`
`void`	`addListener(Class<? extends EventListener> aClass)`
`void`	`addListener(String s)`
`<T extends EventListener> void`	`addListener(T t)`
`jakarta.servlet.ServletRegistration.Dynamic`	`addServlet(String s, Class<? extends jakarta.servlet.Servlet> aClass)`
`jakarta.servlet.ServletRegistration.Dynamic`	`addServlet(String s, jakarta.servlet.Servlet servlet)`
`jakarta.servlet.ServletRegistration.Dynamic`	`addServlet(String s, String s1)`
`<T extends jakarta.servlet.Filter> T`	`createFilter(Class<T> aClass)`
`<T extends EventListener> T`	`createListener(Class<T> aClass)`
`<T extends jakarta.servlet.Servlet> T`	`createServlet(Class<T> aClass)`
`void`	`declareRoles(String... strings)`
`Object`	`getAttribute(String name)`
`Enumeration`	`getAttributeNames()`
`ClassLoader`	`getClassLoader()`
`jakarta.servlet.ServletContext`	`getContext(String path)`
`String`	`getContextPath()`
`Set<jakarta.servlet.SessionTrackingMode>`	`getDefaultSessionTrackingModes()`
`int`	`getEffectiveMajorVersion()`
`int`	`getEffectiveMinorVersion()`
`Set<jakarta.servlet.SessionTrackingMode>`	`getEffectiveSessionTrackingModes()`
`jakarta.servlet.FilterRegistration`	`getFilterRegistration(String s)`
`Map<String,? extends jakarta.servlet.FilterRegistration>`	`getFilterRegistrations()`
`String`	`getInitParameter(String name)`
`Enumeration`	`getInitParameterNames()`
`static jakarta.servlet.ServletContext`	`getInstance(javax.portlet.PortletContext ctx)` Returns an instance of ServletContext that representing the specified portlet context.
`jakarta.servlet.descriptor.JspConfigDescriptor`	`getJspConfigDescriptor()`
`int`	`getMajorVersion()`
`String`	`getMimeType(String file)`
`int`	`getMinorVersion()`
`jakarta.servlet.RequestDispatcher`	`getNamedDispatcher(String name)`
`String`	`getRealPath(String path)`
`jakarta.servlet.RequestDispatcher`	`getRequestDispatcher(String path)`
`URL`	`getResource(String path)`
`InputStream`	`getResourceAsStream(String path)`
`Set`	`getResourcePaths(String path)`
`String`	`getServerInfo()`
`jakarta.servlet.Servlet`	`getServlet(String name)` Deprecated.
`String`	`getServletContextName()`
`Enumeration`	`getServletNames()` Deprecated.
`jakarta.servlet.ServletRegistration`	`getServletRegistration(String s)`
`Map<String,? extends jakarta.servlet.ServletRegistration>`	`getServletRegistrations()`
`Enumeration`	`getServlets()` Deprecated.
`jakarta.servlet.SessionCookieConfig`	`getSessionCookieConfig()`
`String`	`getVirtualServerName()`
`void`	`log(Exception exception, String msg)` Deprecated.
`void`	`log(String msg)`
`void`	`log(String message, Throwable throwable)`
`void`	`removeAttribute(String name)`
`void`	`setAttribute(String name, Object object)`
`boolean`	`setInitParameter(String s, String s1)`
`void`	`setSessionTrackingModes(Set<jakarta.servlet.SessionTrackingMode> set)`

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

- Method Detail
  - getInstance
```
public static jakarta.servlet.ServletContext getInstance(javax.portlet.PortletContext ctx)
```
    Returns an instance of ServletContext that representing the specified portlet context.
    Use this method instead of the constructor.
  - getAttribute
```
public Object getAttribute(String name)
```
    Specified by:
    
    getAttribute in interface jakarta.servlet.ServletContext
  - getAttributeNames
```
public Enumeration getAttributeNames()
```
    Specified by:
    
    getAttributeNames in interface jakarta.servlet.ServletContext
  - getContext
```
public jakarta.servlet.ServletContext getContext(String path)
```
    Specified by:
    
    getContext in interface jakarta.servlet.ServletContext
  - getInitParameter
```
public String getInitParameter(String name)
```
    Specified by:
    
    getInitParameter in interface jakarta.servlet.ServletContext
  - getInitParameterNames
```
public Enumeration getInitParameterNames()
```
    Specified by:
    
    getInitParameterNames in interface jakarta.servlet.ServletContext
  - getMajorVersion
```
public int getMajorVersion()
```
    Specified by:
    
    getMajorVersion in interface jakarta.servlet.ServletContext
  - getMimeType
```
public String getMimeType(String file)
```
    Specified by:
    
    getMimeType in interface jakarta.servlet.ServletContext
  - getMinorVersion
```
public int getMinorVersion()
```
    Specified by:
    
    getMinorVersion in interface jakarta.servlet.ServletContext
  - getNamedDispatcher
```
public jakarta.servlet.RequestDispatcher getNamedDispatcher(String name)
```
    Specified by:
    
    getNamedDispatcher in interface jakarta.servlet.ServletContext
  - getRealPath
```
public String getRealPath(String path)
```
    Specified by:
    
    getRealPath in interface jakarta.servlet.ServletContext
  - getRequestDispatcher
```
public jakarta.servlet.RequestDispatcher getRequestDispatcher(String path)
```
    Specified by:
    
    getRequestDispatcher in interface jakarta.servlet.ServletContext
  - getResource
```
public URL getResource(String path)
                throws MalformedURLException
```
    Specified by:
    
    getResource in interface jakarta.servlet.ServletContext
    
    Throws:
    
    MalformedURLException
  - getResourceAsStream
```
public InputStream getResourceAsStream(String path)
```
    Specified by:
    
    getResourceAsStream in interface jakarta.servlet.ServletContext
  - getResourcePaths
```
public Set getResourcePaths(String path)
```
    Specified by:
    
    getResourcePaths in interface jakarta.servlet.ServletContext
  - getServerInfo
```
public String getServerInfo()
```
    Specified by:
    
    getServerInfo in interface jakarta.servlet.ServletContext
  - getServlet
```
public jakarta.servlet.Servlet getServlet(String name)
```
    Deprecated.
    
    Specified by:
    
    getServlet in interface jakarta.servlet.ServletContext
  - getServletNames
```
public Enumeration getServletNames()
```
    Deprecated.
    
    Specified by:
    
    getServletNames in interface jakarta.servlet.ServletContext
  - getServlets
```
public Enumeration getServlets()
```
    Deprecated.
    
    Specified by:
    
    getServlets in interface jakarta.servlet.ServletContext
  - getServletContextName
```
public String getServletContextName()
```
    Specified by:
    
    getServletContextName in interface jakarta.servlet.ServletContext
  - log
```
public void log(Exception exception,
                String msg)
```
    Deprecated.
    
    Specified by:
    
    log in interface jakarta.servlet.ServletContext
  - log
```
public void log(String msg)
```
    Specified by:
    
    log in interface jakarta.servlet.ServletContext
  - log
```
public void log(String message,
                Throwable throwable)
```
    Specified by:
    
    log in interface jakarta.servlet.ServletContext
  - removeAttribute
```
public void removeAttribute(String name)
```
    Specified by:
    
    removeAttribute in interface jakarta.servlet.ServletContext
  - setAttribute
```
public void setAttribute(String name,
                         Object object)
```
    Specified by:
    
    setAttribute in interface jakarta.servlet.ServletContext
  - getContextPath
```
public String getContextPath()
```
    Specified by:
    
    getContextPath in interface jakarta.servlet.ServletContext
  - getEffectiveMajorVersion
```
public int getEffectiveMajorVersion()
```
    Specified by:
    
    getEffectiveMajorVersion in interface jakarta.servlet.ServletContext
  - getEffectiveMinorVersion
```
public int getEffectiveMinorVersion()
```
    Specified by:
    
    getEffectiveMinorVersion in interface jakarta.servlet.ServletContext
  - setInitParameter
```
public boolean setInitParameter(String s,
                                String s1)
```
    Specified by:
    
    setInitParameter in interface jakarta.servlet.ServletContext
  - addServlet
```
public jakarta.servlet.ServletRegistration.Dynamic addServlet(String s,
                                                            String s1)
```
    Specified by:
    
    addServlet in interface jakarta.servlet.ServletContext
  - addServlet
```
public jakarta.servlet.ServletRegistration.Dynamic addServlet(String s,
                                                            jakarta.servlet.Servlet servlet)
```
    Specified by:
    
    addServlet in interface jakarta.servlet.ServletContext
  - addServlet
```
public jakarta.servlet.ServletRegistration.Dynamic addServlet(String s,
                                                            Class<? extends jakarta.servlet.Servlet> aClass)
```
    Specified by:
    
    addServlet in interface jakarta.servlet.ServletContext
  - createServlet
```
public <T extends jakarta.servlet.Servlet> T createServlet(Class<T> aClass)
                                                  throws jakarta.servlet.ServletException
```
    Specified by:
    
    createServlet in interface jakarta.servlet.ServletContext
    
    Throws:
    
    jakarta.servlet.ServletException
  - getServletRegistration
```
public jakarta.servlet.ServletRegistration getServletRegistration(String s)
```
    Specified by:
    
    getServletRegistration in interface jakarta.servlet.ServletContext
  - getServletRegistrations
```
public Map<String,? extends jakarta.servlet.ServletRegistration> getServletRegistrations()
```
    Specified by:
    
    getServletRegistrations in interface jakarta.servlet.ServletContext
  - addFilter
```
public jakarta.servlet.FilterRegistration.Dynamic addFilter(String s,
                                                          String s1)
```
    Specified by:
    
    addFilter in interface jakarta.servlet.ServletContext
  - addFilter
```
public jakarta.servlet.FilterRegistration.Dynamic addFilter(String s,
                                                          jakarta.servlet.Filter filter)
```
    Specified by:
    
    addFilter in interface jakarta.servlet.ServletContext
  - addFilter
```
public jakarta.servlet.FilterRegistration.Dynamic addFilter(String s,
                                                          Class<? extends jakarta.servlet.Filter> aClass)
```
    Specified by:
    
    addFilter in interface jakarta.servlet.ServletContext
  - createFilter
```
public <T extends jakarta.servlet.Filter> T createFilter(Class<T> aClass)
                                                throws jakarta.servlet.ServletException
```
    Specified by:
    
    createFilter in interface jakarta.servlet.ServletContext
    
    Throws:
    
    jakarta.servlet.ServletException
  - getFilterRegistration
```
public jakarta.servlet.FilterRegistration getFilterRegistration(String s)
```
    Specified by:
    
    getFilterRegistration in interface jakarta.servlet.ServletContext
  - getFilterRegistrations
```
public Map<String,? extends jakarta.servlet.FilterRegistration> getFilterRegistrations()
```
    Specified by:
    
    getFilterRegistrations in interface jakarta.servlet.ServletContext
  - getSessionCookieConfig
```
public jakarta.servlet.SessionCookieConfig getSessionCookieConfig()
```
    Specified by:
    
    getSessionCookieConfig in interface jakarta.servlet.ServletContext
  - setSessionTrackingModes
```
public void setSessionTrackingModes(Set<jakarta.servlet.SessionTrackingMode> set)
```
    Specified by:
    
    setSessionTrackingModes in interface jakarta.servlet.ServletContext
  - getDefaultSessionTrackingModes
```
public Set<jakarta.servlet.SessionTrackingMode> getDefaultSessionTrackingModes()
```
    Specified by:
    
    getDefaultSessionTrackingModes in interface jakarta.servlet.ServletContext
  - getEffectiveSessionTrackingModes
```
public Set<jakarta.servlet.SessionTrackingMode> getEffectiveSessionTrackingModes()
```
    Specified by:
    
    getEffectiveSessionTrackingModes in interface jakarta.servlet.ServletContext
  - addListener
```
public void addListener(String s)
```
    Specified by:
    
    addListener in interface jakarta.servlet.ServletContext
  - addListener
```
public <T extends EventListener> void addListener(T t)
```
    Specified by:
    
    addListener in interface jakarta.servlet.ServletContext
  - addListener
```
public void addListener(Class<? extends EventListener> aClass)
```
    Specified by:
    
    addListener in interface jakarta.servlet.ServletContext
  - createListener
```
public <T extends EventListener> T createListener(Class<T> aClass)
                                           throws jakarta.servlet.ServletException
```
    Specified by:
    
    createListener in interface jakarta.servlet.ServletContext
    
    Throws:
    
    jakarta.servlet.ServletException
  - getJspConfigDescriptor
```
public jakarta.servlet.descriptor.JspConfigDescriptor getJspConfigDescriptor()
```
    Specified by:
    
    getJspConfigDescriptor in interface jakarta.servlet.ServletContext
  - getClassLoader
```
public ClassLoader getClassLoader()
```
    Specified by:
    
    getClassLoader in interface jakarta.servlet.ServletContext
  - declareRoles
```
public void declareRoles(String... strings)
```
    Specified by:
    
    declareRoles in interface jakarta.servlet.ServletContext
  - getVirtualServerName
```
public String getVirtualServerName()
```
    Specified by:
    
    getVirtualServerName in interface jakarta.servlet.ServletContext

Class PortletServletContext

Field Summary

Fields inherited from interface jakarta.servlet.ServletContext

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getInstance

getAttribute

getAttributeNames

getContext

getInitParameter

getInitParameterNames

getMajorVersion

getMimeType

getMinorVersion

getNamedDispatcher

getRealPath

getRequestDispatcher

getResource

getResourceAsStream

getResourcePaths

getServerInfo

getServlet

getServletNames

getServlets

getServletContextName

log

log

log

removeAttribute

setAttribute

getContextPath

getEffectiveMajorVersion

getEffectiveMinorVersion

setInitParameter

addServlet

addServlet

addServlet

createServlet

getServletRegistration

getServletRegistrations

addFilter

addFilter

addFilter

createFilter

getFilterRegistration

getFilterRegistrations

getSessionCookieConfig

setSessionTrackingModes

getDefaultSessionTrackingModes

getEffectiveSessionTrackingModes

addListener

addListener

addListener

createListener

getJspConfigDescriptor

getClassLoader

declareRoles

getVirtualServerName