ResourceLocator (Nablarch-API)

java.lang.Object
- nablarch.fw.web.ResourceLocator

@Published
public final class ResourceLocator
extends java.lang.Object

各種リソースを識別する為の文字列（リソースロケータ）をパースして格納するクラス。

 リソースロケータとは、本フレームワークにおいて、何らかのリソースを指定する際に用いられる汎用的書式である。
 以下のように定義される。
   (スキーム名)://(ディレクトリパス)/(リソース名)

 リソースロケータの使用場面例
 - HTTPレスポンスの内容を格納したリソースを指定するケース

   // 業務Actionから"jsp/success.jsp" に対してフォーワード
   new HttpResponse("200", "servlet://jsp/success.jsp");

 現時点でサポートされるスキームは以下の5つである。

 1. 静的ファイル
    ファイルシステム上の静的ファイルの内容を出力する。
    絶対パスもしくは相対パスで指定することが可能である。
     (書式)
         file://(コンテンツファイルへのパス)
     (例)
         file://./webapps/style/common.css    (相対パス)
         file:///www/docroot/style/common.css (絶対パス)

 2. Javaコンテキストクラスローダ上のリソース
    コンテキストクラスローダ上のリソースの内容を出力する。
     (書式)
         classpath://(Javaリソース名)
     (例)
         classpath://nablarch/sample/webapp/common.css

 3. 内部フォーワード
    リクエストプロセッサに対して、指定したリクエストURIでの再処理を要求する。
    HttpRequest・ExecutionContextはそのまま流用される。
     (書式)
         forward://(フォーワード名)
     (例)
         forward://registerForm.html           (現在のURIからの相対パス)
         forward:///app/user/registerForm.html (絶対パス)

 4. サーブレットフォーワード
    サーブレットコンテナに対してフォーワードを行う。
    この場合、レスポンスの出力処理自体がフォーワード先のサーブレットに委譲される。
     (書式)
         servlet://(フォーワード名)
     (例)
         servlet://jsp/index.jsp   (現在のページからの相対パス)
         servlet:///jsp/index.jsp  (サーブレットコンテキストを起点とする相対パス)


 5. リダイレクト
    この場合は、指定されたパスへのリダイレクションを指示するレスポンスを行う。
     (書式)
         redirect://(リダイレクト先パス)
         http(s)://(リダイレクト先URL)
     (例)
         redirect://login             (現在のページからの相対パス)
         redirect:///UserAction/login (サーブレットコンテキストを起点とする相対パス)
         http://www.example.com/login (外部サイトのURL)

 このクラスは不変クラスである。

フィールドのサマリー

フィールド
修飾子とタイプ	フィールドと説明
`static java.lang.String`	`ALLOWED_CHAR` コンテンツパス中のディレクトリ、リソース名として許容される文字列。
`static java.lang.String`	`SCHEMES` 対応するスキーム名
`static java.util.regex.Pattern`	`SYNTAX` リソースパスの書式

メソッドのサマリー

すべてのメソッド staticメソッドインスタンス・メソッド concreteメソッド
修飾子とタイプ	メソッドと説明
`boolean`	`exists()` このリソースの実体が存在するかどうか判定する。
`java.lang.String`	`getDirectory()` リソースパスのディレクトリ部分に相当する文字列を返す。
`java.lang.String`	`getHostname()` ホスト名を返す。
`java.io.InputStream`	`getInputStream()` リソースの内容をストリームで読み出すための`InputStream`を返す。
`java.lang.String`	`getPath()` パス文字列を返す。
`java.io.Reader`	`getReader()` リソースの内容を読み出すための`Reader`を返す。
`java.lang.String`	`getRealPath()` リソースのファイルシステム上での絶対パスを返す。
`java.lang.String`	`getResourceName()` リソース名を返す。
`java.lang.String`	`getScheme()` このリソースパスのスキーム名を返す。
`boolean`	`isRedirect()` レスポンスがリダイレクトかどうか判定する。
`boolean`	`isRelative()` 設定されたパスが相対パスかどうか。
`static boolean`	`isValidPath(java.lang.String path)` 渡された文字列が有効なリソースパスの書式であれば`true`を返す。
`java.lang.String`	`toString()` リソースパスの文字列表現そのものを返す。
`static ResourceLocator`	`valueOf(java.lang.String path)` リソースの文字列表現から`ResourceLocator`オブジェクトを生成する。

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

- フィールドの詳細
  - SCHEMES
```
public static final java.lang.String SCHEMES
```
    対応するスキーム名
    
    関連項目:
    
    定数フィールド値
  - ALLOWED_CHAR
```
public static final java.lang.String ALLOWED_CHAR
```
    コンテンツパス中のディレクトリ、リソース名として許容される文字列。
```
 "/", "~" はNG。
 2以上連続する"."もNG。
 
```
  - SYNTAX
```
public static final java.util.regex.Pattern SYNTAX
```
    リソースパスの書式
- メソッドの詳細
  - valueOf
```
public static ResourceLocator valueOf(java.lang.String path)
```
    リソースの文字列表現からResourceLocatorオブジェクトを生成する。
    "file|classpath|forward|servlet|redirect"に含まれないスキームを指定した場合、スキームは常に「servlet」となる。
    
    パラメータ:
    
    path - リソースの文字列表現
    
    戻り値:
    
    生成されたオブジェクト
    
    例外:
    
    HttpErrorResponse - リソースパスが無効な書式である場合
  - isValidPath
```
public static boolean isValidPath(java.lang.String path)
```
    渡された文字列が有効なリソースパスの書式であればtrueを返す。
    
    パラメータ:
    
    path - リソースパス文字列
    
    戻り値:
    
    渡された文字列が有効なリソースパスの書式であればtrue
  - getScheme
```
public java.lang.String getScheme()
```
    このリソースパスのスキーム名を返す。
    
    戻り値:
    
    スキーム名
  - getDirectory
```
public java.lang.String getDirectory()
```
    リソースパスのディレクトリ部分に相当する文字列を返す。
    
    戻り値:
    
    リソースパスのディレクトリ部分
  - isRelative
```
public boolean isRelative()
```
    設定されたパスが相対パスかどうか。
    
    戻り値:
    
    相対パス表記であればtrue。コンテキストクラスローダ上のリソースである場合、常にfalse
  - getResourceName
```
public java.lang.String getResourceName()
```
    リソース名を返す。
    
    戻り値:
    
    リソース名
  - getHostname
```
public java.lang.String getHostname()
```
    ホスト名を返す。
    
    戻り値:
    
    ホスト名
  - getPath
```
public java.lang.String getPath()
```
    パス文字列を返す。
    
    戻り値:
    
    パス文字列
  - toString
```
public java.lang.String toString()
```
    リソースパスの文字列表現そのものを返す。
    
    オーバーライド:
    
    toString クラス内 java.lang.Object
  - getRealPath
```
public java.lang.String getRealPath()
                             throws java.lang.UnsupportedOperationException
```
    リソースのファイルシステム上での絶対パスを返す。
    
    戻り値:
    
    絶対パスを返す。絶対パスが取得できない場合nullを返す
    
    例外:
    
    java.lang.UnsupportedOperationException - 静的ファイルでもクラスローダ上のリソースでもない場合
  - exists
```
public boolean exists()
```
    このリソースの実体が存在するかどうか判定する。
    
    戻り値:
    
    このリソースの実体が存在する場合はtrue。内部フォーワード/サーブレットフォーワードの場合は常にtrue。リダイレクトである場合は常にfalse
  - getReader
```
public java.io.Reader getReader()
                         throws java.io.FileNotFoundException
```
    リソースの内容を読み出すためのReaderを返す。
    
    戻り値:
    
    リソースの内容を読み出すためのReader
    
    例外:
    
    java.io.FileNotFoundException - 静的ファイルでもクラスローダ上のリソースでもない場合か、静的ファイルかクラスローダ上のリソースだが絶対パスを取得できなかった場合
  - getInputStream
```
public java.io.InputStream getInputStream()
                                   throws java.io.FileNotFoundException
```
    リソースの内容をストリームで読み出すためのInputStreamを返す。
    
    戻り値:
    
    リソースの内容を読み出すためのInputStream
    
    例外:
    
    java.io.FileNotFoundException - 静的ファイルでもクラスローダ上のリソースでもない場合か、静的ファイルかクラスローダ上のリソースだが絶対パスを取得できなかった場合
  - isRedirect
```
public boolean isRedirect()
```
    レスポンスがリダイレクトかどうか判定する。
    
    戻り値:
    
    レスポンスがリダイレクトであればtrue

クラス ResourceLocator

フィールドのサマリー

メソッドのサマリー

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

フィールドの詳細

SCHEMES

ALLOWED_CHAR

SYNTAX

メソッドの詳細

valueOf

isValidPath

getScheme

getDirectory

isRelative

getResourceName

getHostname

getPath

toString

getRealPath

exists

getReader

getInputStream

isRedirect