de.innovationgate.wgpublisher.webtml.utils

Class URLBuilder

java.lang.Object

de.innovationgate.utils.URLBuilder

de.innovationgate.wgpublisher.webtml.utils.URLBuilder

All Implemented Interfaces:

Cloneable

public class URLBuilder
extends de.innovationgate.utils.URLBuilder
implements Cloneable

WGA version of the URLBuilder from WGUtils, including control of some WGA-only features, especially var parameters. Var parameters are encrypted URL parameters that are added to the WebTML variables of the request whose URL contains them.

Field Summary

Fields

Modifier and Type	Field and Description
static String	URLPARAM_VARS Name of the URL parameter carrying data about var parameters

Constructor Summary

Constructors

Constructor and Description
URLBuilder(TMLContext context, URL url) Constructor using a URL with a TMLContext as context parameter
URLBuilder(WGA wga, URL url) Constructor using a URL

Method Summary

Modifier and Type	Method and Description
String	buildLikeGiven() Returns an absolute URL if an absolute URL was given to to the URLBuild object on construction and a relative URL (complete path without host, protocol and port) if not
URLBuilder	clearVarParameters() Removes all var parameters
URLBuilder	clone()
static VarParamsMap	extractVarParameters(String varParam, WGACore core) Reades var parameters from an encrypted var parameter value
Object	getVarParameter(String name) Reads the value of the var parameter of the given name
Set<String>	getVarParameterNames() Returns the names of all existing var parameters
boolean	hasVarParameter(String name) Tests if a var parameter of the given name exists
boolean	isAbsoluteUrlGiven() Returns if the URLBuilder object was constructed from an absolute URL
boolean	isSessionBoundParams() Returns if the var parameters are bound to the user session for which they were created
URLBuilder	removeVarParameter(String name) Removes the var parameter of the given name
void	setAbsoluteUrlGiven(boolean fullUrlGiven) Sets if the URLBuilder object was constructed from an absolute URL
URLBuilder	setProtocol(String protocol)
URLBuilder	setSessionBoundParams(boolean sessionBoundParams) Sets if the var parameters are bound to the user session for which they were created
URLBuilder	setVarParameter(String name, Object value) Sets a var parameter

Methods inherited from class de.innovationgate.utils.URLBuilder

addQueryString, appendPath, build, build, clearParameters, getDefaultPortForProtocol, getEncoding, getFragment, getHost, getParameter, getParameterEncoding, getParameterNames, getPath, getPort, getProtocol, getQuery, hasParameter, isDefaultPortForProtocol, rebuild, rebuild, removeParameter, setEncoding, setFragment, setHost, setParameter, setParameterEncoding, setPath, setPort, setQuery, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

URLPARAM_VARS

public static final String URLPARAM_VARS

Name of the URL parameter carrying data about var parameters

See Also:

Constant Field Values

Constructor Detail

URLBuilder

public URLBuilder(WGA wga,
                  URL url)
           throws de.innovationgate.webgate.api.WGException,
                  GeneralSecurityException,
                  IOException

Constructor using a URL

Parameters:

wga - The WGA context object

url - The url that this builder should load

Throws:

de.innovationgate.webgate.api.WGException

GeneralSecurityException

IOException

URLBuilder

public URLBuilder(TMLContext context,
                  URL url)
           throws de.innovationgate.webgate.api.WGException,
                  GeneralSecurityException,
                  IOException

Constructor using a URL with a TMLContext as context parameter

Parameters:

context - WebTML context

url - The url that this builder should load

Throws:

de.innovationgate.webgate.api.WGException

GeneralSecurityException

IOException

Method Detail

extractVarParameters

public static VarParamsMap extractVarParameters(String varParam,
                                                WGACore core)
                                         throws GeneralSecurityException,
                                                IOException

Reades var parameters from an encrypted var parameter value

Parameters:

varParam - The var parameter value

core - WGACore object

Returns:

A decrypted map of var parameters

Throws:

GeneralSecurityException

IOException

getVarParameter

public Object getVarParameter(String name)

Reads the value of the var parameter of the given name

Parameters:

name - Var parameter name

removeVarParameter

public URLBuilder removeVarParameter(String name)

Removes the var parameter of the given name

Parameters:

name - Var parameter name

hasVarParameter

public boolean hasVarParameter(String name)

Tests if a var parameter of the given name exists

Parameters:

name - Var parameter name

setVarParameter

public URLBuilder setVarParameter(String name,
                                  Object value)

Sets a var parameter

Parameters:

name - Var parameter name

value - Var parameter value

clearVarParameters

public URLBuilder clearVarParameters()

Removes all var parameters

setProtocol

public URLBuilder setProtocol(String protocol)

Overrides:

setProtocol in class de.innovationgate.utils.URLBuilder

isSessionBoundParams

public boolean isSessionBoundParams()

Returns if the var parameters are bound to the user session for which they were created

setSessionBoundParams

public URLBuilder setSessionBoundParams(boolean sessionBoundParams)

Sets if the var parameters are bound to the user session for which they were created

Parameters:

sessionBoundParams -

getVarParameterNames

public Set<String> getVarParameterNames()

Returns the names of all existing var parameters

isAbsoluteUrlGiven

public boolean isAbsoluteUrlGiven()

Returns if the URLBuilder object was constructed from an absolute URL

setAbsoluteUrlGiven

public void setAbsoluteUrlGiven(boolean fullUrlGiven)

Sets if the URLBuilder object was constructed from an absolute URL

buildLikeGiven

public String buildLikeGiven()

Returns an absolute URL if an absolute URL was given to to the URLBuild object on construction and a relative URL (complete path without host, protocol and port) if not

clone

public URLBuilder clone()
                 throws CloneNotSupportedException

Overrides:

clone in class de.innovationgate.utils.URLBuilder

Throws:

CloneNotSupportedException