com.liferay.faces.bridge.context.url
Interface BridgeResourceURL

All Superinterfaces:

BridgeURL

All Known Implementing Classes:

BridgeResourceURLWrapper

public interface BridgeResourceURL
extends BridgeURL

This interface represents a bridge "resource" URL, meaning a URL that has convenience methods for representing URLs according to the deviation requirements of ExternalContext.encodeResourceURL(String) listed in Section 6.1.3.1 of the Bridge Spec.

Author:

Neil Griffin

Method Summary

boolean	isEncodedFaces2ResourceURL() Flag indicating whether or not the URL has already been encoded as a JSF2 resource URL.
boolean	isFaces2ResourceURL() Flag indicating whether or not the URL is a JSF2 resource URL.
void	replaceBackLinkParameter(javax.faces.context.FacesContext facesContext) Replaces the value of the "javax.portlet.BackLink" parameter with an encoded action URL that represents a link to the current Faces viewId.
void	setInProtocol(boolean inProtocol) Sets a flag indicating whether or not the URL must satisfy "in-protocol" resource serving.
void	setViewLink(boolean viewLink) Sets a flag indicating whether or not the URL is a view-link to a Faces view, which is a type of navigation.

Methods inherited from interface com.liferay.faces.bridge.context.url.BridgeURL

getParameter, getParameterMap, isFacesViewTarget, isSecure, isSelfReferencing, setParameter, setParameter, setSecure, setSelfReferencing, toString

Method Detail

replaceBackLinkParameter

void replaceBackLinkParameter(javax.faces.context.FacesContext facesContext)

Replaces the value of the "javax.portlet.BackLink" parameter with an encoded action URL that represents a link to the current Faces viewId.

Parameters:

facesContext - The current FacesContext instance.

setInProtocol

void setInProtocol(boolean inProtocol)

Sets a flag indicating whether or not the URL must satisfy "in-protocol" resource serving.

Parameters:

inProtocol - true if the URL must satisfy "in-protocol" resource serving, otherwise false.

isEncodedFaces2ResourceURL

boolean isEncodedFaces2ResourceURL()

Flag indicating whether or not the URL has already been encoded as a JSF2 resource URL.

isFaces2ResourceURL

boolean isFaces2ResourceURL()

Flag indicating whether or not the URL is a JSF2 resource URL.

setViewLink

void setViewLink(boolean viewLink)

Sets a flag indicating whether or not the URL is a view-link to a Faces view, which is a type of navigation. For more information, refer to the documentation at Bridge.VIEW_LINK.