インターフェース HttpServletMapping
public interface HttpServletMapping
現在の
HttpServletRequest
のHttpServlet
が呼び出された方法のランタイム検出を許可します。いずれかのメソッドを呼び出しても、呼び出し元をブロックしてはなりません。実装はスレッドセーフでなければなりません。インスタンスは不変であり、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
であるため、servletName
列は省略されています。さまざまな URI パスのプロパティの期待値 URI パス (引用符) matchValue パターン mappingMatch "" "" "" CONTEXT_ROOT "/index.html" "" / DEFAULT "/MyServlet" MyServlet /MyServlet EXACT "/foo.extension" foo *.extension EXTENSION "/path/foo" foo /path/* PATH - 導入:
- Servlet 4.0
メソッドのサマリー
すべてのメソッド インスタンスメソッド 抽象メソッド 修飾子と型 メソッド 説明 MappingMatch
getMappingMatch()
このインスタンスのMappingMatch
を返しますStringSE
getMatchValue()
このリクエストを一致させる原因となった URI パスの部分を返します。StringSE
getPattern()
このマッピングのurl-pattern
の文字列表現を返します。StringSE
getServletName()
このマッピングのservlet-name
の文字列表現を返します。
メソッドの詳細
getMatchValue
StringSE getMatchValue()
このリクエストを一致させる原因となった URI パスの部分を返します。
getMappingMatch()
値がCONTEXT_ROOT
またはDEFAULT
の場合、このメソッドは空の文字列を返す必要があります。getMappingMatch()
値がEXACT
の場合、このメソッドは、先頭のスラッシュを省略して、サーブレットに一致したパスの部分を返す必要があります。getMappingMatch()
値がEXTENSION
またはPATH
の場合、このメソッドは "*" に一致した値を返す必要があります。例については、クラス javadoc を参照してください。- 戻り値:
- 試合。
getPattern
StringSE getPattern()
このマッピングの
url-pattern
の文字列表現を返します。getMappingMatch()
値がCONTEXT_ROOT
の場合、このメソッドは空の文字列を返す必要があります。getMappingMatch()
値がEXTENSION
の場合、このメソッドは、先行スラッシュなしでパターンを返す必要があります。それ以外の場合、このメソッドは、記述子または Java 構成で指定されているとおりにパターンを返します。- 戻り値:
- このマッピングの
url-pattern
の String 表現。
getServletName
StringSE getServletName()
このマッピングの
servlet-name
のストリング表現を返します。レスポンスを提供するサーブレットがデフォルトのサーブレットである場合、このメソッドから返されるのはコンテナー固有のデフォルトのサーブレットの名前です。- 戻り値:
- このマッピングの
servlet-name
の String 表現。
getMappingMatch
MappingMatch getMappingMatch()
このインスタンスの
MappingMatch
を返します- 戻り値:
- このインスタンスの
MappingMatch
。