Skip navigation links

oracle.adf.view.rich.context
Class UriManagerBase

java.lang.Object
oracle.adf.view.rich.context.UriManager
oracle.adf.view.rich.context.UriManagerBase

public class UriManagerBase

extends UriManager

Base implementation of the UriManager

Constructor Summary

UriManagerBase()

Method Summary

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

Methods inherited from class oracle.adf.view.rich.context.UriManager

addQueryParameters

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

UriManagerBase

public UriManagerBase()

Method Detail

addQueryParameters

public boolean addQueryParameters(javax.faces.context.FacesContext context,
                                  Map<String,String> params,
                                  boolean redirectIfNecessary)
                           throws IOException

Description copied from class: UriManager

Adds query parameters to the current view's URL

Specified by:

addQueryParameters in class UriManager

Parameters:

context - Faces context

params - 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 map

redirectIfNecessary - 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 URL

Returns:

true if adding parameters resulted in issuing a client-side redirect, false otherwise. If a redirect was performed, the caller may assume that FacesContext.responseComplete() has been called

Throws:

IOException

makeBookmarkable

public boolean makeBookmarkable(javax.faces.context.FacesContext context,
                                String viewId,
                                Map<String,String> params)
                         throws IOException

Description copied from class: UriManager

Navigates to a bookmarkable URL.

Specified by:

makeBookmarkable in class UriManager

Parameters:

context - Faces context

viewId - - View Id for the navigation target

params - 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 occurr

Returns:

true if making this URI bookmarkable resulted in issuing a client-side redirect, false otherwise If a redirect was performed, the caller may assume that FacesContext.responseComplete() has been called Otherwise, the caller is responsible for setting a new Vew root on FacesContext

Throws:

IOException

makeBookmarkableBase

protected void makeBookmarkableBase(javax.faces.context.FacesContext context,
                                    String viewId,
                                    Map<String,String> params,
                                    boolean preserveParams)
                             throws IOException

Utility method that implementations may call to perform a redirect-based oparation for making the URI bookmarkable

Parameters:

context - Faces context

viewId - - View Id for the navigation target

params - 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 occurr

preserveParams - true is the existing query parameters should be preserved

Throws:

IOException

getQueryString

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

Parameters:

context - Faces context

viewId - the view Id of the page that will be rendered

params - a map with name-value pairs, where keys represent parameter names

preserveParams - true if the existing query parameters should be preserved

Returns:

portion of the URI containing query parameters (beginning with '?')

filterExisitingQueryParameters

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

Parameters:

context - Faces context

parameters - existing query parameters

Returns:

existring query parameters that should be used by this implementation

Skip navigation links