org.apache.guacamole.token

Class StandardTokens

java.lang.Object

org.apache.guacamole.token.StandardTokens

public class StandardTokens
extends Object

Utility class which provides access to standardized token names, as well as facilities for generating those tokens from common objects.

Field Summary

Fields

Modifier and Type	Field and Description
static String	CLIENT_ADDRESS_TOKEN The name of the client address token added via addStandardTokens().
static String	CLIENT_HOSTNAME_TOKEN The name of the client hostname token added via addStandardTokens().
static String	DATE_TOKEN The name of the date token (server-local time) added via addStandardTokens().
static String	PASSWORD_TOKEN The name of the password token added via addStandardTokens().
static String	TIME_TOKEN The name of the time token (server-local time) added via addStandardTokens().
static String	USERNAME_TOKEN The name of the username token added via addStandardTokens().

Method Summary

Modifier and Type	Method and Description
static void	addStandardTokens(TokenFilter filter) Adds tokens which are standardized by guacamole-ext to the given TokenFilter and which do not require a corresponding Credentials object.
static void	addStandardTokens(TokenFilter filter, AuthenticatedUser user) Adds tokens which are standardized by guacamole-ext to the given TokenFilter using the values from the given AuthenticatedUser object, including any associated credentials.
static void	addStandardTokens(TokenFilter filter, Credentials credentials) Adds tokens which are standardized by guacamole-ext to the given TokenFilter using the values from the given Credentials object.

Methods inherited from class java.lang.Object

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

Field Detail

USERNAME_TOKEN

public static final String USERNAME_TOKEN

The name of the username token added via addStandardTokens().

See Also:

Constant Field Values

PASSWORD_TOKEN

public static final String PASSWORD_TOKEN

The name of the password token added via addStandardTokens().

See Also:

Constant Field Values

CLIENT_HOSTNAME_TOKEN

public static final String CLIENT_HOSTNAME_TOKEN

The name of the client hostname token added via addStandardTokens().

See Also:

Constant Field Values

CLIENT_ADDRESS_TOKEN

public static final String CLIENT_ADDRESS_TOKEN

The name of the client address token added via addStandardTokens().

See Also:

Constant Field Values

DATE_TOKEN

public static final String DATE_TOKEN

The name of the date token (server-local time) added via addStandardTokens().

See Also:

Constant Field Values

TIME_TOKEN

public static final String TIME_TOKEN

The name of the time token (server-local time) added via addStandardTokens().

See Also:

Constant Field Values

Method Detail

addStandardTokens

public static void addStandardTokens(TokenFilter filter)

Adds tokens which are standardized by guacamole-ext to the given TokenFilter and which do not require a corresponding Credentials object. These the server date and time (GUAC_DATE and GUAC_TIME respectively).

Parameters:

filter - The TokenFilter to add standard tokens to.

addStandardTokens

public static void addStandardTokens(TokenFilter filter,
                                     Credentials credentials)

Adds tokens which are standardized by guacamole-ext to the given TokenFilter using the values from the given Credentials object. These standardized tokens include the current username (GUAC_USERNAME), password (GUAC_PASSWORD), and the server date and time (GUAC_DATE and GUAC_TIME respectively). If either the username or password are not set within the given credentials, the corresponding token(s) will remain unset.

Parameters:

filter - The TokenFilter to add standard tokens to.

credentials - The Credentials to use when populating the GUAC_USERNAME and GUAC_PASSWORD tokens.

addStandardTokens

public static void addStandardTokens(TokenFilter filter,
                                     AuthenticatedUser user)

Adds tokens which are standardized by guacamole-ext to the given TokenFilter using the values from the given AuthenticatedUser object, including any associated credentials. These standardized tokens include the current username (GUAC_USERNAME), password (GUAC_PASSWORD), and the server date and time (GUAC_DATE and GUAC_TIME respectively). If either the username or password are not set within the given user or their provided credentials, the corresponding token(s) will remain unset.

Parameters:

filter - The TokenFilter to add standard tokens to.

user - The AuthenticatedUser to use when populating the GUAC_USERNAME and GUAC_PASSWORD tokens.