HttpServer (Nablarch-API)

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

すべての実装されたインタフェース:: Handler<HttpRequest,HttpResponse>, HttpRequestHandler

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

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

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

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

コンストラクタ
コンストラクタと説明

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

コンストラクタ
コンストラクタと説明
`HttpServer()` サーバインスタンスを生成する。

メソッドのサマリー

すべてのメソッドインスタンス・メソッド concreteメソッド
修飾子とタイプ	メソッドと説明
`java.util.List<Handler>`	`getHandlerQueue()` 現在のハンドラキューの内容を返す。
`java.io.File`	`getHttpDumpFile()` HTTPダンプの出力先ファイルを取得する。
`java.io.File`	`getHttpDumpRoot()` HTTPダンプの出力先フォルダを返す。
`int`	`getPort()` このサーバが使用するポート番号を取得する。
`java.lang.String`	`getServletContextPath()` 本サーバにデプロイされるWARのコンテキストパスを返す。
`ResourceLocator`	`getWarBasePath()` このサーバにデプロイするWARのパスを返す。
`HttpResponse`	`handle(HttpRequest req, ExecutionContext unused)` HTTPリクエストに対する処理を実行する。
`boolean`	`isHttpDumpEnabled()` HTTPダンプ機能が有効化されているか？
`HttpServer`	`join()` サーバスレッドが終了するまでカレントスレッドをwaitさせる。
`protected java.lang.String`	`rewriteUriPath(java.lang.String html, 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ダンプの出力先フォルダのパスを設定する。
`HttpServer`	`setPort(int port)` このサーバが使用するポート番号を設定する。
`HttpServer`	`setServletContextPath(java.lang.String path)` ベースURIを設定する。
`HttpServer`	`setTempDirectory(java.lang.String path)` context用の一時ディレクトリパスを指定する。
`HttpServer`	`setWarBasePath(java.lang.String warBasePath)` このサーバにデプロイするWARのパスを設定する。
`HttpServer`	`setWarBasePaths(java.util.List<ResourceLocator> warBasePaths)` このサーバにデプロイするWARのパスを複数設定する。
`HttpServer`	`start()` サーバを起動する。
`HttpServer`	`startLocal()` このサーバをテストモードで起動する。

クラスから継承されたメソッド nablarch.fw.HandlerQueueManager
addHandler, addHandler, addHandler, addHandler, addHandler, addHandlers, clearHandlers, getHandlerOf, getMethodBinder, setHandlerQueue, setMethodBinder

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

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

クラス HttpServer

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

メソッドのサマリー

クラスから継承されたメソッド nablarch.fw.HandlerQueueManager

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

コンストラクタの詳細

HttpServer

メソッドの詳細

getHandlerQueue

getServletContextPath

setServletContextPath

getPort

setPort

start

join

setWarBasePath

setWarBasePaths

getWarBasePath

setHttpDumpEnabled

isHttpDumpEnabled

setHttpDumpRoot

getHttpDumpRoot

setHttpDumpFilePath

getHttpDumpFile

setTempDirectory

handle

startLocal

setDumpVariableItem

rewriteUriPath