org.apache.beehive.netui.core.urls
Interface TemplatedURLFormatter
- All Known Implementing Classes:
- DefaultTemplatedURLFormatter
public interface TemplatedURLFormatter
Offers a method for formatting URLs based on templates from a URL
template config file. A template is chosen from a reference group
based on the template type (key).
Method Summary |
String |
getTemplatedURL(ServletRequest request,
MutableURI uri,
String key,
URIContext uriContext)
Format the given URL using a URL template, if defined in a URL
template config file. |
getTemplatedURL
String getTemplatedURL(ServletRequest request,
MutableURI uri,
String key,
URIContext uriContext)
- Format the given URL using a URL template, if defined in a URL
template config file. The
URIContext
encapsulates some additional data needed to write out the string form.
E.g. It defines if the "&" entity or the
'&' character should be used to separate quary parameters.
- Parameters:
request
- the current ServletRequest.uri
- the MutableURI to be formatted into a String.key
- key for the URL template type to use for formatting the URIuriContext
- data required to write out the string form.
- Returns:
- the URL as a
String