com.liferay.faces.bridge

Class BridgeURLFactory

java.lang.Object

com.liferay.faces.bridge.BridgeURLFactory

All Implemented Interfaces:

javax.faces.FacesWrapper<BridgeURLFactory>

public abstract class BridgeURLFactory
extends Object
implements javax.faces.FacesWrapper<BridgeURLFactory>

This factory is responsible for creating instances of BridgeURL.

Author:

Neil Griffin

Constructor Summary

Constructors

Constructor and Description
BridgeURLFactory()

Method Summary

Methods

Modifier and Type	Method and Description
abstract BridgeURL	getBridgeActionURL(javax.faces.context.FacesContext facesContext, String uri) Returns a new action URL instance of BridgeURL.
static BridgeURL	getBridgeActionURLInstance(javax.faces.context.FacesContext facesContext, String uri) Returns a new action URL instance of BridgeURL from the BridgeURLFactory found by the BridgeFactoryFinder.
abstract BridgeURL	getBridgeBookmarkableURL(javax.faces.context.FacesContext facesContext, String uri, Map<String,List<String>> parameters) Returns a new bookmarkable URL instance of BridgeURL.
static BridgeURL	getBridgeBookmarkableURLInstance(javax.faces.context.FacesContext facesContext, String uri, Map<String,List<String>> parameters) Returns a new bookmarkable URL instance of BridgeURL from the BridgeURLFactory found by the BridgeFactoryFinder.
abstract BridgeURL	getBridgePartialActionURL(javax.faces.context.FacesContext facesContext, String uri) Returns a new partial action URL instance of BridgeURL.
static BridgeURL	getBridgePartialActionURLInstance(javax.faces.context.FacesContext facesContext, String uri) Returns a new partial action URL instance of BridgeURL from the BridgeURLFactory found by the BridgeFactoryFinder.
abstract BridgeURL	getBridgeRedirectURL(javax.faces.context.FacesContext facesContext, String uri, Map<String,List<String>> parameters) Returns a new redirect URL instance of BridgeURL.
static BridgeURL	getBridgeRedirectURLInstance(javax.faces.context.FacesContext facesContext, String uri, Map<String,List<String>> parameters) Returns a new redirect URL instance of BridgeURL from the BridgeURLFactory found by the BridgeFactoryFinder.
abstract BridgeURL	getBridgeResourceURL(javax.faces.context.FacesContext facesContext, String uri) Returns a new resource URL instance of BridgeURL.
static BridgeURL	getBridgeResourceURLInstance(javax.faces.context.FacesContext facesContext, String uri) Returns a new resource URL instance of BridgeURL from the BridgeURLFactory found by the BridgeFactoryFinder.
abstract BridgeURLFactory	getWrapped() Returns the wrapped factory instance if this factory decorates another.

Methods inherited from class java.lang.Object

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

Constructor Detail

BridgeURLFactory

public BridgeURLFactory()

Method Detail

getBridgeActionURLInstance

public static BridgeURL getBridgeActionURLInstance(javax.faces.context.FacesContext facesContext,
                                   String uri)

Returns a new action URL instance of BridgeURL from the BridgeURLFactory found by the BridgeFactoryFinder. The returned instance is not guaranteed to be Serializable.

getBridgeBookmarkableURLInstance

public static BridgeURL getBridgeBookmarkableURLInstance(javax.faces.context.FacesContext facesContext,
                                         String uri,
                                         Map<String,List<String>> parameters)

Returns a new bookmarkable URL instance of BridgeURL from the BridgeURLFactory found by the BridgeFactoryFinder. The returned instance is not guaranteed to be Serializable.

getBridgePartialActionURLInstance

public static BridgeURL getBridgePartialActionURLInstance(javax.faces.context.FacesContext facesContext,
                                          String uri)

Returns a new partial action URL instance of BridgeURL from the BridgeURLFactory found by the BridgeFactoryFinder. The returned instance is not guaranteed to be Serializable.

getBridgeRedirectURLInstance

public static BridgeURL getBridgeRedirectURLInstance(javax.faces.context.FacesContext facesContext,
                                     String uri,
                                     Map<String,List<String>> parameters)

Returns a new redirect URL instance of BridgeURL from the BridgeURLFactory found by the BridgeFactoryFinder. The returned instance is not guaranteed to be Serializable.

getBridgeResourceURLInstance

public static BridgeURL getBridgeResourceURLInstance(javax.faces.context.FacesContext facesContext,
                                     String uri)

Returns a new resource URL instance of BridgeURL from the BridgeURLFactory found by the BridgeFactoryFinder. The returned instance is not guaranteed to be Serializable.

getBridgeActionURL

public abstract BridgeURL getBridgeActionURL(javax.faces.context.FacesContext facesContext,
                           String uri)
                                      throws BridgeException

Returns a new action URL instance of BridgeURL. The returned instance is not guaranteed to be Serializable. The return value of BridgeURL.toString() conforms to the deviation requirements of ExternalContext.encodeActionURL(String) listed in Section 6.1.3.1 of the Bridge Spec.

Parameters:

facesContext - The FacesContext instance associated with the current request.

uri - The URI that is to be encoded.

Returns:

The bridge action URL that corresponds to the specified URI.

Throws:

BridgeException - if the specified URI is an invalid reference.

getBridgeBookmarkableURL

public abstract BridgeURL getBridgeBookmarkableURL(javax.faces.context.FacesContext facesContext,
                                 String uri,
                                 Map<String,List<String>> parameters)
                                            throws BridgeException

Returns a new bookmarkable URL instance of BridgeURL. The returned instance is not guaranteed to be Serializable. The return value of BridgeURL.toString() conforms to the requirements of ExternalContext.encodeBookmarkableURL(String, Map).

Parameters:

facesContext - The FacesContext instance associated with the current request.

uri - The URI that is to be encoded.

Returns:

The bridge bookmarkable URL that corresponds to the specified URI.

Throws:

BridgeException - if the specified URI is an invalid reference.

getBridgePartialActionURL

public abstract BridgeURL getBridgePartialActionURL(javax.faces.context.FacesContext facesContext,
                                  String uri)
                                             throws BridgeException

Returns a new partial action URL instance of BridgeURL. The returned instance is not guaranteed to be Serializable. The return value of BridgeURL.toString() conforms to the requirements of ExternalContext.encodePartialActionURL(String).

Parameters:

facesContext - The FacesContext instance associated with the current request.

uri - The URI that is to be encoded.

Returns:

The bridge partial action URL that corresponds to the specified URI.

Throws:

BridgeException - if the specified URI is an invalid reference.

getBridgeRedirectURL

public abstract BridgeURL getBridgeRedirectURL(javax.faces.context.FacesContext facesContext,
                             String uri,
                             Map<String,List<String>> parameters)
                                        throws BridgeException

Returns a new redirect URL instance of BridgeURL. The returned instance is not guaranteed to be Serializable. The return value of BridgeURL.toString(), conforms to the requirements of ExternalContext.encodeRedirectURL(String, Map) and the deviation requirements of ExternalContext.redirect(String) listed in Section 6.1.3.1 of the Bridge Spec.

Parameters:

facesContext - The FacesContext instance associated with the current request.

uri - The URI that is to be encoded.

Returns:

The bridge redirect URL that corresponds to the specified URI.

Throws:

BridgeException - if the specified URI is an invalid reference.

getBridgeResourceURL

public abstract BridgeURL getBridgeResourceURL(javax.faces.context.FacesContext facesContext,
                             String uri)
                                        throws BridgeException

Returns a new resource URL instance of BridgeURL. The returned instance is not guaranteed to be Serializable. The return value of BridgeURL.toString() conforms to the deviation requirements of ExternalContext.encodeResourceURL(String) listed in Section 6.1.3.1 of the Bridge Spec.

Parameters:

facesContext - The FacesContext instance associated with the current request.

uri - The URI that is to be encoded.

Returns:

The bridge resource URL that corresponds to the specified URI.

Throws:

BridgeException - if the specified URI is an invalid reference.

getWrapped

public abstract BridgeURLFactory getWrapped()

Returns the wrapped factory instance if this factory decorates another. Otherwise, this method returns null.

Specified by:

getWrapped in interface javax.faces.FacesWrapper<BridgeURLFactory>