TestCaseInfo (Nablarch-API)

java.lang.Object
- nablarch.test.core.http.TestCaseInfo

```
@Published
public class TestCaseInfo
extends java.lang.Object
```
データシートに定義されたテストケース情報を格納するクラス。

フィールドのサマリー

フィールド
修飾子とタイプ	フィールドと説明
`protected static java.lang.String`	`CASE` テストケースを記述しているカラム名
`protected static java.lang.String`	`CONTEXT_LIST_MAP` コンテキストパラメータのLIST_MAP定義名
`protected static java.lang.String`	`COOKIE_LIST_MAP` CookieのLIST_MAP定義名
`protected static java.lang.String`	`DEFAULT_SEARCH_RESULT_KEY` リクエストスコープに格納する検索結果のキー名
`protected static java.lang.String`	`DESCRIPTION` ショットの説明を記述しているカラム名
`protected static java.lang.String`	`EXPECTED_CONTENT_FILENAME` コンテンツディスポジション・ヘッダに指定されたファイル名の期待値を定義しているカラム名(LIST_MAP＝テストケース）
`protected static java.lang.String`	`EXPECTED_CONTENT_LENGTH` コンテンツレングス・ヘッダの期待値を定義しているカラム名(LIST_MAP＝テストケース）
`protected static java.lang.String`	`EXPECTED_CONTENT_TYPE` コンテンツタイプ・ヘッダの期待値を定義しているカラム名(LIST_MAP＝テストケース）
`protected static java.lang.String`	`EXPECTED_FORWARD_URI` 期待するフォワードURIを定義しているカラム名(LIST_MAP＝テストケース）
`protected static java.lang.String`	`EXPECTED_HTTP_STATUS_COLUMN` HTTPステータスコードの期待値を定義しているカラム名(LIST_MAP＝テストケース）
`protected static java.lang.String`	`EXPECTED_MESSAGE_COLUMN` 要求電文の期待値を定義しているカラム名(LIST_MAP＝テストケース）
`protected static java.lang.String`	`EXPECTED_MESSAGE_ID_COLUMN` HTTPステータスコードの期待値を定義しているカラム名(LIST_MAP＝テストケース）
`protected static java.lang.String`	`EXPECTED_SEARCH_COLUMN` 検索結果の期待値を定義しているカラム名(LIST_MAP＝テストケース）
`protected static java.lang.String`	`EXPECTED_TABLE_COLUMN` テーブル期待値を定義しているカラム名(LIST_MAP＝テストケース）
`protected static java.lang.String`	`IS_VALID_TOKEN` トークンを設定するかどうかを記述しているカラム名
`protected static java.lang.String`	`REQUEST_ID` リクエストIDを定義しているカラム名
`protected static java.lang.String`	`RESPONSE_MESSAGE_COLUMN` 応答電文を定義しているカラム名(LIST_MAP＝テストケース）
`protected static java.lang.String`	`SET_UP_TABLE` データベースにデータを投入する際のグループIDを表すカラム名
`protected static java.lang.String`	`TEST_CASE_NO` テストケース番号を定義しているカラム名
`protected static java.lang.String`	`USER_ID_COLUMN_NAME` ユーザIDを定義しているカラム名

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

コンストラクタ
コンストラクタと説明
`TestCaseInfo(java.lang.String sheetName, java.util.Map<java.lang.String,java.lang.String> testCaseParams, java.util.List<java.util.Map<java.lang.String,java.lang.String>> context, java.util.List<java.util.Map<java.lang.String,java.lang.String>> request, java.util.List<java.util.Map<java.lang.String,java.lang.String>> expectedResponseListMap)` コンストラクタ
`TestCaseInfo(java.lang.String sheetName, java.util.Map<java.lang.String,java.lang.String> testCaseParams, java.util.List<java.util.Map<java.lang.String,java.lang.String>> context, java.util.List<java.util.Map<java.lang.String,java.lang.String>> request, java.util.List<java.util.Map<java.lang.String,java.lang.String>> expectedResponseListMap, java.util.List<java.util.Map<java.lang.String,java.lang.String>> cookie)` コンストラクタ

メソッドのサマリー

すべてのメソッドインスタンス・メソッド concreteメソッド
修飾子とタイプ	メソッドと説明
`java.util.Map<java.lang.String,java.lang.String>`	`getCookie()` Cookieを返却する。
`java.lang.String`	`getExpectedContentFileName()` コンテンツディスポジション・ヘッダに指定されたファイル名の期待値を返却する。
`java.lang.String`	`getExpectedContentLength()` コンテンツレングス・ヘッダの期待値を返却する。
`java.lang.String`	`getExpectedContentType()` コンテンツタイプ・ヘッダの期待値の期待値を返却する。
`java.lang.String`	`getExpectedForwardUri()` フォワード先URIの期待値を返却する。
`java.lang.String`	`getExpectedMessage()` 要求電文（期待値）を返却する.
`java.lang.String`	`getExpectedMessageId()` メッセージID（期待値）を返却する.
`java.util.Map<java.lang.String,java.lang.String>`	`getExpectedRequestScopeVar()` HTTPレスポンス（期待値）を返却する.
`java.lang.String`	`getExpectedSearchId()` 検索結果検証の期待値を特定するIDを返却する.
`java.lang.String`	`getExpectedStatusCode()` HTTPステータスコード(期待値)を返却する.
`java.lang.String`	`getExpectedTable()` テーブル検証の期待値を特定するIDを返却する.
`HttpRequest`	`getHttpRequest()` HTTPリクエストを取得する。
`java.lang.String`	`getRequestId()` テスト対象とするリクエストIDを返却する.
`java.util.Map<java.lang.String,java.lang.String>`	`getRequestParameters()` データシートに定義されたリクエストパラメータを取得するデフォルトでは、LIST_MAP「testCases」の「requestParams」カラムで指定されている LIST_MAPのレコードを取得する
`java.lang.String`	`getResponseMessage()` 応答電文を返却する.
`java.lang.String`	`getSearchResultKey()` リクエストスコープ内に格納された検索結果を取得するためのキーを取得する。
`java.lang.String`	`getSetUpTableGroupId()` テーブルセットアップデータ定義を特定するためのIDを返却する.
`java.lang.String`	`getSheetName()` データシート名を返却する
`java.lang.String`	`getTestCaseName()` テストケース名称を取得する.
`java.lang.String`	`getTestCaseNo()` テストケース番号を取得する。
`java.lang.String`	`getUserId()` ユーザIDを取得する。
`protected java.lang.String`	`getValue(java.util.Map<java.lang.String,java.lang.String> row, java.lang.String columnName)` LIST_MAPから取得したレコードから、指定したカラム名に対応する値を取得する
`boolean`	`isAssertApplicationMessageId()` メッセージIDの検証を行うかどうかを返却する。
`boolean`	`isAssertRequestScopeVar()` リクエストスコープ値を比較検証するかどうかを返却する.
`boolean`	`isAssertSearch()` 検索結果の検証をするかどうかを返却する.
`boolean`	`isAssertTable()` テーブル値を検証するかどうか返却する.
`boolean`	`isRequestParametersSet()` リクエストパラメータを設定するかどうかを返却する
`boolean`	`isSetUpTable()` テーブルをセットアップするかどうかを返却する.
`boolean`	`isValidToken()` トークン制御を行うかどうかを返却する.
`void`	`setIsAssertApplicationMessageId(boolean isAssert)` メッセージIDの検証を行うかどうかを設定する。
`void`	`setIsAssertRequestScopeVar(boolean isAssert)` リクエストスコープ値を比較検証するかどうかを設定する各テストケースにて比較検証を個別実装する場合にfalseに設定する。
`void`	`setSearchResultKey(java.lang.String searchResultKey)` リクエストスコープ内に格納された検索結果を取得するためのキーを設定する。

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

- フィールドの詳細
  - USER_ID_COLUMN_NAME
```
protected static final java.lang.String USER_ID_COLUMN_NAME
```
    ユーザIDを定義しているカラム名
    
    関連項目:
    
    定数フィールド値
  - REQUEST_ID
```
protected static final java.lang.String REQUEST_ID
```
    リクエストIDを定義しているカラム名
    
    関連項目:
    
    定数フィールド値
  - TEST_CASE_NO
```
protected static final java.lang.String TEST_CASE_NO
```
    テストケース番号を定義しているカラム名
    
    関連項目:
    
    定数フィールド値
  - CASE
```
protected static final java.lang.String CASE
```
    テストケースを記述しているカラム名
    
    関連項目:
    
    定数フィールド値
  - DESCRIPTION
```
protected static final java.lang.String DESCRIPTION
```
    ショットの説明を記述しているカラム名
    
    関連項目:
    
    定数フィールド値
  - CONTEXT_LIST_MAP
```
protected static final java.lang.String CONTEXT_LIST_MAP
```
    コンテキストパラメータのLIST_MAP定義名
    
    関連項目:
    
    定数フィールド値
  - COOKIE_LIST_MAP
```
protected static final java.lang.String COOKIE_LIST_MAP
```
    CookieのLIST_MAP定義名
    
    関連項目:
    
    定数フィールド値
  - IS_VALID_TOKEN
```
protected static final java.lang.String IS_VALID_TOKEN
```
    トークンを設定するかどうかを記述しているカラム名
    
    関連項目:
    
    定数フィールド値
  - SET_UP_TABLE
```
protected static final java.lang.String SET_UP_TABLE
```
    データベースにデータを投入する際のグループIDを表すカラム名
    
    関連項目:
    
    定数フィールド値
  - EXPECTED_HTTP_STATUS_COLUMN
```
protected static final java.lang.String EXPECTED_HTTP_STATUS_COLUMN
```
    HTTPステータスコードの期待値を定義しているカラム名(LIST_MAP＝テストケース）
    
    関連項目:
    
    定数フィールド値
  - EXPECTED_MESSAGE_ID_COLUMN
```
protected static final java.lang.String EXPECTED_MESSAGE_ID_COLUMN
```
    HTTPステータスコードの期待値を定義しているカラム名(LIST_MAP＝テストケース）
    
    関連項目:
    
    定数フィールド値
  - EXPECTED_SEARCH_COLUMN
```
protected static final java.lang.String EXPECTED_SEARCH_COLUMN
```
    検索結果の期待値を定義しているカラム名(LIST_MAP＝テストケース）
    
    関連項目:
    
    定数フィールド値
  - EXPECTED_TABLE_COLUMN
```
protected static final java.lang.String EXPECTED_TABLE_COLUMN
```
    テーブル期待値を定義しているカラム名(LIST_MAP＝テストケース）
    
    関連項目:
    
    定数フィールド値
  - EXPECTED_MESSAGE_COLUMN
```
protected static final java.lang.String EXPECTED_MESSAGE_COLUMN
```
    要求電文の期待値を定義しているカラム名(LIST_MAP＝テストケース）
    
    関連項目:
    
    定数フィールド値
  - RESPONSE_MESSAGE_COLUMN
```
protected static final java.lang.String RESPONSE_MESSAGE_COLUMN
```
    応答電文を定義しているカラム名(LIST_MAP＝テストケース）
    
    関連項目:
    
    定数フィールド値
  - DEFAULT_SEARCH_RESULT_KEY
```
protected static final java.lang.String DEFAULT_SEARCH_RESULT_KEY
```
    リクエストスコープに格納する検索結果のキー名
    
    関連項目:
    
    定数フィールド値
  - EXPECTED_FORWARD_URI
```
protected static final java.lang.String EXPECTED_FORWARD_URI
```
    期待するフォワードURIを定義しているカラム名(LIST_MAP＝テストケース）
    
    関連項目:
    
    定数フィールド値
  - EXPECTED_CONTENT_LENGTH
```
protected static final java.lang.String EXPECTED_CONTENT_LENGTH
```
    コンテンツレングス・ヘッダの期待値を定義しているカラム名(LIST_MAP＝テストケース）
    
    関連項目:
    
    定数フィールド値
  - EXPECTED_CONTENT_TYPE
```
protected static final java.lang.String EXPECTED_CONTENT_TYPE
```
    コンテンツタイプ・ヘッダの期待値を定義しているカラム名(LIST_MAP＝テストケース）
    
    関連項目:
    
    定数フィールド値
  - EXPECTED_CONTENT_FILENAME
```
protected static final java.lang.String EXPECTED_CONTENT_FILENAME
```
    コンテンツディスポジション・ヘッダに指定されたファイル名の期待値を定義しているカラム名(LIST_MAP＝テストケース）
    
    関連項目:
    
    定数フィールド値
- コンストラクタの詳細
  - TestCaseInfo
```
public TestCaseInfo(java.lang.String sheetName,
                    java.util.Map<java.lang.String,java.lang.String> testCaseParams,
                    java.util.List<java.util.Map<java.lang.String,java.lang.String>> context,
                    java.util.List<java.util.Map<java.lang.String,java.lang.String>> request,
                    java.util.List<java.util.Map<java.lang.String,java.lang.String>> expectedResponseListMap)
```
    コンストラクタ
    
    パラメータ:
    
    sheetName - テストシート名
    
    testCaseParams - テストケースパラメータ
    
    context - スレッドコンテキスト・ユーザコンテキスト生成用パラメータ
    
    request - リクエストパラメータ
    
    expectedResponseListMap - レスポンス期待値パラメータ
  - TestCaseInfo
```
public TestCaseInfo(java.lang.String sheetName,
                    java.util.Map<java.lang.String,java.lang.String> testCaseParams,
                    java.util.List<java.util.Map<java.lang.String,java.lang.String>> context,
                    java.util.List<java.util.Map<java.lang.String,java.lang.String>> request,
                    java.util.List<java.util.Map<java.lang.String,java.lang.String>> expectedResponseListMap,
                    java.util.List<java.util.Map<java.lang.String,java.lang.String>> cookie)
```
    コンストラクタ
    
    パラメータ:
    
    sheetName - テストシート名
    
    testCaseParams - テストケースパラメータ
    
    context - スレッドコンテキスト・ユーザコンテキスト生成用パラメータ
    
    request - リクエストパラメータ
    
    expectedResponseListMap - レスポンス期待値パラメータ
    
    cookie - Cookie情報
- メソッドの詳細
  - getSearchResultKey
```
public java.lang.String getSearchResultKey()
```
    リクエストスコープ内に格納された検索結果を取得するためのキーを取得する。
    
    戻り値:
    
    キー
  - setSearchResultKey
```
public void setSearchResultKey(java.lang.String searchResultKey)
```
    リクエストスコープ内に格納された検索結果を取得するためのキーを設定する。
    
    パラメータ:
    
    searchResultKey - キー
  - getExpectedMessageId
```
public java.lang.String getExpectedMessageId()
```
    メッセージID（期待値）を返却する.
    
    戻り値:
    
    メッセージID（複数存在する場合はカンマ区切り）
  - getExpectedRequestScopeVar
```
public java.util.Map<java.lang.String,java.lang.String> getExpectedRequestScopeVar()
```
    HTTPレスポンス（期待値）を返却する.
    
    戻り値:
    
    リクエストスコープに設定されるはずの期待値
  - getExpectedSearchId
```
public java.lang.String getExpectedSearchId()
```
    検索結果検証の期待値を特定するIDを返却する.
    
    戻り値:
    
    テーブル期待値ID(expectedSearchカラムに定義したデータ)
  - getExpectedStatusCode
```
public java.lang.String getExpectedStatusCode()
```
    HTTPステータスコード(期待値)を返却する.
    
    戻り値:
    
    HTTPステータスコード
  - getExpectedTable
```
public java.lang.String getExpectedTable()
```
    テーブル検証の期待値を特定するIDを返却する.
    
    戻り値:
    
    テーブル期待値ID(expectedTableカラムに定義したデータ)
  - getExpectedForwardUri
```
public java.lang.String getExpectedForwardUri()
```
    フォワード先URIの期待値を返却する。
    
    戻り値:
    
    フォワード先URIの期待値
  - getExpectedContentLength
```
public java.lang.String getExpectedContentLength()
```
    コンテンツレングス・ヘッダの期待値を返却する。
    
    戻り値:
    
    コンテンツレングス・ヘッダの期待値
  - getExpectedContentType
```
public java.lang.String getExpectedContentType()
```
    コンテンツタイプ・ヘッダの期待値の期待値を返却する。
    
    戻り値:
    
    コンテンツタイプ・ヘッダの期待値の期待値
  - getExpectedContentFileName
```
public java.lang.String getExpectedContentFileName()
```
    コンテンツディスポジション・ヘッダに指定されたファイル名の期待値を返却する。
    
    戻り値:
    
    コンテンツディスポジション・ヘッダに指定されたファイル名の期待値
  - getExpectedMessage
```
public java.lang.String getExpectedMessage()
```
    要求電文（期待値）を返却する.
    
    戻り値:
    
    要求電文（期待値）
  - getResponseMessage
```
public java.lang.String getResponseMessage()
```
    応答電文を返却する.
    
    戻り値:
    
    応答電文
  - getRequestId
```
public java.lang.String getRequestId()
```
    テスト対象とするリクエストIDを返却する.
    
    戻り値:
    
    リクエストID
  - getCookie
```
public java.util.Map<java.lang.String,java.lang.String> getCookie()
```
    Cookieを返却する。
    
    戻り値:
    
    Cookie情報
  - getRequestParameters
```
public java.util.Map<java.lang.String,java.lang.String> getRequestParameters()
```
    データシートに定義されたリクエストパラメータを取得する
```
 デフォルトでは、LIST_MAP「testCases」の「requestParams」カラムで指定されている
 LIST_MAPのレコードを取得する
 
```
    戻り値:
    
    リクエストパラメータ
  - isRequestParametersSet
```
public boolean isRequestParametersSet()
```
    リクエストパラメータを設定するかどうかを返却する
    
    戻り値:
    
    boolean
  - getSetUpTableGroupId
```
public java.lang.String getSetUpTableGroupId()
```
    テーブルセットアップデータ定義を特定するためのIDを返却する.
```
 SETUP_TABLE[xxxx]=tableName  : 左記例のxxxの部分
 
```
    戻り値:
    
    セットアップデータID(setUpTableカラムに定義したデータ)
  - getSheetName
```
public java.lang.String getSheetName()
```
    データシート名を返却する
    
    戻り値:
    
    データシート名
  - getTestCaseName
```
public java.lang.String getTestCaseName()
```
    テストケース名称を取得する.
    テスト失敗時のメッセージやHTMLファイル出力名に使用される。デフォルトは、{データシート名}_{caseIndex}_{Case名}
    例）RGBN00000000_Case0_初期表示
    
    戻り値:
    
    テストケース名称
  - getTestCaseNo
```
public java.lang.String getTestCaseNo()
```
    テストケース番号を取得する。
    
    戻り値:
    
    テストケース番号
  - getUserId
```
public java.lang.String getUserId()
```
    ユーザIDを取得する。
    
    戻り値:
    
    ユーザID
  - getValue
```
protected final java.lang.String getValue(java.util.Map<java.lang.String,java.lang.String> row,
                                          java.lang.String columnName)
```
    LIST_MAPから取得したレコードから、指定したカラム名に対応する値を取得する
    
    パラメータ:
    
    row - 行レコード(LIST_MAPの各要素）
    
    columnName - カラム名
    
    戻り値:
    
    指定したカラム名に対応する値
  - isAssertSearch
```
public boolean isAssertSearch()
```
    検索結果の検証をするかどうかを返却する.
    
    戻り値:
    
    boolean
  - isAssertTable
```
public boolean isAssertTable()
```
    テーブル値を検証するかどうか返却する.
    
    戻り値:
    
    boolean
  - isSetUpTable
```
public boolean isSetUpTable()
```
    テーブルをセットアップするかどうかを返却する.
    
    戻り値:
    
    boolean
  - isValidToken
```
public boolean isValidToken()
```
    トークン制御を行うかどうかを返却する.
    
    戻り値:
    
    boolean
  - isAssertRequestScopeVar
```
public boolean isAssertRequestScopeVar()
```
    リクエストスコープ値を比較検証するかどうかを返却する.
    
    戻り値:
    
    boolean
  - setIsAssertRequestScopeVar
```
public void setIsAssertRequestScopeVar(boolean isAssert)
```
    リクエストスコープ値を比較検証するかどうかを設定する
```
 各テストケースにて比較検証を個別実装する場合にfalseに設定する。
 AbstractHttpRequestTestTemplate.beforeExecuteRequest(TestCaseInfo, nablarch.fw.ExecutionContext, Advice)にて
 にてfalseへの設定を行うこと。
 
```
    パラメータ:
    
    isAssert - boolean(デフォルト値はTrue）
  - isAssertApplicationMessageId
```
public boolean isAssertApplicationMessageId()
```
    メッセージIDの検証を行うかどうかを返却する。
    
    戻り値:
    
    boolean
  - setIsAssertApplicationMessageId
```
public void setIsAssertApplicationMessageId(boolean isAssert)
```
    メッセージIDの検証を行うかどうかを設定する。
    
    パラメータ:
    
    isAssert - boolean(デフォルト値はTrue）
  - getHttpRequest
```
public HttpRequest getHttpRequest()
```
    HTTPリクエストを取得する。
    
    戻り値:
    
    このテストケースのHTTPリクエスト

クラス TestCaseInfo

フィールドのサマリー

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

メソッドのサマリー

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

フィールドの詳細

USER_ID_COLUMN_NAME

REQUEST_ID

TEST_CASE_NO

CASE

DESCRIPTION

CONTEXT_LIST_MAP

COOKIE_LIST_MAP

IS_VALID_TOKEN

SET_UP_TABLE

EXPECTED_HTTP_STATUS_COLUMN

EXPECTED_MESSAGE_ID_COLUMN

EXPECTED_SEARCH_COLUMN

EXPECTED_TABLE_COLUMN

EXPECTED_MESSAGE_COLUMN

RESPONSE_MESSAGE_COLUMN

DEFAULT_SEARCH_RESULT_KEY

EXPECTED_FORWARD_URI

EXPECTED_CONTENT_LENGTH

EXPECTED_CONTENT_TYPE

EXPECTED_CONTENT_FILENAME

コンストラクタの詳細

TestCaseInfo

TestCaseInfo

メソッドの詳細

getSearchResultKey

setSearchResultKey

getExpectedMessageId

getExpectedRequestScopeVar

getExpectedSearchId

getExpectedStatusCode

getExpectedTable

getExpectedForwardUri

getExpectedContentLength

getExpectedContentType

getExpectedContentFileName

getExpectedMessage

getResponseMessage

getRequestId

getCookie

getRequestParameters

isRequestParametersSet

getSetUpTableGroupId

getSheetName

getTestCaseName

getTestCaseNo

getUserId

getValue

isAssertSearch

isAssertTable

isSetUpTable

isValidToken

isAssertRequestScopeVar

setIsAssertRequestScopeVar

isAssertApplicationMessageId

setIsAssertApplicationMessageId

getHttpRequest