MockServletExecutionContext (Nablarch-API)

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 and Description

MockServletExecutionContext()
コンストラクタ。

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.Boolean`	`getCreate()` 最後に `getNativeHttpSession(boolean)` を実行したときに引数に渡された値を取得する。
`HttpRequestWrapper`	`getHttpRequest()` `setHttpRequestValue(HttpRequestWrapper)`で設定した値を返す。
`int`	`getInvalidateSessionInvokedCount()` `invalidateSession()`が実行された回数を取得する。
`javax.servlet.http.HttpSession`	`getNativeHttpSession(boolean create)` `setNativeHttpSessionValue(HttpSession)`で設定した値を返す。
`java.util.Map<java.lang.String,java.lang.Object>`	`getRequestScopeMap()` リクエストスコープ用のモックのマップを取得する。
`javax.servlet.ServletContext`	`getServletContext()` `setServletContextValue(ServletContext)`で設定した値を返す。
`NablarchHttpServletRequestWrapper`	`getServletRequest()` `setServletRequestValue(NablarchHttpServletRequestWrapper)`で設定した値を返す。
`javax.servlet.http.HttpServletResponse`	`getServletResponse()` `setServletResponseValue(HttpServletResponse)`で設定した値を返す。
`java.util.Map<java.lang.String,java.lang.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(javax.servlet.http.HttpSession nativeHttpSessionValue)` `getNativeHttpSession(boolean)`が返す値を設定する。
`ExecutionContext`	`setRequestScopeMap(java.util.Map<java.lang.String,java.lang.Object> scope)` リクエストスコープ用のモックのマップを設定する。
`void`	`setServletContextValue(javax.servlet.ServletContext servletContextValue)` `getServletContext()`が返す値を設定する。
`void`	`setServletRequestValue(NablarchHttpServletRequestWrapper servletRequestValue)` `getServletRequest()`が返す値を設定する。
`void`	`setServletResponseValue(javax.servlet.http.HttpServletResponse servletResponseValue)` `getServletResponse()`が返す値を設定する。
`ExecutionContext`	`setSessionScopeMap(java.util.Map<java.lang.String,java.lang.Object> scope)` セッションスコープ用のモックのマップを設定する。

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

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 Detail
  - MockServletExecutionContext
```
public MockServletExecutionContext()
```
    コンストラクタ。
- Method Detail
  - getRequestScopeMap
```
public java.util.Map<java.lang.String,java.lang.Object> getRequestScopeMap()
```
    リクエストスコープ用のモックのマップを取得する。
    
    Overrides:
    
    getRequestScopeMap in class ServletExecutionContext
    
    Returns:
    
    リクエストスコープ用のモックのマップ
  - setRequestScopeMap
```
public ExecutionContext setRequestScopeMap(java.util.Map<java.lang.String,java.lang.Object> scope)
```
    リクエストスコープ用のモックのマップを設定する。
    
    Overrides:
    
    setRequestScopeMap in class ServletExecutionContext
    
    Parameters:
    
    scope - リクエストスコープ用のモックのマップ
    
    Returns:
    
    このオブジェクト自体
  - getSessionScopeMap
```
public java.util.Map<java.lang.String,java.lang.Object> getSessionScopeMap()
```
    セッションスコープ用のモックのマップを取得する。
    
    Overrides:
    
    getSessionScopeMap in class ServletExecutionContext
    
    Returns:
    
    セッションスコープ用のモックのマップ
    
    See Also:
    
    ServletExecutionContext.getSessionScopedVar(String), ServletExecutionContext.hasSession()
  - setSessionScopeMap
```
public ExecutionContext setSessionScopeMap(java.util.Map<java.lang.String,java.lang.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(javax.servlet.http.HttpServletResponse servletResponseValue)
```
    getServletResponse()が返す値を設定する。
    
    Parameters:
    
    servletResponseValue - getServletResponse()が返す値
  - getServletResponse
```
public javax.servlet.http.HttpServletResponse getServletResponse()
```
    setServletResponseValue(HttpServletResponse)で設定した値を返す。
    デフォルトは null を返す。
    
    Overrides:
    
    getServletResponse in class ServletExecutionContext
    
    Returns:
    
    setServletResponseValue(HttpServletResponse)で設定した値
  - setServletContextValue
```
public void setServletContextValue(javax.servlet.ServletContext servletContextValue)
```
    getServletContext()が返す値を設定する。
    
    Parameters:
    
    servletContextValue - getServletContext()が返す値
  - getServletContext
```
public javax.servlet.ServletContext getServletContext()
```
    setServletContextValue(ServletContext)で設定した値を返す。
    デフォルトは null を返す。
    
    Overrides:
    
    getServletContext in class ServletExecutionContext
    
    Returns:
    
    setServletContextValue(ServletContext)で設定した値
  - setNativeHttpSessionValue
```
public void setNativeHttpSessionValue(javax.servlet.http.HttpSession nativeHttpSessionValue)
```
    getNativeHttpSession(boolean)が返す値を設定する。
    
    Parameters:
    
    nativeHttpSessionValue - getNativeHttpSession(boolean)が返す値
  - getNativeHttpSession
```
public javax.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 java.lang.Boolean getCreate()
```
    最後に getNativeHttpSession(boolean) を実行したときに引数に渡された値を取得する。
    一度もメソッドが実行されていない状態では null を返す。
    
    Returns:
    
    最後に getNativeHttpSession(boolean) を実行したときに引数に渡された値

Class MockServletExecutionContext

Field Summary

Fields inherited from class nablarch.fw.ExecutionContext

Constructor Summary

Method Summary

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

Methods inherited from class nablarch.fw.ExecutionContext

Methods inherited from class nablarch.fw.HandlerQueueManager

Methods inherited from class java.lang.Object

Constructor Detail

MockServletExecutionContext

Method Detail

getRequestScopeMap

setRequestScopeMap

getSessionScopeMap

setSessionScopeMap

invalidateSession

getInvalidateSessionInvokedCount

setIsNewSessionValue

isNewSession

setHasSessionValue

hasSession

setHttpRequestValue

getHttpRequest

setServletRequestValue

getServletRequest

setServletResponseValue

getServletResponse

setServletContextValue

getServletContext

setNativeHttpSessionValue

getNativeHttpSession

getCreate