curam.piwrapper.impl

Class ClientURI

java.lang.Object

curam.piwrapper.impl.ClientURI

@AccessLevel(value=EXTERNAL)
public class ClientURI
extends java.lang.Object

Utility class used to construct a URI value to be passed back to the client from the server.

This class can be used to construct the value of a URI_SOURCE_PROPERTY attribute of a link element in a UIM page. Additional page parameters can be appended to the link in the UIM by using CONNECT child elements as normal.

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String	COLON Used to identify a URI as external.
protected static java.lang.String	ENCODING The encoding to be used when escaping URLs.
protected java.lang.String	pageName The name of the UIM page to link to.
protected java.util.Map<java.lang.String,java.lang.String>	parameters A map of the page parameters to be used in the link.
protected static java.lang.String	STRUTS_EXT The Curam standard struts link extension.

Constructor Summary

Constructors

Constructor and Description
ClientURI(java.lang.String pageName) Creates a new URI link.
ClientURI(java.lang.String pageName, java.util.Map<java.lang.String,java.lang.String> parameters) Creates a new URI link with the specified parameters.

Method Summary

Modifier and Type	Method and Description
void	appendParam(java.lang.String name, java.lang.String value) Appends a parameter to the URI link.
static java.lang.String	escapeURL(java.lang.String url) Replaces invalid URL characters with URL escape sequences.
java.lang.String	getInternalURI() Constructs the URI required to populate an internal URI_SOURCE_PROPERTY attribute.
java.lang.String	getPageName() Retrieves the UIM page name of the link.
java.util.Map<java.lang.String,java.lang.String>	getParameters() Retrieves a map of the page parameters.
java.lang.String	getURI() Constructs the URI required to populate a URI_SOURCE_PROPERTY attribute.

Methods inherited from class java.lang.Object

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

Field Detail

ENCODING

protected static final java.lang.String ENCODING

The encoding to be used when escaping URLs.

See Also:

Constant Field Values

COLON

protected static final java.lang.String COLON

Used to identify a URI as external.

See Also:

Constant Field Values

STRUTS_EXT

protected static final java.lang.String STRUTS_EXT

The Curam standard struts link extension.

See Also:

Constant Field Values

pageName

protected final java.lang.String pageName

The name of the UIM page to link to.

parameters

protected final java.util.Map<java.lang.String,java.lang.String> parameters

A map of the page parameters to be used in the link.

Constructor Detail

ClientURI

public ClientURI(java.lang.String pageName,
                 java.util.Map<java.lang.String,java.lang.String> parameters)

Creates a new URI link with the specified parameters.

Parameters:

pageName - The name of the UIM page, this attribute is mandatory and must not be null or empty.

parameters - A map of the page parameters to be used in the link, this attribute is optional.

ClientURI

public ClientURI(java.lang.String pageName)

Creates a new URI link.

Parameters:

pageName - The name of the UIM page, this parameter is mandatory and must not be null or empty.

Method Detail

getPageName

public java.lang.String getPageName()

Retrieves the UIM page name of the link.

Returns:

The name of the UIM page.

getParameters

public java.util.Map<java.lang.String,java.lang.String> getParameters()

Retrieves a map of the page parameters.

Returns:

A map of the page parameters.

getURI

public java.lang.String getURI()

Constructs the URI required to populate a URI_SOURCE_PROPERTY attribute.

Returns:

The URI value.

getInternalURI

public java.lang.String getInternalURI()

Constructs the URI required to populate an internal URI_SOURCE_PROPERTY attribute. This method should only be invoked on internal application pages. An example of where this should be used is where an application page needs to be opened in a modal. The constructed URI takes the form:

"curam:" + Page_Name + "Page.do" + Page_Parameters

Note: This should not be invoked on 'mailto:' pages for example, nor should it be called directly from resolve scripts.

Returns:

The URI for the specified internal application page.

escapeURL

public static java.lang.String escapeURL(java.lang.String url)

Replaces invalid URL characters with URL escape sequences. Any character not an alphanumeric character, a dash, dot, or underscore will be converted to a sequence such as "%20" (space character). This is a percent sign followed by a two-digit hexadecimal representation of the character value.

Parameters:

url - The string to process.

Returns:

The processed string with escape sequences.

appendParam

public void appendParam(java.lang.String name,
                        java.lang.String value)

Appends a parameter to the URI link.

Parameters:

name - The name of the parameter.

value - The value of the parameter.