com.liferay.faces.util.config

Interface ConfiguredServletMapping

All Known Implementing Classes:

ConfiguredServletMappingImpl

public interface ConfiguredServletMapping

This interface provides a representation of a servlet-mapping entry from a web-app descriptor.

Author:

Neil Griffin

Method Summary

Methods

Modifier and Type	Method and Description
String	getExtension() If the servlet-mapping url-pattern is extension-mapped (like *.faces), then this method returns the .faces extension.
String	getServletName() Returns the servlet-mapping servlet-name.
String	getServletPath() If the servlet-mapping url-pattern is path-mapped (like /views/foo/bar/*), then this method returns the /views/foo/bar path.
String	getUrlPattern() Returns the servlet-mapping url-pattern.
boolean	isExtensionMapped() Flag indicating whether or not the servlet-mapping url-pattern is extension-mapped.
boolean	isImplicit() Flag indicating whether or not the servlet-mapping is implicit, meaning it is associated with ViewHandler.DEFAULT_SUFFIX or ViewHandler.DEFAULT_SUFFIX_PARAM_NAME.
boolean	isMatch(String uri) Flag indicating whether or not the specified uri matches the servlet-mapping url-pattern.
boolean	isPathMapped() Flag indicating whether or not the servlet-mapping url-pattern is path-mapped.

Method Detail

getExtension

String getExtension()

If the servlet-mapping url-pattern is extension-mapped (like *.faces), then this method returns the .faces extension. Otherwise returns null.

getServletName

String getServletName()

Returns the servlet-mapping servlet-name.

getServletPath

String getServletPath()

If the servlet-mapping url-pattern is path-mapped (like /views/foo/bar/*), then this method returns the /views/foo/bar path. Otherwise returns null.

getUrlPattern

String getUrlPattern()

Returns the servlet-mapping url-pattern.

isExtensionMapped

boolean isExtensionMapped()

Flag indicating whether or not the servlet-mapping url-pattern is extension-mapped.

isImplicit

boolean isImplicit()

Flag indicating whether or not the servlet-mapping is implicit, meaning it is associated with ViewHandler.DEFAULT_SUFFIX or ViewHandler.DEFAULT_SUFFIX_PARAM_NAME.

isMatch

boolean isMatch(String uri)

Flag indicating whether or not the specified uri matches the servlet-mapping url-pattern.

isPathMapped

boolean isPathMapped()

Flag indicating whether or not the servlet-mapping url-pattern is path-mapped.