public class UriManagerBase extends UriManager
Constructor and Description |
---|
UriManagerBase() |
Modifier and Type | Method and Description |
---|---|
boolean |
addQueryParameters(javax.faces.context.FacesContext context, Map<String,String> params, boolean redirectIfNecessary)
Adds query parameters to the current view's URL
|
protected Map<String,String[]> |
filterExisitingQueryParameters(javax.faces.context.FacesContext context, Map<String,String[]> parameters)
A hook for subclasses to filter out unwanted existing query parameters
|
protected String |
getQueryString(javax.faces.context.FacesContext context, String viewId, Map<String,String> params, boolean preserveParams)
Utility method for returning a portion of the URI containing query parameters
|
boolean |
makeBookmarkable(javax.faces.context.FacesContext context, String viewId, Map<String,String> params)
Navigates to a bookmarkable URL.
|
protected void |
makeBookmarkableBase(javax.faces.context.FacesContext context, String viewId, Map<String,String> params, boolean preserveParams)
Utility method that implementations may call to perform a redirect-based oparation for making the URI bookmarkable
|
addQueryParameters
public boolean addQueryParameters(javax.faces.context.FacesContext context, Map<String,String> params, boolean redirectIfNecessary) throws IOException
UriManager
addQueryParameters
in class UriManager
context
- Faces contextparams
- a map with name-value pairs, where keys represent parameter names. Existing query parameters on the URI will be preserved unless they are overridden with new values from the mapredirectIfNecessary
- true if a client-side redirect should be issued when the new query parameters cannot be added to the URI by other means, false otherwise. The consumer fo this interface will normally pass true for the GET requests. For the POST requests, the new query parameters will be reflected in the action URLIOException
public boolean makeBookmarkable(javax.faces.context.FacesContext context, String viewId, Map<String,String> params) throws IOException
UriManager
makeBookmarkable
in class UriManager
context
- Faces contextviewId
- - View Id for the navigation targetparams
- a map with name-value pairs, where keys represent parameter names. Existing query parameters on the URI will be preserved when no navigation is known to occurrIOException
protected void makeBookmarkableBase(javax.faces.context.FacesContext context, String viewId, Map<String,String> params, boolean preserveParams) throws IOException
context
- Faces contextviewId
- - View Id for the navigation targetparams
- a map with name-value pairs, where keys represent parameter names. Existing query parameters on the URI will be preserved when no navigation is known to occurrpreserveParams
- true
is the existing query parameters should be preservedIOException
protected String getQueryString(javax.faces.context.FacesContext context, String viewId, Map<String,String> params, boolean preserveParams)
context
- Faces contextviewId
- the view Id of the page that will be renderedparams
- a map with name-value pairs, where keys represent parameter namespreserveParams
- true
if the existing query parameters should be preservedprotected Map<String,String[]> filterExisitingQueryParameters(javax.faces.context.FacesContext context, Map<String,String[]> parameters)
context
- Faces contextparameters
- existing query parameters