javax.servlet.http

Interface ServletMapping

public interface ServletMapping

Allows runtime discovery of the manner in which the HttpServlet for the current HttpServletRequest was invoked. Invoking any of the methods must not block the caller. The implementation must be thread safe. Instances are returned from HttpServletRequest.getServletMapping().

Following are some illustrative examples for various combinations of mappings. Consider the following Servlet declaration:

 <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>
 

The expected values of the properties for various incoming URI path values are as shown in this table. The servletName column is omitted as its value is always MyServlet.

Expected values of properties for various URI paths

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

Since:

4.0

Method Summary

Modifier and Type	Method and Description
MappingMatch	getMappingMatch() Return the MappingMatch for this instance
String	getMatchValue() Return the actual value that caused this request to be matched or the empty String if not known or not knowable.
String	getPattern() Return the String representation for the url-pattern for this mapping or the empty String if not known or not knowable.
String	getServletName() Return the String representation for the servlet-name for this mapping or the empty String if not known or not knowable.

Method Detail

getMatchValue

String getMatchValue()

Return the actual value that caused this request to be matched or the empty String if not known or not knowable.

Returns:

the match.

Since:

4.0

getPattern

String getPattern()

Return the String representation for the url-pattern for this mapping or the empty String if not known or not knowable.

Returns:

the String representation for the url-pattern for this mapping or the empty String if not known or not knowable.

Since:

4.0

getServletName

String getServletName()

Return the String representation for the servlet-name for this mapping or the empty String if not known or not knowable.

Returns:

the String representation for the servlet-name for this mapping or the empty String if not known or not knowable.

Since:

4.0

getMappingMatch

MappingMatch getMappingMatch()

Return the MappingMatch for this instance

Returns:

the MappingMatch for this instance.

Since:

4.0