ServletContextHolder (oscana-s2n-runtime-struts 1.0.0 API)

java.lang.Object
- oscana.s2n.servlet.ServletContextHolder

すべての実装されたインタフェース:

javax.servlet.ServletContext
```
@RequestScoped
public class ServletContextHolder
extends Object
implements javax.servlet.ServletContext
```
ServletContextのI/Fを提供するリソースホルダクラス。

NablarchのDIコンテナには以下のサーブレットリソースは直接@Injectアノテーションで注入することができない。
・javax.servlet.ServletContext
・javax.servlet.http.HttpServletResponse
・javax.servlet.http.HttpServletRequest
・javax.servlet.http.HttpSession

本機能は以下の方式により、@Resourceにてサーブレットリソースを注入しているアプリケーションを移行できるようにしたものである。
・@Injectで注入するものはサーブレットリソースではなく、各サーブレットリソースと同じI/Fを有するリソースホルダーとする。
・リソースホルダーにはサーブレットリソースへの参照を持たせることができ、アプリケーションがリソースホルダーの各メソッドを呼び出すとサーブレットリソースに移譲される仕組みである。
・HttpResourceHolderHandler,HttpResourceHolderUpdateHandlerがリソースホルダーにサーブレットリソースへの参照を登録する。

[構成]
■リソースホルダ
・oscana.s2n.handler.HttpResourceHolder - サーブレットリソースへの参照を保持するリソースホルダ
・oscana.s2n.servlet.HttpServletRequestHolder - HttpServletのI/Fを提供するリソースホルダ
・oscana.s2n.servlet.HttpServletResponseHolder - HttpServletResponseのI/Fを提供するリソースホルダ
・oscana.s2n.servlet.HttpSessionHolder - HttpSessionのI/Fを提供するリソースホルダ
・oscana.s2n.servlet.ServletContextHolder - ServletContextのI/Fを提供するリソースホルダ
■ハンドラ
・oscana.s2n.handler.HttpResourceHolderHandler- サーブレットリソースの投入、削除を行う
・oscana.s2n.handler.HttpResourceHolderUpdateHandler- サーブレットリソースのリフレッシュを行う

作成者:

Fumihiko Yamamoto

フィールドのサマリー

フィールド
修飾子とタイプフィールドと説明

HttpResourceHolder holder
- インタフェースから継承されたフィールド javax.servlet.ServletContext
  ORDERED_LIBS, TEMPDIR

フィールド
修飾子とタイプ	フィールドと説明
`HttpResourceHolder`	`holder`

コンストラクタのサマリー

コンストラクタ
コンストラクタと説明

ServletContextHolder()

コンストラクタ
コンストラクタと説明
`ServletContextHolder()`

メソッドのサマリー

すべてのメソッドインスタンス・メソッド concreteメソッド非推奨のメソッド
修飾子とタイプ	メソッドと説明
`javax.servlet.FilterRegistration.Dynamic`	`addFilter(String filterName, Class<? extends javax.servlet.Filter> filterClass)` ServletContext().addFilterに移譲する。
`javax.servlet.FilterRegistration.Dynamic`	`addFilter(String filterName, javax.servlet.Filter filter)` ServletContext().addFilterに移譲する。
`javax.servlet.FilterRegistration.Dynamic`	`addFilter(String filterName, String className)` ServletContext().addFilterに移譲する。
`void`	`addListener(Class<? extends EventListener> listenerClass)` ServletContext().addListenerに移譲する。
`void`	`addListener(String className)` ServletContext().addListenerに移譲する。
`<T extends EventListener> void`	`addListener(T t)` ServletContext().addListenerに移譲する。
`javax.servlet.ServletRegistration.Dynamic`	`addServlet(String servletName, Class<? extends javax.servlet.Servlet> servletClass)` ServletContext().addServletに移譲する。
`javax.servlet.ServletRegistration.Dynamic`	`addServlet(String servletName, javax.servlet.Servlet servlet)` ServletContext().addServletに移譲する。
`javax.servlet.ServletRegistration.Dynamic`	`addServlet(String servletName, String className)` ServletContext().addServletに移譲する。
`<T extends javax.servlet.Filter> T`	`createFilter(Class<T> clazz)` ServletContext().createFilterに移譲する。
`<T extends EventListener> T`	`createListener(Class<T> clazz)` ServletContext().createListenerに移譲する。
`<T extends javax.servlet.Servlet> T`	`createServlet(Class<T> clazz)` ServletContext().createServletに移譲する。
`void`	`declareRoles(String... roleNames)` ServletContext().declareRolesに移譲する。
`Object`	`getAttribute(String name)`
`Enumeration<String>`	`getAttributeNames()`
`ClassLoader`	`getClassLoader()` ServletContext().getClassLoaderに移譲する。
`javax.servlet.ServletContext`	`getContext(String uripath)`
`String`	`getContextPath()` ServletContext().getContextPathに移譲する。
`Set<javax.servlet.SessionTrackingMode>`	`getDefaultSessionTrackingModes()` ServletContext().getDefaultSessionTrackingModesに移譲する。
`int`	`getEffectiveMajorVersion()` ServletContext().getEffectiveMajorVersionに移譲する。
`int`	`getEffectiveMinorVersion()` ServletContext().getEffectiveMinorVersionに移譲する。
`Set<javax.servlet.SessionTrackingMode>`	`getEffectiveSessionTrackingModes()` ServletContext().getEffectiveSessionTrackingModesに移譲する。
`javax.servlet.FilterRegistration`	`getFilterRegistration(String filterName)` ServletContext().getFilterRegistrationに移譲する。
`Map<String,? extends javax.servlet.FilterRegistration>`	`getFilterRegistrations()` ServletContext().getFilterRegistrationsに移譲する。
`String`	`getInitParameter(String name)`
`Enumeration<String>`	`getInitParameterNames()`
`javax.servlet.descriptor.JspConfigDescriptor`	`getJspConfigDescriptor()` ServletContext().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)` ServletContext().getServletRegistrationに移譲する。
`Map<String,? extends javax.servlet.ServletRegistration>`	`getServletRegistrations()` ServletContext().getServletRegistrationsに移譲する。
`Enumeration<javax.servlet.Servlet>`	`getServlets()` 非推奨です。
`javax.servlet.SessionCookieConfig`	`getSessionCookieConfig()` ServletContext().getSessionCookieConfigに移譲する。
`String`	`getVirtualServerName()` ServletContext().getVirtualServerNameに移譲する。
`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)` ServletContext().setInitParameterに移譲する。
`void`	`setSessionTrackingModes(Set<javax.servlet.SessionTrackingMode> sessionTrackingModes)` ServletContext().setSessionTrackingModesに移譲する。

クラスから継承されたメソッド java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- フィールドの詳細
  - holder
```
@Inject
public HttpResourceHolder holder
```
- コンストラクタの詳細
  - ServletContextHolder
```
public ServletContextHolder()
```
- メソッドの詳細
  - getContext
```
public javax.servlet.ServletContext getContext(String uripath)
```
    定義:
    
    getContext インタフェース内 javax.servlet.ServletContext
    
    パラメータ:
    
    uripath - uriパス
    
    戻り値:
    
    ServletContext
    
    関連項目:
    
    ServletContext.getContext(java.lang.String)
  - getMajorVersion
```
public int getMajorVersion()
```
    定義:
    
    getMajorVersion インタフェース内 javax.servlet.ServletContext
    
    戻り値:
    
    version
    
    関連項目:
    
    ServletContext.getMajorVersion()
  - getMinorVersion
```
public int getMinorVersion()
```
    定義:
    
    getMinorVersion インタフェース内 javax.servlet.ServletContext
    
    戻り値:
    
    minorVersion
    
    関連項目:
    
    ServletContext.getMinorVersion()
  - getMimeType
```
public String getMimeType(String file)
```
    定義:
    
    getMimeType インタフェース内 javax.servlet.ServletContext
    
    パラメータ:
    
    file - ファイル
    
    戻り値:
    
    mimeType
    
    関連項目:
    
    ServletContext.getMimeType(java.lang.String)
  - getResourcePaths
```
public Set<String> getResourcePaths(String path)
```
    定義:
    
    getResourcePaths インタフェース内 javax.servlet.ServletContext
    
    パラメータ:
    
    path - パス
    
    戻り値:
    
    Set
    
    関連項目:
    
    ServletContext.getResourcePaths(java.lang.String)
  - getResource
```
public URL getResource(String path)
                throws MalformedURLException
```
    定義:
    
    getResource インタフェース内 javax.servlet.ServletContext
    
    パラメータ:
    
    path - パス
    
    戻り値:
    
    URL
    
    例外:
    
    MalformedURLException - if the pathname is not given inthe correct form
    
    関連項目:
    
    ServletContext.getResource(java.lang.String)
  - getResourceAsStream
```
public InputStream getResourceAsStream(String path)
```
    定義:
    
    getResourceAsStream インタフェース内 javax.servlet.ServletContext
    
    パラメータ:
    
    path - パス
    
    戻り値:
    
    入力ストリーム
    
    関連項目:
    
    ServletContext.getResourceAsStream(java.lang.String)
  - getRequestDispatcher
```
public javax.servlet.RequestDispatcher getRequestDispatcher(String path)
```
    定義:
    
    getRequestDispatcher インタフェース内 javax.servlet.ServletContext
    
    パラメータ:
    
    path - パス
    
    戻り値:
    
    RequestDispatcher
    
    関連項目:
    
    ServletContext.getRequestDispatcher(java.lang.String)
  - getNamedDispatcher
```
public javax.servlet.RequestDispatcher getNamedDispatcher(String name)
```
    定義:
    
    getNamedDispatcher インタフェース内 javax.servlet.ServletContext
    
    パラメータ:
    
    name - パラメータ名
    
    戻り値:
    
    RequestDispatcher
    
    関連項目:
    
    ServletContext.getNamedDispatcher(java.lang.String)
  - getServlet
```
public javax.servlet.Servlet getServlet(String name)
                                 throws javax.servlet.ServletException
```
    非推奨です。
    
    定義:
    
    getServlet インタフェース内 javax.servlet.ServletContext
    
    パラメータ:
    
    name - パラメータ名
    
    戻り値:
    
    Servlet
    
    例外:
    
    javax.servlet.ServletException - ServletException
    
    関連項目:
    
    ServletContext.getServlet(java.lang.String)
  - getServlets
```
public Enumeration<javax.servlet.Servlet> getServlets()
```
    非推奨です。
    
    定義:
    
    getServlets インタフェース内 javax.servlet.ServletContext
    
    戻り値:
    
    Enumeration
    
    関連項目:
    
    ServletContext.getServlets()
  - getServletNames
```
public Enumeration<String> getServletNames()
```
    非推奨です。
    
    定義:
    
    getServletNames インタフェース内 javax.servlet.ServletContext
    
    戻り値:
    
    Enumeration
    
    関連項目:
    
    ServletContext.getServletNames()
  - log
```
public void log(String msg)
```
    定義:
    
    log インタフェース内 javax.servlet.ServletContext
    
    パラメータ:
    
    msg - メッセージ
    
    関連項目:
    
    ServletContext.log(java.lang.String)
  - log
```
public void log(Exception exception,
                String msg)
```
    非推奨です。
    
    定義:
    
    log インタフェース内 javax.servlet.ServletContext
    
    パラメータ:
    
    exception - 例外
    
    msg - メッセージ
    
    関連項目:
    
    ServletContext.log(java.lang.Exception, java.lang.String)
  - log
```
public void log(String message,
                Throwable throwable)
```
    定義:
    
    log インタフェース内 javax.servlet.ServletContext
    
    パラメータ:
    
    message - メッセージ
    
    throwable - throwable
    
    関連項目:
    
    ServletContext.log(java.lang.String, java.lang.Throwable)
  - getRealPath
```
public String getRealPath(String path)
```
    定義:
    
    getRealPath インタフェース内 javax.servlet.ServletContext
    
    パラメータ:
    
    path - パス
    
    戻り値:
    
    パス
    
    関連項目:
    
    ServletContext.getRealPath(java.lang.String)
  - getServerInfo
```
public String getServerInfo()
```
    定義:
    
    getServerInfo インタフェース内 javax.servlet.ServletContext
    
    戻り値:
    
    サーバー情報
    
    関連項目:
    
    ServletContext.getServerInfo()
  - getInitParameter
```
public String getInitParameter(String name)
```
    定義:
    
    getInitParameter インタフェース内 javax.servlet.ServletContext
    
    パラメータ:
    
    name - パラメータ名
    
    戻り値:
    
    パラメータ
    
    関連項目:
    
    ServletContext.getInitParameter(java.lang.String)
  - getInitParameterNames
```
public Enumeration<String> getInitParameterNames()
```
    定義:
    
    getInitParameterNames インタフェース内 javax.servlet.ServletContext
    
    戻り値:
    
    Enumeration
    
    関連項目:
    
    ServletContext.getInitParameterNames()
  - getAttribute
```
public Object getAttribute(String name)
```
    定義:
    
    getAttribute インタフェース内 javax.servlet.ServletContext
    
    パラメータ:
    
    name - パラメータ名
    
    戻り値:
    
    オブジェクト
    
    関連項目:
    
    ServletContext.getAttribute(java.lang.String)
  - getAttributeNames
```
public Enumeration<String> getAttributeNames()
```
    定義:
    
    getAttributeNames インタフェース内 javax.servlet.ServletContext
    
    戻り値:
    
    Enumeration
    
    関連項目:
    
    ServletContext.getAttributeNames()
  - setAttribute
```
public void setAttribute(String name,
                         Object object)
```
    定義:
    
    setAttribute インタフェース内 javax.servlet.ServletContext
    
    パラメータ:
    
    name - パラメータ名
    
    object - オブジェクト
    
    関連項目:
    
    ServletContext.setAttribute(java.lang.String, java.lang.Object)
  - removeAttribute
```
public void removeAttribute(String name)
```
    定義:
    
    removeAttribute インタフェース内 javax.servlet.ServletContext
    
    パラメータ:
    
    name - パラメータ名
    
    関連項目:
    
    ServletContext.removeAttribute(java.lang.String)
  - getServletContextName
```
public String getServletContextName()
```
    定義:
    
    getServletContextName インタフェース内 javax.servlet.ServletContext
    
    戻り値:
    
    コンテキスト名
    
    関連項目:
    
    ServletContext.getServletContextName()
  - getContextPath
```
public String getContextPath()
```
    ServletContext().getContextPathに移譲する。
    
    定義:
    
    getContextPath インタフェース内 javax.servlet.ServletContext
  - getEffectiveMajorVersion
```
public int getEffectiveMajorVersion()
```
    ServletContext().getEffectiveMajorVersionに移譲する。
    
    定義:
    
    getEffectiveMajorVersion インタフェース内 javax.servlet.ServletContext
  - getEffectiveMinorVersion
```
public int getEffectiveMinorVersion()
```
    ServletContext().getEffectiveMinorVersionに移譲する。
    
    定義:
    
    getEffectiveMinorVersion インタフェース内 javax.servlet.ServletContext
  - setInitParameter
```
public boolean setInitParameter(String name,
                                String value)
```
    ServletContext().setInitParameterに移譲する。
    
    定義:
    
    setInitParameter インタフェース内 javax.servlet.ServletContext
  - addServlet
```
public javax.servlet.ServletRegistration.Dynamic addServlet(String servletName,
                                                            String className)
```
    ServletContext().addServletに移譲する。
    
    定義:
    
    addServlet インタフェース内 javax.servlet.ServletContext
  - addServlet
```
public javax.servlet.ServletRegistration.Dynamic addServlet(String servletName,
                                                            javax.servlet.Servlet servlet)
```
    ServletContext().addServletに移譲する。
    
    定義:
    
    addServlet インタフェース内 javax.servlet.ServletContext
  - addServlet
```
public javax.servlet.ServletRegistration.Dynamic addServlet(String servletName,
                                                            Class<? extends javax.servlet.Servlet> servletClass)
```
    ServletContext().addServletに移譲する。
    
    定義:
    
    addServlet インタフェース内 javax.servlet.ServletContext
  - createServlet
```
public <T extends javax.servlet.Servlet> T createServlet(Class<T> clazz)
                                                  throws javax.servlet.ServletException
```
    ServletContext().createServletに移譲する。
    
    定義:
    
    createServlet インタフェース内 javax.servlet.ServletContext
    
    例外:
    
    javax.servlet.ServletException
  - getServletRegistration
```
public javax.servlet.ServletRegistration getServletRegistration(String servletName)
```
    ServletContext().getServletRegistrationに移譲する。
    
    定義:
    
    getServletRegistration インタフェース内 javax.servlet.ServletContext
  - getServletRegistrations
```
public Map<String,? extends javax.servlet.ServletRegistration> getServletRegistrations()
```
    ServletContext().getServletRegistrationsに移譲する。
    
    定義:
    
    getServletRegistrations インタフェース内 javax.servlet.ServletContext
  - addFilter
```
public javax.servlet.FilterRegistration.Dynamic addFilter(String filterName,
                                                          String className)
```
    ServletContext().addFilterに移譲する。
    
    定義:
    
    addFilter インタフェース内 javax.servlet.ServletContext
  - addFilter
```
public javax.servlet.FilterRegistration.Dynamic addFilter(String filterName,
                                                          javax.servlet.Filter filter)
```
    ServletContext().addFilterに移譲する。
    
    定義:
    
    addFilter インタフェース内 javax.servlet.ServletContext
  - addFilter
```
public javax.servlet.FilterRegistration.Dynamic addFilter(String filterName,
                                                          Class<? extends javax.servlet.Filter> filterClass)
```
    ServletContext().addFilterに移譲する。
    
    定義:
    
    addFilter インタフェース内 javax.servlet.ServletContext
  - createFilter
```
public <T extends javax.servlet.Filter> T createFilter(Class<T> clazz)
                                                throws javax.servlet.ServletException
```
    ServletContext().createFilterに移譲する。
    
    定義:
    
    createFilter インタフェース内 javax.servlet.ServletContext
    
    例外:
    
    javax.servlet.ServletException
  - getFilterRegistration
```
public javax.servlet.FilterRegistration getFilterRegistration(String filterName)
```
    ServletContext().getFilterRegistrationに移譲する。
    
    定義:
    
    getFilterRegistration インタフェース内 javax.servlet.ServletContext
  - getFilterRegistrations
```
public Map<String,? extends javax.servlet.FilterRegistration> getFilterRegistrations()
```
    ServletContext().getFilterRegistrationsに移譲する。
    
    定義:
    
    getFilterRegistrations インタフェース内 javax.servlet.ServletContext
  - getSessionCookieConfig
```
public javax.servlet.SessionCookieConfig getSessionCookieConfig()
```
    ServletContext().getSessionCookieConfigに移譲する。
    
    定義:
    
    getSessionCookieConfig インタフェース内 javax.servlet.ServletContext
  - setSessionTrackingModes
```
public void setSessionTrackingModes(Set<javax.servlet.SessionTrackingMode> sessionTrackingModes)
```
    ServletContext().setSessionTrackingModesに移譲する。
    
    定義:
    
    setSessionTrackingModes インタフェース内 javax.servlet.ServletContext
  - getDefaultSessionTrackingModes
```
public Set<javax.servlet.SessionTrackingMode> getDefaultSessionTrackingModes()
```
    ServletContext().getDefaultSessionTrackingModesに移譲する。
    
    定義:
    
    getDefaultSessionTrackingModes インタフェース内 javax.servlet.ServletContext
  - getEffectiveSessionTrackingModes
```
public Set<javax.servlet.SessionTrackingMode> getEffectiveSessionTrackingModes()
```
    ServletContext().getEffectiveSessionTrackingModesに移譲する。
    
    定義:
    
    getEffectiveSessionTrackingModes インタフェース内 javax.servlet.ServletContext
  - addListener
```
public void addListener(String className)
```
    ServletContext().addListenerに移譲する。
    
    定義:
    
    addListener インタフェース内 javax.servlet.ServletContext
  - addListener
```
public <T extends EventListener> void addListener(T t)
```
    ServletContext().addListenerに移譲する。
    
    定義:
    
    addListener インタフェース内 javax.servlet.ServletContext
  - addListener
```
public void addListener(Class<? extends EventListener> listenerClass)
```
    ServletContext().addListenerに移譲する。
    
    定義:
    
    addListener インタフェース内 javax.servlet.ServletContext
  - createListener
```
public <T extends EventListener> T createListener(Class<T> clazz)
                                           throws javax.servlet.ServletException
```
    ServletContext().createListenerに移譲する。
    
    定義:
    
    createListener インタフェース内 javax.servlet.ServletContext
    
    例外:
    
    javax.servlet.ServletException
  - getJspConfigDescriptor
```
public javax.servlet.descriptor.JspConfigDescriptor getJspConfigDescriptor()
```
    ServletContext().getJspConfigDescriptorに移譲する。
    
    定義:
    
    getJspConfigDescriptor インタフェース内 javax.servlet.ServletContext
  - getClassLoader
```
public ClassLoader getClassLoader()
```
    ServletContext().getClassLoaderに移譲する。
    
    定義:
    
    getClassLoader インタフェース内 javax.servlet.ServletContext
  - declareRoles
```
public void declareRoles(String... roleNames)
```
    ServletContext().declareRolesに移譲する。
    
    定義:
    
    declareRoles インタフェース内 javax.servlet.ServletContext
  - getVirtualServerName
```
public String getVirtualServerName()
```
    ServletContext().getVirtualServerNameに移譲する。
    
    定義:
    
    getVirtualServerName インタフェース内 javax.servlet.ServletContext

クラス ServletContextHolder

フィールドのサマリー

インタフェースから継承されたフィールド javax.servlet.ServletContext

コンストラクタのサマリー

メソッドのサマリー

クラスから継承されたメソッド java.lang.Object

フィールドの詳細

holder

コンストラクタの詳細

ServletContextHolder

メソッドの詳細

getContext

getMajorVersion

getMinorVersion

getMimeType

getResourcePaths

getResource

getResourceAsStream

getRequestDispatcher

getNamedDispatcher

getServlet

getServlets

getServletNames

log

log

log

getRealPath

getServerInfo

getInitParameter

getInitParameterNames

getAttribute

getAttributeNames

setAttribute

removeAttribute

getServletContextName

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