nablarch.fw.web.handler

クラス ResourceMapping

java.lang.Object

nablarch.fw.web.handler.ResourceMapping

すべての実装されたインタフェース:

Handler<HttpRequest,HttpResponse>, HttpRequestHandler

public class ResourceMapping
extends java.lang.Object
implements HttpRequestHandler

リクエストURIに応じて、リソースファイルに対するマッピングを行うリクエストハンドラ。

 画像等の静的ファイルへのリクエストやフォーワードを介さないJSP画面へのアクセスは、
 通常、Webサーバ・アプリケーションサーバでレスポンスを行う為、フレームワーク側で制御することができない。
 このリクエストハンドラを経由させることで、これらのアクセスについても
 認可を始めとする共通処理の制御下におくことができる。
 マッピング先のパスには、HttpResponse.setContentPath(String)の書式に従って、
 以下の3種類のいずれかを指定することができる。
   1. コンテキストクラスローダ上のリソース
   2. サーブレットフォーワード（JSPを含む)
   3. 内部フォーワードの実行結果
 ただし、ファイルシステム上のローカルファイル(file://スキーム)は使用できない。
 
 次の例では、特定のベースURI(/webapp/resource/)下の画像ファイルに対するリクエストを、
 サーブレットコンテキスト上のリソース(/WEB-INF/resource/)を参照するようにマッピングしている。
 こうすることで、これらのファイルをフレームワークの認証・認可の制御下に置くことができる。
   new StaticResource("/admin/resource/", "servlet:///WEB-INF/resource/");
 HTTPリクエストと、それに対するレスポンスのコンテンツパスとの対応は以下のようになる。
 ===========================================================================
  HTTPリクエストライン                コンテンツパス [コンテンツタイプ]
 ===========================================================================
 GET /admin/resource/style.css  ->  servlet:///WEB-INF/resource/style.css 
                                    [text/css]
 -------------------------------    --------------------------------------
 GET /admin/resource/js/init.js ->  servlet:///WEB-INF/resource/js/init.js
                                    [application/javascript]
 ===========================================================================
 

関連項目:

HttpResponse.setContentPath(String)

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

コンストラクタ

コンストラクタと説明
ResourceMapping() デフォルトコンストラクタ。
ResourceMapping(java.lang.String baseUri, java.lang.String basePath) 特定のbaseUri配下へのリクエストを静的ファイルにマッピングする リクエストハンドラを生成する。

メソッドのサマリー

修飾子とタイプ	メソッドと説明
HttpResponse	handle(HttpRequest req, ExecutionContext ctx) HTTPリクエストに対する処理を実行する。
ResourceMapping	setBasePath(java.lang.String basePath) マッピング先リソースパスを設定する。
ResourceMapping	setBaseUri(java.lang.String baseUri) マッピング元ベースURIを設定する。

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

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

コンストラクタの詳細

ResourceMapping

public ResourceMapping(java.lang.String baseUri,
                       java.lang.String basePath)

特定のbaseUri配下へのリクエストを静的ファイルにマッピングする リクエストハンドラを生成する。

パラメータ:

baseUri - マッピング元ベースURI

basePath - マッピング先リソースパス

ResourceMapping

public ResourceMapping()

デフォルトコンストラクタ。

メソッドの詳細

setBaseUri

public ResourceMapping setBaseUri(java.lang.String baseUri)

マッピング元ベースURIを設定する。

パラメータ:

baseUri - マッピング元ベースURI

戻り値:

このオブジェクト自体

setBasePath

public ResourceMapping setBasePath(java.lang.String basePath)

マッピング先リソースパスを設定する。

パラメータ:

basePath - マッピング先リソースパス

戻り値:

このオブジェクト自体

handle

public HttpResponse handle(HttpRequest req,
                           ExecutionContext ctx)

HTTPリクエストに対する処理を実行する。

 このクラスの実装では以下の処理を行う。
   1. リクエストURI中のbaseUri以下の部分を取得する。
   2. docRootに1.の結果を連結した文字列をコンテンツタイプとする。
   3. リクエストURIの拡張子からコンテンツタイプを判定する。
   4. HttpResponseを生成し、2,3の結果をそれに設定する。
   5. 4の結果を返す。
 

定義:

handle インタフェース内 Handler<HttpRequest,HttpResponse>

定義:

handle インタフェース内 HttpRequestHandler

パラメータ:

req - HTTPリクエストオブジェクト

ctx - サーバサイド実行コンテキストオブジェクト

戻り値:

HTTPレスポンスオブジェクト

関連項目:

HttpResponse.setContentPath(String)