Package nablarch.fw.web.servlet

Class MockServletExecutionContext

java.lang.Object

nablarch.fw.HandlerQueueManager<ExecutionContext>

nablarch.fw.ExecutionContext

nablarch.fw.web.servlet.ServletExecutionContext

nablarch.fw.web.servlet.MockServletExecutionContext

@Published(tag="architect")
public class MockServletExecutionContext
extends ServletExecutionContext

単体テスト用の ServletExecutionContext のモッククラス。

このモッククラスでは、 ServletExecutionContext 内の Servlet API や HTTP 処理に関係する部分を仮実装に置き換えている。 これによって、 Servlet API などのインスタンスを用意しなくても、 インスタンス生成が可能となっている。

リクエストスコープとセッションスコープの情報は、本クラス内のインスタンス変数で定義された Map 内に格納される。
また、 getHttpRequest() や ServletExecutionContext.getServletContext() などの HTTP 処理に関係するメソッドは、別途定義されたセッターなどで渡した値をそのまま返すだけの 実装に置き換えられている。
これら以外の、もともと ExecutionContext にあるメソッド(ExecutionContext.handleNext(Object) など)は、 本来の処理がそのまま実行される。

Field Summary

Fields inherited from class nablarch.fw.ExecutionContext

FW_PREFIX, THROWN_APPLICATION_EXCEPTION_KEY, THROWN_EXCEPTION_KEY

Constructor Summary

Constructors

Constructor	Description
MockServletExecutionContext()	コンストラクタ。

Method Summary

Modifier and Type	Method	Description
Boolean	getCreate()	最後に getNativeHttpSession(boolean) を実行したときに引数に渡された値を取得する。
HttpRequestWrapper	getHttpRequest()	setHttpRequestValue(HttpRequestWrapper)で設定した値を返す。
int	getInvalidateSessionInvokedCount()	invalidateSession()が実行された回数を取得する。
jakarta.servlet.http.HttpSession	getNativeHttpSession(boolean create)	setNativeHttpSessionValue(HttpSession)で設定した値を返す。
Map<String,Object>	getRequestScopeMap()	リクエストスコープ用のモックのマップを取得する。
jakarta.servlet.ServletContext	getServletContext()	setServletContextValue(ServletContext)で設定した値を返す。
NablarchHttpServletRequestWrapper	getServletRequest()	setServletRequestValue(NablarchHttpServletRequestWrapper)で設定した値を返す。
jakarta.servlet.http.HttpServletResponse	getServletResponse()	setServletResponseValue(HttpServletResponse)で設定した値を返す。
Map<String,Object>	getSessionScopeMap()	セッションスコープ用のモックのマップを取得する。
boolean	hasSession()	setHasSessionValue(boolean)で設定した値を返す。
ExecutionContext	invalidateSession()	セッション破棄の処理は行わず、メソッドが実行された回数の記録だけを行う。
boolean	isNewSession()	setIsNewSessionValue(boolean)で設定した値を返す。
void	setHasSessionValue(boolean hasSessionValue)	hasSession()が返す値を設定する。
void	setHttpRequestValue(HttpRequestWrapper httpRequestValue)	getHttpRequest()が返す値を設定する。
void	setIsNewSessionValue(boolean isNewSessionValue)	isNewSession()が返す値を設定する。
void	setNativeHttpSessionValue(jakarta.servlet.http.HttpSession nativeHttpSessionValue)	getNativeHttpSession(boolean)が返す値を設定する。
ExecutionContext	setRequestScopeMap(Map<String,Object> scope)	リクエストスコープ用のモックのマップを設定する。
void	setServletContextValue(jakarta.servlet.ServletContext servletContextValue)	getServletContext()が返す値を設定する。
void	setServletRequestValue(NablarchHttpServletRequestWrapper servletRequestValue)	getServletRequest()が返す値を設定する。
void	setServletResponseValue(jakarta.servlet.http.HttpServletResponse servletResponseValue)	getServletResponse()が返す値を設定する。
ExecutionContext	setSessionScopeMap(Map<String,Object> scope)	セッションスコープ用のモックのマップを設定する。

Methods inherited from class nablarch.fw.web.servlet.ServletExecutionContext

getSessionScopedVar

Methods inherited from class nablarch.fw.ExecutionContext

clearLastReadData, closeReader, copy, copyInternal, 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

Methods inherited from class nablarch.fw.HandlerQueueManager

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

Methods inherited from class java.lang.Object

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

Constructor Details

MockServletExecutionContext

public MockServletExecutionContext()

コンストラクタ。

Method Details

getRequestScopeMap

public Map<String,Object> getRequestScopeMap()

リクエストスコープ用のモックのマップを取得する。

Overrides:

getRequestScopeMap in class ServletExecutionContext

Returns:

リクエストスコープ用のモックのマップ

setRequestScopeMap

public ExecutionContext setRequestScopeMap(Map<String,Object> scope)

リクエストスコープ用のモックのマップを設定する。

Overrides:

setRequestScopeMap in class ServletExecutionContext

Parameters:

scope - リクエストスコープ用のモックのマップ

Returns:

このオブジェクト自体

getSessionScopeMap

public Map<String,Object> getSessionScopeMap()

セッションスコープ用のモックのマップを取得する。

Overrides:

getSessionScopeMap in class ServletExecutionContext

Returns:

セッションスコープ用のモックのマップ

See Also:

• ServletExecutionContext.getSessionScopedVar(String)
• ServletExecutionContext.hasSession()

setSessionScopeMap

public ExecutionContext setSessionScopeMap(Map<String,Object> scope)

セッションスコープ用のモックのマップを設定する。

Overrides:

setSessionScopeMap in class ServletExecutionContext

Parameters:

scope - セッションスコープ用のモックのマップ

Returns:

このオブジェクト自体

invalidateSession

public ExecutionContext invalidateSession()

セッション破棄の処理は行わず、メソッドが実行された回数の記録だけを行う。

Overrides:

invalidateSession in class ServletExecutionContext

Returns:

このオブジェクト自体

getInvalidateSessionInvokedCount

public int getInvalidateSessionInvokedCount()

invalidateSession()が実行された回数を取得する。

Returns:

invalidateSession()が実行された回数

setIsNewSessionValue

public void setIsNewSessionValue(boolean isNewSessionValue)

isNewSession()が返す値を設定する。

Parameters:

isNewSessionValue - isNewSession()が返す値

isNewSession

public boolean isNewSession()

setIsNewSessionValue(boolean)で設定した値を返す。

デフォルトは false を返す。

Overrides:

isNewSession in class ServletExecutionContext

Returns:

setIsNewSessionValue(boolean)で設定した値

setHasSessionValue

public void setHasSessionValue(boolean hasSessionValue)

hasSession()が返す値を設定する。

Parameters:

hasSessionValue - hasSession()が返す値

hasSession

public boolean hasSession()

setHasSessionValue(boolean)で設定した値を返す。

デフォルトは true を返す。

Overrides:

hasSession in class ServletExecutionContext

Returns:

setHasSessionValue(boolean)で設定した値

setHttpRequestValue

public void setHttpRequestValue(HttpRequestWrapper httpRequestValue)

getHttpRequest()が返す値を設定する。

Parameters:

httpRequestValue - getHttpRequest()が返す値

getHttpRequest

public HttpRequestWrapper getHttpRequest()

setHttpRequestValue(HttpRequestWrapper)で設定した値を返す。

デフォルトは null を返す。

Overrides:

getHttpRequest in class ServletExecutionContext

Returns:

setHttpRequestValue(HttpRequestWrapper)で設定した値

setServletRequestValue

public void setServletRequestValue(NablarchHttpServletRequestWrapper servletRequestValue)

getServletRequest()が返す値を設定する。

Parameters:

servletRequestValue - getServletRequest()が返す値

getServletRequest

public NablarchHttpServletRequestWrapper getServletRequest()

setServletRequestValue(NablarchHttpServletRequestWrapper)で設定した値を返す。

デフォルトは null を返す。

Overrides:

getServletRequest in class ServletExecutionContext

Returns:

setServletRequestValue(NablarchHttpServletRequestWrapper)で設定した値

setServletResponseValue

public void setServletResponseValue(jakarta.servlet.http.HttpServletResponse servletResponseValue)

getServletResponse()が返す値を設定する。

Parameters:

servletResponseValue - getServletResponse()が返す値

getServletResponse

public jakarta.servlet.http.HttpServletResponse getServletResponse()

setServletResponseValue(HttpServletResponse)で設定した値を返す。

デフォルトは null を返す。

Overrides:

getServletResponse in class ServletExecutionContext

Returns:

setServletResponseValue(HttpServletResponse)で設定した値

setServletContextValue

public void setServletContextValue(jakarta.servlet.ServletContext servletContextValue)

getServletContext()が返す値を設定する。

Parameters:

servletContextValue - getServletContext()が返す値

getServletContext

public jakarta.servlet.ServletContext getServletContext()

setServletContextValue(ServletContext)で設定した値を返す。

デフォルトは null を返す。

Overrides:

getServletContext in class ServletExecutionContext

Returns:

setServletContextValue(ServletContext)で設定した値

setNativeHttpSessionValue

public void setNativeHttpSessionValue(jakarta.servlet.http.HttpSession nativeHttpSessionValue)

getNativeHttpSession(boolean)が返す値を設定する。

Parameters:

nativeHttpSessionValue - getNativeHttpSession(boolean)が返す値

getNativeHttpSession

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

setNativeHttpSessionValue(HttpSession)で設定した値を返す。

デフォルトは null を返す。

Overrides:

getNativeHttpSession in class ServletExecutionContext

Parameters:

create - この値は使用しない

Returns:

setNativeHttpSessionValue(HttpSession)で設定した値

See Also:

• HttpServletRequest.getSession(boolean)

getCreate

public Boolean getCreate()

最後に getNativeHttpSession(boolean) を実行したときに引数に渡された値を取得する。

一度もメソッドが実行されていない状態では null を返す。

Returns:

最後に getNativeHttpSession(boolean) を実行したときに引数に渡された値