public interface Mapping
Configuration element describing the mapping between a view identifier URL pattern to a corresponding processor class.
Modifier and Type | Method and Description |
---|---|
Mappings |
getMappings()
|
Mechanism |
getMechanism()
Return a description of the mechanism used to return the response
from this processor.
|
String |
getPattern()
Return the matching pattern for the view identifier for this
request, used to determine if this is the appropriate
Mapping
for processing the current request or not. |
Processor |
getProcessor()
Return the
Processor instance to be used to process
requests where the view identifier matches our pattern . |
String |
mapResourceId(javax.faces.context.FacesContext context,
String resourceId)
Map the specified resource identifier to a complete URL that may
be used to request this resource from the server.
|
String |
mapViewId(javax.faces.context.FacesContext context)
|
void |
setMappings(Mappings mappings)
|
void |
setMechanism(Mechanism mechanism)
Set the mechanism used by this mapping.
|
void |
setPattern(String pattern)
Set the matching pattern used by this mapping.
|
void |
setProcessor(Processor processor)
Set the
Processor instance used by this mapping. |
Mappings getMappings()
Mechanism getMechanism()
Return a description of the mechanism used to return the response from this processor. This value may be interpreted, for example, by a JavaServer Faces component that wishes to calculate an appropriate URL for a component specific resource that is packaged in a particular manner.
void setMechanism(Mechanism mechanism)
Set the mechanism used by this mapping.
mechanism
- The new mechanismString getPattern()
Return the matching pattern for the view identifier for this
request, used to determine if this is the appropriate Mapping
for processing the current request or not.
void setPattern(String pattern)
Set the matching pattern used by this mapping.
pattern
- The new patternProcessor getProcessor()
Return the Processor
instance to be used to process
requests where the view identifier matches our pattern
.
void setProcessor(Processor processor)
Set the Processor
instance used by this mapping.
processor
- The new Processor
instanceString mapResourceId(javax.faces.context.FacesContext context, String resourceId)
Map the specified resource identifier to a complete URL that may be used to request this resource from the server.
context
- FacesContext
for the current requestresourceId
- Resource identifier to be mappedString mapViewId(javax.faces.context.FacesContext context)
If the specified view identifier matches the pattern specified by
this Mapping
, return the corresponding resource identifier
that should be passed on to our Processor
. If the specified
view identifier does not match, return null
instead.
context
- FacesContext
for the current requestCopyright © 2004-2013 Apache Software Foundation. All Rights Reserved.