nablarch.fw.web.servlet

クラス ServletExecutionContext

java.lang.Object

nablarch.fw.HandlerQueueManager<ExecutionContext>

nablarch.fw.ExecutionContext

nablarch.fw.web.servlet.ServletExecutionContext

public class ServletExecutionContext
extends ExecutionContext

サーブレットコンテナ上でのリクエスト処理における実行コンテキスト

フィールドのサマリー

クラスから継承されたフィールド nablarch.fw.ExecutionContext

FW_PREFIX, THROWN_APPLICATION_EXCEPTION_KEY, THROWN_EXCEPTION_KEY

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

コンストラクタ

コンストラクタと説明
ServletExecutionContext(javax.servlet.http.HttpServletRequest servletReq, javax.servlet.http.HttpServletResponse servletRes, javax.servlet.ServletContext servletCtx) コンストラクタ。

メソッドのサマリー

修飾子とタイプ	メソッドと説明
HttpRequestWrapper	getHttpRequest() HTTPリクエストオブジェクトを返す。
javax.servlet.http.HttpSession	getNativeHttpSession(boolean create) サーブレットコンテナが提供するHttpSessionを取得する。
java.util.Map<java.lang.String,java.lang.Object>	getRequestScopeMap() リクエストスコープ上の変数を格納したMapオブジェクトへの参照を返す。
javax.servlet.ServletContext	getServletContext() サーブレットコンテキストを返す。
NablarchHttpServletRequestWrapper	getServletRequest() サーブレットリクエストを返す。
javax.servlet.http.HttpServletResponse	getServletResponse() サーブレットレスポンスを返す。
<T> T	getSessionScopedVar(java.lang.String varName) セッションスコープ上の変数の値を取得する。
java.util.Map<java.lang.String,java.lang.Object>	getSessionScopeMap() セッションスコープ情報を格納したMapオブジェクトへの参照を返す。
boolean	hasSession() セッションがあるかどうか。
ExecutionContext	invalidateSession() 現在のリクエストに紐付けられたセッションスコープを無効化する。
boolean	isNewSession() 新規セッションであるかどうか。
ExecutionContext	setRequestScopeMap(java.util.Map<java.lang.String,java.lang.Object> scope) リクエストスコープを設定する。
ExecutionContext	setSessionScopeMap(java.util.Map<java.lang.String,java.lang.Object> scope) セッションスコープ上の変数を格納したMapを設定する。

クラスから継承されたメソッド nablarch.fw.ExecutionContext

clearLastReadData, closeReader, findHandler, getApplicationException, getCurrentRequestObject, getDataProcessedWhenThrown, getDataReader, getException, getHandlerQueue, getLastReadData, getLastRecordNumber, getNextHandler, getRequestScopedVar, getSessionStoredVar, getSessionStoreMap, handleNext, hasNextData, isProcessSucceeded, putDataOnException, readNextData, selectHandlers, setCurrentRequestObject, setDataReader, setDataReaderFactory, setException, setLastRecordNumber, setProcessSucceeded, setRequestScopedVar, setSessionScopedVar, setSessionStoredVar, setSessionStoreMap

クラスから継承されたメソッド nablarch.fw.HandlerQueueManager

addHandler, addHandler, addHandler, addHandler, addHandler, addHandlers, clearHandlers, getHandlerOf, getMethodBinder, setHandlerQueue, setMethodBinder

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

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

コンストラクタの詳細

ServletExecutionContext

public ServletExecutionContext(javax.servlet.http.HttpServletRequest servletReq,
                               javax.servlet.http.HttpServletResponse servletRes,
                               javax.servlet.ServletContext servletCtx)

コンストラクタ。

パラメータ:

servletReq - サーブレットリクエスト

servletRes - サーブレットレスポンス

servletCtx - サーブレットコンテキスト

メソッドの詳細

getHttpRequest

public HttpRequestWrapper getHttpRequest()

HTTPリクエストオブジェクトを返す。

戻り値:

HTTPリクエストオブジェクト

getServletRequest

@Published(tag="architect")
public NablarchHttpServletRequestWrapper getServletRequest()

サーブレットリクエストを返す。

戻り値:

サーブレットリクエスト

getServletResponse

@Published(tag="architect")
public javax.servlet.http.HttpServletResponse getServletResponse()

サーブレットレスポンスを返す。

戻り値:

サーブレットレスポンス

getServletContext

public javax.servlet.ServletContext getServletContext()

サーブレットコンテキストを返す。

戻り値:

サーブレットコンテキスト

invalidateSession

public ExecutionContext invalidateSession()

現在のリクエストに紐付けられたセッションスコープを無効化する。

オーバーライド:

invalidateSession クラス内 ExecutionContext

戻り値:

このオブジェクト自体

isNewSession

public boolean isNewSession()

新規セッションであるかどうか。

オーバーライド:

isNewSession クラス内 ExecutionContext

戻り値:

新規セッションである場合はtrue

hasSession

public boolean hasSession()

セッションがあるかどうか。

HttpSessionの生成を抑制したい場合には、本メソッドで判定する。

オーバーライド:

hasSession クラス内 ExecutionContext

戻り値:

セッションがある場合[@code true}

getRequestScopeMap

public java.util.Map<java.lang.String,java.lang.Object> getRequestScopeMap()

クラスからコピーされた説明: ExecutionContext

リクエストスコープ上の変数を格納したMapオブジェクトへの参照を返す。

このMapへの変更はリクエストスコープに直接反映される。

オーバーライド:

getRequestScopeMap クラス内 ExecutionContext

戻り値:

リクエストスコープへの参照

setRequestScopeMap

public ExecutionContext setRequestScopeMap(java.util.Map<java.lang.String,java.lang.Object> scope)

クラスからコピーされた説明: ExecutionContext

リクエストスコープを設定する。

オーバーライド:

setRequestScopeMap クラス内 ExecutionContext

パラメータ:

scope - リクエストスコープ上の変数を格納するMap

戻り値:

このオブジェクト自体

getSessionScopeMap

public java.util.Map<java.lang.String,java.lang.Object> getSessionScopeMap()

セッションスコープ情報を格納したMapオブジェクトへの参照を返す。

このMapへの変更はセッションスコープに直接反映される。

本メソッドではHttpSessionが存在しない場合、新規に作成する。
HttpSessionを生成したくない場合にはhasSession()にて判定すること。

オーバーライド:

getSessionScopeMap クラス内 ExecutionContext

戻り値:

セッションスコープへの参照

関連項目:

getSessionScopedVar(String), hasSession()

getSessionScopedVar

public <T> T getSessionScopedVar(java.lang.String varName)
                          throws java.lang.ClassCastException

セッションスコープ上の変数の値を取得する。

本メソッドではHttpSessionがない場合は、生成せずにnullを返却する。

オーバーライド:

getSessionScopedVar クラス内 ExecutionContext

型パラメータ:

T - 期待する変数の型

パラメータ:

varName - 変数名

戻り値:

変数の値

例外:

java.lang.ClassCastException - 実際の変数の型が期待する変数の型と適合しなかった場合。

関連項目:

getSessionScopeMap()

setSessionScopeMap

public ExecutionContext setSessionScopeMap(java.util.Map<java.lang.String,java.lang.Object> scope)

クラスからコピーされた説明: ExecutionContext

セッションスコープ上の変数を格納したMapを設定する。

オーバーライド:

setSessionScopeMap クラス内 ExecutionContext

パラメータ:

scope - リクエストスコープ上の変数を格納したMap

戻り値:

このオブジェクト自体

getNativeHttpSession

public javax.servlet.http.HttpSession getNativeHttpSession(boolean create)

サーブレットコンテナが提供するHttpSessionを取得する。 明示的にHttpSessionを使用したい場合は、本メソッドから取得する。

パラメータ:

create - セッションを生成するかどうか

戻り値:

HttpSession

関連項目:

HttpServletRequest.getSession(boolean)