HttpTestConfiguration (Nablarch-API)

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

Direct Known Subclasses:

RestTestConfiguration
```
public class HttpTestConfiguration
extends java.lang.Object
```
HTTPリクエストテスト用の設定定義クラス。

Constructor Summary

Constructors
Constructor and Description

HttpTestConfiguration()

Constructors
Constructor and Description
`HttpTestConfiguration()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.String`	`getDumpFileExtension()` ダンプファイルの拡張子を取得する。
`java.lang.String`	`getExceptionRequestVarKey()` ApplicationExceptionが格納されるリクエストスコープのキーを取得する。
`HtmlChecker`	`getHtmlChecker()` HTMLチェッカーを取得する。
`java.lang.String`	`getHtmlCheckerConfig()` HtmlCheckツール設定ファイルのパスを取得する。
`java.lang.String`	`getHtmlDumpDir()` HTML出力ディレクトリを取得する。
`java.lang.String`	`getHtmlResourcesCharset()` HTMLリソースの文字コードを設定する。
`java.io.File`	`getHtmlResourcesDir()` HTMLリソースディレクトリを取得する。
`java.util.List<java.lang.String>`	`getHtmlResourcesExtensionList()` ダンプディレクトリへコピーされるHTMLリソースの拡張子を取得する。
`java.lang.String`	`getHtmlResourcesRoot()` HTMLリソースのコピー先ディレクトリ名を取得する。
`java.util.Map<java.lang.String,java.lang.String>`	`getHttpHeader()` HTTPHeaderを取得する。
`java.util.List<java.lang.String>`	`getIgnoreHtmlResourceDirectory()` HTMLリソースとして除外するディレクトリを取得する。
`java.lang.String`	`getJsTestResourceDir()` クライアントスクリプトテスト用リソース配置ディレクトリパスを取得する。
`java.util.Map<java.lang.String,java.lang.Object>`	`getSessionInfo()` セッション情報を取得する。
`java.lang.String`	`getTempDirectory()` テンプディレクトリのパスを取得する。
`java.lang.String`	`getUploadTmpDirectory()` アップロードファイルの一時ディレクトリを取得する。本ディレクトリは、テスト時にアップロードファイルを一時的に配置するディレクトリとなる。
`java.lang.String`	`getUserIdSessionKey()` ユーザIDセッションキーを取得する。
`java.lang.String`	`getWebBaseDir()` webベースディレクトリを取得する。
`java.lang.String`	`getXmlComponentFile()` ターゲットコード用の設定ファイル(XMLファイル)をリードするための、ルートXMLファイル名を取得する。
`boolean`	`isBackup()` バックアップ実施フラグを取得する。
`boolean`	`isCheckHtml()` HTMLチェック実行するか否かの設定を取得する。
`boolean`	`isDumpVariableItem()` ダンプHTMLへの可変項目の出力可否を取得する。
`void`	`setBackup(boolean backup)` バックアップ実施フラグを設定する。
`void`	`setCheckHtml(boolean isCheckHtml)` HTMLチェック実行するか否かの設定を設定する。
`void`	`setDumpFileExtension(java.lang.String dumpFileExtension)` ダンプファイルの拡張子を設定する。
`void`	`setDumpVariableItem(boolean dumpVariableItem)` ダンプHTMLへの可変項目の出力可否を設定する。
`void`	`setExceptionRequestVarKey(java.lang.String exceptionRequestVarKey)` ApplicationExceptionが格納されるリクエストスコープのキーを設定する。
`void`	`setHtmlChecker(HtmlChecker htmlChecker)` HTMLチェッカーを設定する。
`void`	`setHtmlCheckerConfig(java.lang.String htmlCheckerConfig)` HtmlCheckツール設定ファイルのパスを設定する。
`void`	`setHtmlDumpDir(java.lang.String htmlDumpDir)` HTML出力ディレクトリを設定する。
`void`	`setHtmlResourcesCharset(java.lang.String htmlResourcesCharset)` HTMLリソースの文字コードを設定する。
`void`	`setHtmlResourcesExtensionList(java.util.List<java.lang.String> htmlResourcesExtensionList)` ダンプディレクトリへコピーされるHTMLリソースの拡張子を設定する。
`void`	`setHtmlResourcesRoot(java.lang.String htmlResourcesRoot)` HTMLリソースのコピー先ディレクトリ名を設定する。
`void`	`setHttpHeader(java.util.Map<java.lang.String,java.lang.String> httpHeader)` HTTPHeaderを設定する。
`void`	`setIgnoreHtmlResourceDirectory(java.util.List<java.lang.String> ignoreHtmlResourceDirectory)` HTMLリソースとして除外するディレクトリのリストを設定する。 `setHtmlResourcesRoot(String)`で設定したディレクトリ配下から、リソースとして除外するディレクトリを設定する。たとえば、HTMLリソースがバージョン管理されている場合、バージョン管理用のディレクトリ(.svnや.git)などを設定することにより、不要なファイルがコピーされることを回避でききる。
`void`	`setJsTestResourceDir(java.lang.String jsTestResourceDir)` クライアントスクリプトテスト用リソース配置ディレクトリパスを設定する。
`void`	`setSessionInfo(java.util.Map<java.lang.String,java.lang.Object> sessionInfo)` セッション情報を設定する。
`void`	`setTempDirectory(java.lang.String tempDirectory)` テンプディレクトリのパスを設定する。 JSPのコンパイル後のクラスが格納されるディレクトリ。本設定を省略して場合のデフォルトテンプディレクトリは、jettyのデフォルト動作となる。
`void`	`setUploadTmpDirectory(java.lang.String uploadTmpDirectory)` アップロードファイルの一時ディレクトリを設定する。
`void`	`setUserIdSessionKey(java.lang.String userIdSessionKey)` ユーザIDセッションキーを設定する。
`void`	`setWebBaseDir(java.lang.String webBaseDir)` webベースディレクトリを設定する。
`void`	`setXmlComponentFile(java.lang.String xmlComponentFile)` ターゲットコード用の設定ファイル(XMLファイル)をリードするための、ルートXMLファイル名を設定する。

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - HttpTestConfiguration
```
public HttpTestConfiguration()
```
- Method Detail
  - isDumpVariableItem
```
public boolean isDumpVariableItem()
```
    ダンプHTMLへの可変項目の出力可否を取得する。
    
    Returns:
    
    dumpVariableItem ダンプHTMLへの可変項目の出力可否
  - setDumpVariableItem
```
public void setDumpVariableItem(boolean dumpVariableItem)
```
    ダンプHTMLへの可変項目の出力可否を設定する。
    
    Parameters:
    
    dumpVariableItem - dumpVariableItem ダンプHTMLへの可変項目の出力可否
  - getHtmlResourcesCharset
```
@Published(tag="architect")
public java.lang.String getHtmlResourcesCharset()
```
    HTMLリソースの文字コードを設定する。
    
    Returns:
    
    HTMLリソースの文字コード
  - setHtmlResourcesCharset
```
public void setHtmlResourcesCharset(java.lang.String htmlResourcesCharset)
```
    HTMLリソースの文字コードを設定する。
    
    Parameters:
    
    htmlResourcesCharset - HTMLリソースの文字コード
  - isBackup
```
public boolean isBackup()
```
    バックアップ実施フラグを取得する。
    
    Returns:
    
    バックアップ実施フラグ
  - setBackup
```
public void setBackup(boolean backup)
```
    バックアップ実施フラグを設定する。
    
    Parameters:
    
    backup - バックアップ実施フラグ
  - getHtmlResourcesExtensionList
```
@Published(tag="architect")
public java.util.List<java.lang.String> getHtmlResourcesExtensionList()
```
    ダンプディレクトリへコピーされるHTMLリソースの拡張子を取得する。
    
    Returns:
    
    ダンプディレクトリへコピーされるHTMLリソースの拡張子
  - setHtmlResourcesExtensionList
```
public void setHtmlResourcesExtensionList(java.util.List<java.lang.String> htmlResourcesExtensionList)
```
    ダンプディレクトリへコピーされるHTMLリソースの拡張子を設定する。
    
    Parameters:
    
    htmlResourcesExtensionList - ダンプディレクトリへコピーされるHTMLリソースの拡張子
  - getHtmlResourcesRoot
```
@Published(tag="architect")
public java.lang.String getHtmlResourcesRoot()
```
    HTMLリソースのコピー先ディレクトリ名を取得する。
    
    Returns:
    
    HTMLリソースのコピー先ディレクトリ名
  - setHtmlResourcesRoot
```
public void setHtmlResourcesRoot(java.lang.String htmlResourcesRoot)
```
    HTMLリソースのコピー先ディレクトリ名を設定する。
    
    Parameters:
    
    htmlResourcesRoot - HTMLリソースのコピー先ディレクトリ名
  - getHtmlDumpDir
```
@Published(tag="architect")
public java.lang.String getHtmlDumpDir()
```
    HTML出力ディレクトリを取得する。
    
    Returns:
    
    HTML出力ディレクトリ
  - setHtmlDumpDir
```
public void setHtmlDumpDir(java.lang.String htmlDumpDir)
```
    HTML出力ディレクトリを設定する。
    
    Parameters:
    
    htmlDumpDir - HTML出力ディレクトリ
  - getWebBaseDir
```
@Published(tag="architect")
public java.lang.String getWebBaseDir()
```
    webベースディレクトリを取得する。
    
    Returns:
    
    webベースディレクトリ
  - setWebBaseDir
```
public void setWebBaseDir(java.lang.String webBaseDir)
```
    webベースディレクトリを設定する。
    PJ共通のwebモジュールが存在する場合、このプロパティにカンマ区切りで複数のwebベースディレクトリを指定できる。 "path/to/app/,path/to/common/" 複数指定した場合、先頭から順にリソースが探索される。
    
    Parameters:
    
    webBaseDir - webベースディレクトリ
  - getJsTestResourceDir
```
@Published(tag="architect")
public java.lang.String getJsTestResourceDir()
```
    クライアントスクリプトテスト用リソース配置ディレクトリパスを取得する。
    
    Returns:
    
    クライアントスクリプトテスト用リソース配置ディレクトリパス。
  - setJsTestResourceDir
```
public void setJsTestResourceDir(java.lang.String jsTestResourceDir)
```
    クライアントスクリプトテスト用リソース配置ディレクトリパスを設定する。
    
    Parameters:
    
    jsTestResourceDir - クライアントスクリプトテスト用リソース配置ディレクトリパス
  - getXmlComponentFile
```
@Published(tag="architect")
public java.lang.String getXmlComponentFile()
```
    ターゲットコード用の設定ファイル(XMLファイル)をリードするための、ルートXMLファイル名を取得する。
    
    Returns:
    
    XMLファイル名
  - setXmlComponentFile
```
public void setXmlComponentFile(java.lang.String xmlComponentFile)
```
    ターゲットコード用の設定ファイル(XMLファイル)をリードするための、ルートXMLファイル名を設定する。
    
    Parameters:
    
    xmlComponentFile - XMLファイル名
  - getUserIdSessionKey
```
@Published(tag="architect")
public java.lang.String getUserIdSessionKey()
```
    ユーザIDセッションキーを取得する。
    
    Returns:
    
    ユーザIDセッションキー
  - setUserIdSessionKey
```
public void setUserIdSessionKey(java.lang.String userIdSessionKey)
```
    ユーザIDセッションキーを設定する。
    
    Parameters:
    
    userIdSessionKey - ユーザIDセッションキーを設定する。
  - getExceptionRequestVarKey
```
@Published(tag="architect")
public java.lang.String getExceptionRequestVarKey()
```
    ApplicationExceptionが格納されるリクエストスコープのキーを取得する。
    
    Returns:
    
    ApplicationExceptionが格納されるリクエストスコープのキー
  - setExceptionRequestVarKey
```
public void setExceptionRequestVarKey(java.lang.String exceptionRequestVarKey)
```
    ApplicationExceptionが格納されるリクエストスコープのキーを設定する。
    
    Parameters:
    
    exceptionRequestVarKey - ApplicationExceptionが格納されるリクエストスコープのキー
  - getDumpFileExtension
```
@Published(tag="architect")
public java.lang.String getDumpFileExtension()
```
    ダンプファイルの拡張子を取得する。
    
    Returns:
    
    ダンプファイルの拡張子
  - setDumpFileExtension
```
public void setDumpFileExtension(java.lang.String dumpFileExtension)
```
    ダンプファイルの拡張子を設定する。
    
    Parameters:
    
    dumpFileExtension - ダンプファイルの拡張子
  - getHtmlCheckerConfig
```
@Published(tag="architect")
public java.lang.String getHtmlCheckerConfig()
```
    HtmlCheckツール設定ファイルのパスを取得する。
    
    Returns:
    
    HtmlCheckツール設定ファイル
  - setHtmlCheckerConfig
```
public void setHtmlCheckerConfig(java.lang.String htmlCheckerConfig)
```
    HtmlCheckツール設定ファイルのパスを設定する。
    
    Parameters:
    
    htmlCheckerConfig - HtmlCheckツール設定ファイルのパス
  - getHttpHeader
```
@Published(tag="architect")
public java.util.Map<java.lang.String,java.lang.String> getHttpHeader()
```
    HTTPHeaderを取得する。
    
    Returns:
    
    HTTPHeader
  - setHttpHeader
```
public void setHttpHeader(java.util.Map<java.lang.String,java.lang.String> httpHeader)
```
    HTTPHeaderを設定する。
    
    Parameters:
    
    httpHeader - HTTPHeader
  - getSessionInfo
```
@Published(tag="architect")
public java.util.Map<java.lang.String,java.lang.Object> getSessionInfo()
```
    セッション情報を取得する。
    
    Returns:
    
    セッション情報
  - setSessionInfo
```
public void setSessionInfo(java.util.Map<java.lang.String,java.lang.Object> sessionInfo)
```
    セッション情報を設定する。
    
    Parameters:
    
    sessionInfo - セッション情報
  - setCheckHtml
```
public void setCheckHtml(boolean isCheckHtml)
```
    HTMLチェック実行するか否かの設定を設定する。
    
    Parameters:
    
    isCheckHtml - HTMLチェック実行するか否かの設定
  - isCheckHtml
```
@Published(tag="architect")
public boolean isCheckHtml()
```
    HTMLチェック実行するか否かの設定を取得する。
    
    Returns:
    
    HTMLチェック実行する場合はtrue、実行しない場合はfalse
  - getHtmlResourcesDir
```
@Published(tag="architect")
public java.io.File getHtmlResourcesDir()
```
    HTMLリソースディレクトリを取得する。
    
    Returns:
    
    HTMLリソースディレクトリ
  - getIgnoreHtmlResourceDirectory
```
@Published(tag="architect")
public java.util.List<java.lang.String> getIgnoreHtmlResourceDirectory()
```
    HTMLリソースとして除外するディレクトリを取得する。
    
    Returns:
    
    HTMLリソースディレクトリとして除外するディレクトリのリスト
  - setIgnoreHtmlResourceDirectory
```
public void setIgnoreHtmlResourceDirectory(java.util.List<java.lang.String> ignoreHtmlResourceDirectory)
```
    HTMLリソースとして除外するディレクトリのリストを設定する。
    setHtmlResourcesRoot(String)で設定したディレクトリ配下から、リソースとして除外するディレクトリを設定する。たとえば、HTMLリソースがバージョン管理されている場合、バージョン管理用のディレクトリ(.svnや.git)などを設定することにより、不要なファイルがコピーされることを回避でききる。
    
    Parameters:
    
    ignoreHtmlResourceDirectory - HTMLリソースディレクトリとして除外するディレクトリのリスト
  - getTempDirectory
```
@Published(tag="architect")
public java.lang.String getTempDirectory()
```
    テンプディレクトリのパスを取得する。
    
    Returns:
    
    テンプディレクトリのパス
  - setTempDirectory
```
public void setTempDirectory(java.lang.String tempDirectory)
```
    テンプディレクトリのパスを設定する。
    JSPのコンパイル後のクラスが格納されるディレクトリ。本設定を省略して場合のデフォルトテンプディレクトリは、jettyのデフォルト動作となる。
    
    Parameters:
    
    tempDirectory - テンプディレクトリのパス
  - getUploadTmpDirectory
```
@Published(tag="architect")
public java.lang.String getUploadTmpDirectory()
```
    アップロードファイルの一時ディレクトリを取得する。本ディレクトリは、テスト時にアップロードファイルを一時的に配置するディレクトリとなる。
    
    Returns:
    
    アップロードファイルの一時ディレクトリ
  - setUploadTmpDirectory
```
public void setUploadTmpDirectory(java.lang.String uploadTmpDirectory)
```
    アップロードファイルの一時ディレクトリを設定する。
    
    Parameters:
    
    uploadTmpDirectory - アップロードファイルの一時ディレクトリ
  - getHtmlChecker
```
@Published(tag="architect")
public HtmlChecker getHtmlChecker()
```
    HTMLチェッカーを取得する。
    
    Returns:
    
    HTMLチェッカー
  - setHtmlChecker
```
public void setHtmlChecker(HtmlChecker htmlChecker)
```
    HTMLチェッカーを設定する。
    
    Parameters:
    
    htmlChecker - HTMLチェッカー

Class HttpTestConfiguration

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

HttpTestConfiguration

Method Detail

isDumpVariableItem

setDumpVariableItem

getHtmlResourcesCharset

setHtmlResourcesCharset

isBackup

setBackup

getHtmlResourcesExtensionList

setHtmlResourcesExtensionList

getHtmlResourcesRoot

setHtmlResourcesRoot

getHtmlDumpDir

setHtmlDumpDir

getWebBaseDir

setWebBaseDir

getJsTestResourceDir

setJsTestResourceDir

getXmlComponentFile

setXmlComponentFile

getUserIdSessionKey

setUserIdSessionKey

getExceptionRequestVarKey

setExceptionRequestVarKey

getDumpFileExtension

setDumpFileExtension

getHtmlCheckerConfig

setHtmlCheckerConfig

getHttpHeader

setHttpHeader

getSessionInfo

setSessionInfo

setCheckHtml

isCheckHtml

getHtmlResourcesDir

getIgnoreHtmlResourceDirectory

setIgnoreHtmlResourceDirectory

getTempDirectory

setTempDirectory

getUploadTmpDirectory

setUploadTmpDirectory

getHtmlChecker

setHtmlChecker