javax.servlet.http

インタフェース HttpServletMapping

public interface HttpServletMapping

現在のHttpServlet が HttpServletRequestから呼び出された方法を実行時に見つけることを可能にします。 いずれのメソッド呼びだしも呼び出し元をブロックしてはいけません。 実装はスレッドセーフでなければなりません。 インスタンスは不変でHttpServletRequest.getHttpServletMapping()から返されます。

以下はマッピングの様々な組み合わせのうちのいくつかの実例です。 以下のサーブレット宣言を考えてみましょう。

 <servlet>
     <servlet-name>MyServlet</servlet-name>
     <servlet-class>MyServlet</servlet-class>
 </servlet>
 <servlet-mapping>
     <servlet-name>MyServlet</servlet-name>
     <url-pattern>/MyServlet</url-pattern>
     <url-pattern>""</url-pattern>
     <url-pattern>*.extension</url-pattern>
     <url-pattern>/path/*</url-pattern>
 </servlet-mapping>
 

さまざまな待ち受けURIパスの値におけるプロパティの期待値はこの表に示すとおりです。 servletName列は値が常にMyServletのため省略されています。

さまざまなURIパスにおけるプロパティの期待値

URI Path (in quotes)	matchValue	pattern	MappingMatch
""	""	""	CONTEXT_ROOT
"/index.html"	""	/	DEFAULT
"/MyServlet"	MyServlet	/MyServlet	EXACT
"/foo.extension"	foo	*.extension	EXTENSION
"/path/foo"	foo	/path/*	PATH

導入されたバージョン:

4.0

メソッドのサマリー

修飾子とタイプ	メソッドと説明
MappingMatch	getMappingMatch() このインスタンスのMappingMatch を返します。
String	getMatchValue() このリクエストの原因となったURIパスの一部分を返します。
String	getPattern() このマッピングのurl-patternの文字列表現を返します。
String	getServletName() このマッピングのservlet-nameの文字列表現を返します。

メソッドの詳細

getMatchValue

String getMatchValue()

このリクエストの原因となったURIパスの一部分を返します。

getMappingMatchの値がCONTEXT_ROOTまたはDEFAULTの場合、このメソッドは空の文字列を返さなければいけません。 getMappingMatchの値がEXACTの場合、このメソッドはスラッシュが省略されたサーブレットに一致するパスの一部分を返さなければいけません。 getMappingMatchの値がEXTENSIONまたはPATHの場合、このメソッドは '*'に一致する値を返す必要があります。 例についてはクラスのjavadocを参照してください。

戻り値:

一致した値

導入されたバージョン:

4.0

getPattern

String getPattern()

このマッピングのurl-patternの文字列表現を返します。

getMappingMatchの値がCONTEXT_ROOTまたはDEFAULTの場合このメソッドは空の文字列を返さなければいけません。 getMappingMatchの値がEXTENSIONの場合、このメソッドはスラッシュを付けずにパターンを返さなければいけません。 それ以外の場合は、このメソッドはディスクリプターまたはJavaコンフィギュレーションで指定されているとおりのパターンを返さなければいけません。

戻り値:

このマッピングのurl-patternの文字列表現

導入されたバージョン:

4.0

getServletName

String getServletName()

このマッピングのservlet-nameの文字列表現を返します。

レスポンスを提供するサーブレットがデフォルトサーブレットである場合、このメソッドからの戻り値はコンテナ固有のデフォルトサーブレットの名前です。

戻り値:

このマッピングのservlet-nameの文字列表現

導入されたバージョン:

4.0

getMappingMatch

MappingMatch getMappingMatch()

このインスタンスのMappingMatch を返します。

戻り値:

このインスタンスのMappingMatch

導入されたバージョン:

4.0