cz.ues.platform.security.authn.webtoken

Class AccessTokenHelper

java.lang.Object

cz.ues.platform.security.authn.webtoken.AccessTokenHelper

public final class AccessTokenHelper
extends java.lang.Object

This class contains helper methods for working with acces token.

Since:

UES7-02

Field Summary

Fields

Modifier and Type	Field and Description
private static java.lang.String	ACCESS_TOKEN_PARAM_NAME Name of URL parameter for access token.

Constructor Summary

Constructors

Modifier	Constructor and Description
private	AccessTokenHelper() Creates a new instance of AccessTokenHelper.

Method Summary

Methods

Modifier and Type	Method and Description
static java.lang.String	buildUrl(java.lang.CharSequence url, AccessToken token) Builds new URL from passed URL and access token.
static java.lang.String	buildUrl(java.lang.CharSequence url, java.lang.CharSequence token) Builds new URL from passed URL and access token.
private static java.lang.String	getTokenValue(AccessToken token) Returns string representation of access token suitable to be used as URL parameter value.
private static void	checkBuildUrlParams(java.lang.CharSequence url, java.lang.Object token) Checks parameter for methods buildUrl(...).

Methods inherited from class java.lang.Object

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

Field Detail

ACCESS_TOKEN_PARAM_NAME

private static final ACCESS_TOKEN_PARAM_NAME

Name of URL parameter for access token.

See Also:

Constant Field Values

Constructor Detail

AccessTokenHelper

private AccessTokenHelper()

Creates a new instance of AccessTokenHelper.

Since:

UES7-02

Method Detail

buildUrl

public static java.lang.String buildUrl(java.lang.CharSequence url,
AccessToken token)

Builds new URL from passed URL and access token.

Parameters:

url - URL. This parameter cannot be null.

token - Access token. This token will be added to parameters into the URL. This parameter cannot be null.

Returns:

New URL based on the passed URL. This URL will contain the token parameter inside.

Throws:

AccessTokenRTException - This exception is thrown if either the passed URL already contains parameter for access token or some mandatory parameter is null.

Since:

UES7-02

buildUrl

public static java.lang.String buildUrl(java.lang.CharSequence url,
java.lang.CharSequence token)

Builds new URL from passed URL and access token.

Parameters:

url - URL. This parameter cannot be null.

token - Access token. This token will be added to parameters into the URL. This parameter cannot be null.

Returns:

New URL based on the passed URL. This URL will contain the token parameter inside.

Throws:

AccessTokenRTException - This exception is thrown if either the passed URL already contains parameter for access token or some mandatory parameter is null.

Since:

UES7-02

checkBuildUrlParams

private static void checkBuildUrlParams(java.lang.CharSequence url,
java.lang.Object token)

Checks parameter for methods buildUrl(...).

Parameters:

url - URL. This parameter cannot be null.

token - Access token. This token will be added to parameters into the URL. This parameter cannot be null.

Throws:

AccessTokenRTException - If either URL or token parameter is null.

Since:

UES7-02

getTokenValue

private static java.lang.String getTokenValue(AccessToken token)

Returns string representation of access token suitable to be used as URL parameter value.

Parameters:

token - Access token.

Returns:

String representation of access token suitable as URL parameter value.

Since:

UES7-02