public interface Mappings
Configuration object used to manage the Mapping
instances for
a particular web application.
Modifier and Type | Method and Description |
---|---|
void |
addMapping(Mapping mapping)
Add the specified
Mapping to the set of mappings for which
remoting services are supplied. |
String |
getExtension()
Return the extension that will replace the
FacesServlet
extension pattern, if FacesServlet is extension mapped. |
Mapping |
getMapping(String pattern)
Return the
Mapping , if any, for the specified matching
pattern . |
List |
getMappings()
Return a
List of all the currently defined Mapping s
for this application. |
int |
getPatternIndex()
Return the zero-relative index, into the array returned by
getPatterns() , of the URL pattern to be used by default
when creating URLs for resources. |
String[] |
getPatterns()
Return a list of URL patterns that this application has mapped to
FacesServlet . |
void |
removeMapping(Mapping mapping)
Remove the specified
Mapping from the set of mappings for which
remoting services are supplied, if it is currently included. |
void |
setExtension(String extension)
Set the extension that will replace the
FacesServlet
extension pattern, if FacesServlet is extension mapped. |
void |
setPatternIndex(int patternIndex)
Set the zero-relative index, into the array returned by
getPatterns() , of the URL pattern to be used by default
when creating URLs for resources. |
void |
setPatterns(String[] patterns)
Set a list of URL patterns that this application has mapped to
FacesServlet . |
void addMapping(Mapping mapping)
Add the specified Mapping
to the set of mappings for which
remoting services are supplied.
mapping
- The new Mapping
to be addedIllegalStateException
- if there is an existing Mapping
already defined for the specified pattern
NullPointerException
- if mapping
is null
String getExtension()
Return the extension that will replace the FacesServlet
extension pattern, if FacesServlet
is extension mapped.
Mapping getMapping(String pattern)
Return the Mapping
, if any, for the specified matching
pattern
. If there is no such Mapping
, return
null
instead.
pattern
- Matching pattern for which to return a Mapping
List getMappings()
int getPatternIndex()
Return the zero-relative index, into the array returned by
getPatterns()
, of the URL pattern to be used by default
when creating URLs for resources.
void setPatternIndex(int patternIndex)
Set the zero-relative index, into the array returned by
getPatterns()
, of the URL pattern to be used by default
when creating URLs for resources. If not called, the default value
will be zero.
patternIndex
- The new pattern indexString[] getPatterns()
Return a list of URL patterns that this application has mapped to
FacesServlet
. This information is useful to renderers that
wish to dynamically calculate URLs that will be guaranteed to trigger
the JSF request processing lifecycle.
void removeMapping(Mapping mapping)
Remove the specified Mapping
from the set of mappings for which
remoting services are supplied, if it is currently included.
mapping
- The Mapping
to be removedNullPointerException
- if mapping
is null
void setExtension(String extension)
Set the extension that will replace the FacesServlet
extension pattern, if FacesServlet
is extension mapped.
extension
- The new extensionvoid setPatterns(String[] patterns)
Set a list of URL patterns that this application has mapped to
FacesServlet
. If no patterns are known, this SHOULD
be set to a zero-length array, rather than null
.
patterns
- The new list of patternsCopyright © 2004-2013 Apache Software Foundation. All Rights Reserved.