HttpServer (NablarchTestingApi)

java.lang.Object
- nablarch.fw.HandlerQueueManager<HttpServer>
- - nablarch.fw.web.HttpServer

All Implemented Interfaces:: nablarch.fw.Handler<nablarch.fw.web.HttpRequest,nablarch.fw.web.HttpResponse>, nablarch.fw.web.HttpRequestHandler

@Published(tag="architect")
public class HttpServer
extends nablarch.fw.HandlerQueueManager<HttpServer>
implements nablarch.fw.web.HttpRequestHandler

エンベディドHTTPサーバー&サーブレットコンテナ。

 主に単体テスト時の画面確認や打鍵テストで使用することを想定した、
 JVMプロセス内の1スレッドとして動作する軽量アプリケーションサーバである。
 現行の実装では、内部的にJettyサーバを使用しており、
 本クラスは単なるラッパーに過ぎない。

Author:: Iwauo Tajima

Constructor Summary

Constructors
Constructor and Description

HttpServer()
サーバインスタンスを生成する。

Constructors
Constructor and Description
`HttpServer()` サーバインスタンスを生成する。

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.util.List<nablarch.fw.Handler>`	`getHandlerQueue()` この実装では、サーバが処理を委譲するフロントコントローラ内のハンドラキューを返す。
`java.io.File`	`getHttpDumpFile()` HTTPダンプの出力先ファイルを取得する。
`java.io.File`	`getHttpDumpRoot()` HTTPダンプの出力先フォルダを返す。
`int`	`getPort()` このサーバが使用するポート番号を取得する。
`java.lang.String`	`getServletContextPath()` 本サーバにデプロイされるWARのコンテキストパスを返す。
`nablarch.fw.web.ResourceLocator`	`getWarBasePath()` このサーバにデプロイするWARのパスを返す。
`nablarch.fw.web.HttpResponse`	`handle(nablarch.fw.web.HttpRequest req, nablarch.fw.ExecutionContext unused)`
`boolean`	`isHttpDumpEnabled()` HTTPダンプ機能が有効化されているか？
`HttpServer`	`join()` サーバスレッドが終了するまでカレントスレッドをwaitさせる。
`protected java.lang.String`	`rewriteUriPath(java.lang.String html, nablarch.fw.web.HttpRequest req)` HTML中のURI型の参照先を、ダンプHTML用に書き換える。
`void`	`setDumpVariableItem(boolean dumpVariableItem)` ダンプHTMLへの可変項目の出力可否を設定する。
`HttpServer`	`setHttpDumpEnabled(boolean enabled)` HTTPダンプ機能の有効化/無効化を設定する。
`HttpServer`	`setHttpDumpFilePath(java.lang.String path)` HTTPダンプの出力先ファイルパスを指定する。
`HttpServer`	`setHttpDumpRoot(java.lang.String path)` HTTPダンプの出力先フォルダのパスを設定する。また、HTTPダンプ機能が無効化されている場合は有効化される。
`HttpServer`	`setPort(int port)` このサーバが使用するポート番号を設定する。
`HttpServer`	`setServletContextPath(java.lang.String path)` ベースURIを設定する。
`HttpServer`	`setTempDirectory(java.lang.String path)` context用の一時ディレクトリパスを指定する。本パスを指定した場合、jspのコンパイル後のクラスなどはこのディレクトリ配下に保存される。
`HttpServer`	`setWarBasePath(java.lang.String warBasePath)` このサーバにデプロイするWARのパスを設定する。
`HttpServer`	`setWarBasePaths(java.util.List<nablarch.fw.web.ResourceLocator> warBasePaths)` このサーバにデプロイするWARのパスを複数設定する。引数で渡されたリストの順にリソースが探索される。
`HttpServer`	`start()` サーバを起動する。
`HttpServer`	`startLocal()` このサーバをテストモードで起動する。

- Constructor Detail
  - HttpServer
```
public HttpServer()
```
    サーバインスタンスを生成する。
- Method Detail
  - getHandlerQueue
```
public java.util.List<nablarch.fw.Handler> getHandlerQueue()
```
    この実装では、サーバが処理を委譲するフロントコントローラ内のハンドラキューを返す。
    
    Specified by:
    
    getHandlerQueue in class nablarch.fw.HandlerQueueManager<HttpServer>
  - getServletContextPath
```
public java.lang.String getServletContextPath()
```
    本サーバにデプロイされるWARのコンテキストパスを返す。
    
    Returns:
    
    コンテキストパス
  - setServletContextPath
```
public HttpServer setServletContextPath(java.lang.String path)
```
    ベースURIを設定する。
```
 本サーバにデプロイされるWARのコンテキストパスを設定する。
 デフォルト値は"/"である。
 
```
    Parameters:
    
    path - コンテキストパス
    
    Returns:
    
    このオブジェクト自体
  - getPort
```
public int getPort()
```
    このサーバが使用するポート番号を取得する。
    
    Returns:
    
    ポート番号
  - setPort
```
public HttpServer setPort(int port)
```
    このサーバが使用するポート番号を設定する。
```
 デフォルトのポート番号は7777である。
 
```
    Parameters:
    
    port - ポート番号
    
    Returns:
    
    このオブジェクト自体
  - start
```
public HttpServer start()
```
    サーバを起動する。
```
 サーバスレッドを生成し、port()メソッドで指定されたポート番号上の
 HTTPリクエストに対して処理を行う。
 
```
    Returns:
    
    このオブジェクト自体
  - join
```
public HttpServer join()
```
    サーバスレッドが終了するまでカレントスレッドをwaitさせる。
    
    Returns:
    
    このオブジェクト自体
  - setWarBasePath
```
public HttpServer setWarBasePath(java.lang.String warBasePath)
```
    このサーバにデプロイするWARのパスを設定する。
```
 明示的に指定しなかった場合のデフォルト値は、
 "classpath://nablarch/fw/web/servlet/docroot/"
 
```
    Parameters:
    
    warBasePath - このサーバにデプロイするWARのパス
    
    Returns:
    
    このオブジェクト自体
  - setWarBasePaths
```
public HttpServer setWarBasePaths(java.util.List<nablarch.fw.web.ResourceLocator> warBasePaths)
```
    このサーバにデプロイするWARのパスを複数設定する。引数で渡されたリストの順にリソースが探索される。
```
 明示的に指定しなかった場合のデフォルト値は、
 "classpath://nablarch/fw/web/servlet/docroot/"
 
```
    Parameters:
    
    warBasePaths - このサーバにデプロイするWARのパス
    
    Returns:
    
    このオブジェクト自体
  - getWarBasePath
```
public nablarch.fw.web.ResourceLocator getWarBasePath()
```
    このサーバにデプロイするWARのパスを返す。
    
    Returns:
    
    このサーバにデプロイするWARのパス
  - setHttpDumpEnabled
```
public HttpServer setHttpDumpEnabled(boolean enabled)
```
    HTTPダンプ機能の有効化/無効化を設定する。
```
 デフォルトでは無効化されている。
 
```
    Parameters:
    
    enabled - HTTPダンプを有効化する場合はtrue、無効化する場合はfalseを設定する。
    
    Returns:
    
    このオブジェクト自体
    
    See Also:
    
    HttpServer.setHttpDumpRoot(String)
  - isHttpDumpEnabled
```
public boolean isHttpDumpEnabled()
```
    HTTPダンプ機能が有効化されているか？
    
    Returns:
    
    HTTPダンプ機能が有効であればtrueを返す。
  - setHttpDumpRoot
```
public HttpServer setHttpDumpRoot(java.lang.String path)
```
    HTTPダンプの出力先フォルダのパスを設定する。また、HTTPダンプ機能が無効化されている場合は有効化される。
```
 デフォルトでは、カレントパス直下の"http_dump"ディレクトリになる。
 ダンプ出力時に当該のディレクトリが存在しなかった場合は自動的に作成される。
 
```
    Parameters:
    
    path - HTTPダンプの出力先フォルダ
    
    Returns:
    
    このオブジェクト自体
  - getHttpDumpRoot
```
public java.io.File getHttpDumpRoot()
```
    HTTPダンプの出力先フォルダを返す。
    
    Returns:
    
    HTTPダンプの出力先フォルダ
  - setHttpDumpFilePath
```
public HttpServer setHttpDumpFilePath(java.lang.String path)
```
    HTTPダンプの出力先ファイルパスを指定する。
    
    Parameters:
    
    path - 出力先ファイルパス
    
    Returns:
    
    このオブジェクト自体
  - getHttpDumpFile
```
public java.io.File getHttpDumpFile()
```
    HTTPダンプの出力先ファイルを取得する。
    
    Returns:
    
    出力先ファイル
  - setTempDirectory
```
public HttpServer setTempDirectory(java.lang.String path)
```
    context用の一時ディレクトリパスを指定する。本パスを指定した場合、jspのコンパイル後のクラスなどはこのディレクトリ配下に保存される。
    
    Parameters:
    
    path - context用の一時ディレクトリパス
    
    Returns:
    
    このオブジェクト自体
  - handle
```
public nablarch.fw.web.HttpResponse handle(nablarch.fw.web.HttpRequest req,
                                           nablarch.fw.ExecutionContext unused)
```
```
 このクラスの実装では、
 引数のHTTPリクエストオブジェクトをHTTPメッセージにシリアライズし、
 ローカルコネクションに送信する。
 内蔵アプリケーションサーバでの処理後、返信されたHTTPレスポンスメッセージを
 HTTPレスポンスオブジェクトにパースし、この関数の戻り値として返す。
 また、HTTPダンプ出力が有効である場合、
 そのレスポンスボディの内容を所定のディレクトリに出力する。
 
```
    Specified by:
    
    handle in interface nablarch.fw.Handler<nablarch.fw.web.HttpRequest,nablarch.fw.web.HttpResponse>
    
    Specified by:
    
    handle in interface nablarch.fw.web.HttpRequestHandler
  - startLocal
```
public HttpServer startLocal()
```
    このサーバをテストモードで起動する。
    
    Returns:
    
    このオブジェクト自体
  - setDumpVariableItem
```
public void setDumpVariableItem(boolean dumpVariableItem)
```
    ダンプHTMLへの可変項目の出力可否を設定する。
    
    Parameters:
    
    dumpVariableItem - dumpVariableItem ダンプHTMLへの可変項目の出力可否
  - rewriteUriPath
```
protected java.lang.String rewriteUriPath(java.lang.String html,
                                          nablarch.fw.web.HttpRequest req)
```
    HTML中のURI型の参照先を、ダンプHTML用に書き換える。
    
    Parameters:
    
    html - HTML文字列
    
    req - HttpRequest
    
    Returns:
    
    編集後文字列

Class HttpServer

Constructor Summary

Method Summary

Constructor Detail

HttpServer

Method Detail

getHandlerQueue

getServletContextPath

setServletContextPath

getPort

setPort

start

join

setWarBasePath

setWarBasePaths

getWarBasePath

setHttpDumpEnabled

isHttpDumpEnabled

setHttpDumpRoot

getHttpDumpRoot

setHttpDumpFilePath

getHttpDumpFile

setTempDirectory

handle

startLocal

setDumpVariableItem

rewriteUriPath