PortletServletContext (The ZKoss Web Library 9.6.6.1 API)

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

All Implemented Interfaces:

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

Author:

tomyeh

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`javax.servlet.FilterRegistration.Dynamic`	`addFilter(String s, Class<? extends javax.servlet.Filter> aClass)`
`javax.servlet.FilterRegistration.Dynamic`	`addFilter(String s, javax.servlet.Filter filter)`
`javax.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)`
`javax.servlet.ServletRegistration.Dynamic`	`addServlet(String s, Class<? extends javax.servlet.Servlet> aClass)`
`javax.servlet.ServletRegistration.Dynamic`	`addServlet(String s, javax.servlet.Servlet servlet)`
`javax.servlet.ServletRegistration.Dynamic`	`addServlet(String s, String s1)`
`<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 name)`
`Enumeration`	`getAttributeNames()`
`ClassLoader`	`getClassLoader()`
`javax.servlet.ServletContext`	`getContext(String path)`
`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 name)`
`Enumeration`	`getInitParameterNames()`
`static javax.servlet.ServletContext`	`getInstance(javax.portlet.PortletContext ctx)` Returns an instance of ServletContext that representing the specified portlet context.
`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`	`getResourcePaths(String path)`
`String`	`getServerInfo()`
`javax.servlet.Servlet`	`getServlet(String name)` Deprecated.
`String`	`getServletContextName()`
`Enumeration`	`getServletNames()` Deprecated.
`javax.servlet.ServletRegistration`	`getServletRegistration(String s)`
`Map<String,? extends javax.servlet.ServletRegistration>`	`getServletRegistrations()`
`Enumeration`	`getServlets()` Deprecated.
`javax.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<javax.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 javax.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 javax.servlet.ServletContext
  - getAttributeNames
```
public Enumeration getAttributeNames()
```
    Specified by:
    
    getAttributeNames in interface javax.servlet.ServletContext
  - getContext
```
public javax.servlet.ServletContext getContext(String path)
```
    Specified by:
    
    getContext in interface javax.servlet.ServletContext
  - getInitParameter
```
public String getInitParameter(String name)
```
    Specified by:
    
    getInitParameter in interface javax.servlet.ServletContext
  - getInitParameterNames
```
public Enumeration getInitParameterNames()
```
    Specified by:
    
    getInitParameterNames in interface javax.servlet.ServletContext
  - getMajorVersion
```
public int getMajorVersion()
```
    Specified by:
    
    getMajorVersion in interface javax.servlet.ServletContext
  - getMimeType
```
public String getMimeType(String file)
```
    Specified by:
    
    getMimeType in interface javax.servlet.ServletContext
  - getMinorVersion
```
public int getMinorVersion()
```
    Specified by:
    
    getMinorVersion in interface javax.servlet.ServletContext
  - getNamedDispatcher
```
public javax.servlet.RequestDispatcher getNamedDispatcher(String name)
```
    Specified by:
    
    getNamedDispatcher in interface javax.servlet.ServletContext
  - getRealPath
```
public String getRealPath(String path)
```
    Specified by:
    
    getRealPath in interface javax.servlet.ServletContext
  - getRequestDispatcher
```
public javax.servlet.RequestDispatcher getRequestDispatcher(String path)
```
    Specified by:
    
    getRequestDispatcher 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 getResourcePaths(String path)
```
    Specified by:
    
    getResourcePaths in interface javax.servlet.ServletContext
  - getServerInfo
```
public String getServerInfo()
```
    Specified by:
    
    getServerInfo in interface javax.servlet.ServletContext
  - getServlet
```
public javax.servlet.Servlet getServlet(String name)
```
    Deprecated.
    
    Specified by:
    
    getServlet in interface javax.servlet.ServletContext
  - getServletNames
```
public Enumeration getServletNames()
```
    Deprecated.
    
    Specified by:
    
    getServletNames in interface javax.servlet.ServletContext
  - getServlets
```
public Enumeration getServlets()
```
    Deprecated.
    
    Specified by:
    
    getServlets in interface javax.servlet.ServletContext
  - getServletContextName
```
public String getServletContextName()
```
    Specified by:
    
    getServletContextName in interface javax.servlet.ServletContext
  - log
```
public void log(Exception exception,
                String msg)
```
    Deprecated.
    
    Specified by:
    
    log in interface javax.servlet.ServletContext
  - log
```
public void log(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
  - removeAttribute
```
public void removeAttribute(String name)
```
    Specified by:
    
    removeAttribute in interface javax.servlet.ServletContext
  - setAttribute
```
public void setAttribute(String name,
                         Object object)
```
    Specified by:
    
    setAttribute in interface javax.servlet.ServletContext
  - getContextPath
```
public String getContextPath()
```
    Specified by:
    
    getContextPath 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
  - setInitParameter
```
public boolean setInitParameter(String s,
                                String s1)
```
    Specified by:
    
    setInitParameter 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 PortletServletContext

Field Summary

Fields inherited from interface javax.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