Package org.apache.myfaces.application
Class FacesServletMapping
- java.lang.Object
- 
- org.apache.myfaces.application.FacesServletMapping
 
- 
 public class FacesServletMapping extends Object Represents a mapping entry of the FacesServlet in the web.xml configuration file.
- 
- 
Constructor SummaryConstructors Constructor Description FacesServletMapping()
 - 
Method SummaryAll Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static FacesServletMappingcreateExactMapping(String exact)static FacesServletMappingcreateExtensionMapping(String extension)Creates a new FacesServletMapping object using extension mapping.static FacesServletMappingcreatePrefixMapping(String path)Creates a new FacesServletMapping object using prefix mapping.StringgetExact()StringgetExtension()Returns the extension (".jsf", for example) which has been specified in the url-pattern of the FacesServlet mapping.StringgetPrefix()Returns the path ("/faces", for example) which has been specified in the url-pattern of the FacesServlet mapping.StringgetUrlPattern()Returns the url-pattern entry for this servlet mapping.booleanisExactMapping()booleanisExtensionMapping()Indicates whether this mapping is based on an extension (e.g.booleanisPrefixMapping()Indicates whether this mapping is based on a prefix (e.g.voidsetExact(String exact)voidsetExtension(String extension)Sets the extension (".jsf", for example) which has been specified in the url-pattern of the FacesServlet mapping.voidsetPrefix(String path)Sets the path ("/faces/", for example) which has been specified in the url-pattern.StringtoString()
 
- 
- 
- 
Method Detail- 
createPrefixMappingpublic static FacesServletMapping createPrefixMapping(String path) Creates a new FacesServletMapping object using prefix mapping.- Parameters:
- path- The path ("/faces", for example) which has been specified in the url-pattern of the FacesServlet mapping.
- Returns:
- a newly created FacesServletMapping
 
 - 
createExtensionMappingpublic static FacesServletMapping createExtensionMapping(String extension) Creates a new FacesServletMapping object using extension mapping.- Parameters:
- extension- The extension (".jsf", for example) which has been specified in the url-pattern of the FacesServlet mapping.
- Returns:
- a newly created FacesServletMapping
 
 - 
createExactMappingpublic static FacesServletMapping createExactMapping(String exact) 
 - 
getPrefixpublic String getPrefix() Returns the path ("/faces", for example) which has been specified in the url-pattern of the FacesServlet mapping. If this mapping is based on an extension,nullwill be returned. Note that this path is not the same as the specified url-pattern as the trailing "/*" is omitted.- Returns:
- the path which has been specified in the url-pattern
 
 - 
setPrefixpublic void setPrefix(String path) Sets the path ("/faces/", for example) which has been specified in the url-pattern.- Parameters:
- path- The path which has been specified in the url-pattern
 
 - 
getExtensionpublic String getExtension() Returns the extension (".jsf", for example) which has been specified in the url-pattern of the FacesServlet mapping. If this mapping is not based on an extension,nullwill be returned.- Returns:
- the extension which has been specified in the url-pattern
 
 - 
setExtensionpublic void setExtension(String extension) Sets the extension (".jsf", for example) which has been specified in the url-pattern of the FacesServlet mapping.- Parameters:
- extension- The extension which has been specified in the url-pattern
 
 - 
isExtensionMappingpublic boolean isExtensionMapping() Indicates whether this mapping is based on an extension (e.g. ".jsp").- Returns:
- true, if this mapping is based is on an extension,- falseotherwise
 
 - 
isPrefixMappingpublic boolean isPrefixMapping() Indicates whether this mapping is based on a prefix (e.g. /faces/*").- Returns:
- true, if this mapping is based is on a prefix,- falseotherwise
 
 - 
getUrlPatternpublic String getUrlPattern() Returns the url-pattern entry for this servlet mapping.- Returns:
- the url-pattern entry for this servlet mapping
 
 - 
getExactpublic String getExact() 
 - 
setExactpublic void setExact(String exact) 
 - 
isExactMappingpublic boolean isExactMapping() 
 
- 
 
-