URLEncoder (Apache MyFaces Trinidad API 1.2.12.7.0-SNAPSHOT API)

Encodes URL's based on thier type. While the ExternalContext does this to some extent, the types of URL's it encodes are often ill-defined. This utility method allows the caller to ensure that URL's are encoded in the proper fashion depending on which container is active at the time. <p/> Out of the box, this class supports Servlet and Portlet encoding, but it may be extended on a per-request basis to support other types of URL encoding with the use of the "registerURLEncoder" method. <p/> It is also important to note that this does not impact the encoding done by the ExternalContext. As such, all current applications should work without modification if they do not choose to use this API for encoding.

Constructor Summary
`URLEncoder()`

Method Summary
`abstract java.lang.String`	`encodeActionURL(java.lang.String url)` This function should be the same as the `ExternalContext.encodeActionURL(String)` method.
`abstract java.lang.String`	`encodeInProtocolResourceURL(java.lang.String url)` Encodes a url to a resource such that it is inProtocol.
`abstract java.lang.String`	`encodePartialActionURL(java.lang.String url)` This encodes a URL so that it can be used to make a PPR request in all containers.
`abstract java.lang.String`	`encodeRedirectURL(java.lang.String url)` Encodes a url to be explicitly used for a redirect.
`abstract java.lang.String`	`encodeResourceURL(java.lang.String url)` Encodes a url as a resource.
`abstract java.lang.String`	`encodeSkinResourceURL(java.lang.String url)` Encodes a resource URL that is mapped to a skinning resources.

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

URLEncoder

public URLEncoder()

Method Detail

encodeActionURL

public abstract java.lang.String encodeActionURL(java.lang.String url)

This function should be the same as the ExternalContext.encodeActionURL(String) method. By default it call the code in the ExternalContext. The reason its provided here is that certain URLEncoderUtility instances may wish to override the default functionality and have the ExternalContext pull its default encoding from here.

encodePartialActionURL

public abstract java.lang.String encodePartialActionURL(java.lang.String url)

This encodes a URL so that it can be used to make a PPR request in all containers. JSF 2.0 has the ability to encode URL's in such a fashion, but this is missing from JSF 1.2 containers. This method provides the same functionality for JSF 1.2.

Parameters:: url - the unencoded url
Returns:: the encoded url
Throws:: java.lang.IllegalArgumentException - if the URL cannot be encoded

encodeRedirectURL

public abstract java.lang.String encodeRedirectURL(java.lang.String url)

Encodes a url to be explicitly used for a redirect. In some containers, this is encoded as-is. In other containers this may not be encoded or must contain a fully qualified url.

Parameters:: url - the unencoded url
Returns:: the encoded url
Throws:: java.lang.IllegalArgumentException - if the URL cannot be encoded

encodeResourceURL

public abstract java.lang.String encodeResourceURL(java.lang.String url)

Encodes a url as a resource. Generally speaking this will be equivalent to ExternalContext.encodeResourceURL(String). The url returned from this method is NOT guarenteed to be in-protocol (meaning that it MAY not have access to session information). The advantage of encoding something in this fashion is that in certain types of containers, like portals, the URL generated may have faster access and will generally work better for the purposes of caching do to its RESTful state.

Parameters:: url - the unencoded url
Returns:: the encoded url
Throws:: java.lang.IllegalArgumentException - if the URL cannot be encoded

encodeInProtocolResourceURL

public abstract java.lang.String encodeInProtocolResourceURL(java.lang.String url)

Encodes a url to a resource such that it is inProtocol. This means that the URL returned will be encoded in such a way that the resource will have access to the parent application's session. While these URL's do have access to the session information, they may not be written in a format that is easily cachable.

Parameters:: url - the unencoded url
Returns:: the encoded url
Throws:: java.lang.IllegalArgumentException - if the URL cannot be encoded

encodeSkinResourceURL

public abstract java.lang.String encodeSkinResourceURL(java.lang.String url)

Encodes a resource URL that is mapped to a skinning resources. Trinidad has an extensive skinning system that allows for extraction of certain properties like images so that they can be used with the componentry. Generally these image resources are on the same server and whatnot as the actual skin. In a servlet environment, this is always the same server, but in portal-like environments these resources may be on different servers. This encodes a URL that comes from a skin and sends it to the right location.