org.glyptodon.guacamole.net.auth

Interface Connection

All Known Implementing Classes:

AbstractConnection, SimpleConnection

public interface Connection

Represents a pairing of a GuacamoleConfiguration with a unique, human-readable identifier, and abstracts the connection process. The backing GuacamoleConfiguration may be intentionally obfuscated or tokenized to protect sensitive configuration information.

Author:

Michael Jumper

Method Summary

Methods

Modifier and Type	Method and Description
GuacamoleSocket	connect(GuacamoleClientInformation info) Establishes a connection to guacd using the GuacamoleConfiguration associated with this Connection, and returns the resulting, connected GuacamoleSocket.
GuacamoleConfiguration	getConfiguration() Returns the GuacamoleConfiguration associated with this Connection.
List<? extends ConnectionRecord>	getHistory() Returns a list of ConnectionRecords representing the usage history of this Connection, including any active users.
String	getIdentifier() Returns the unique identifier assigned to this Connection.
String	getName() Returns the name assigned to this Connection.
String	getParentIdentifier() Returns the unique identifier of the parent ConnectionGroup for this Connection.
void	setConfiguration(GuacamoleConfiguration config) Sets the GuacamoleConfiguration associated with this Connection.
void	setIdentifier(String identifier) Sets the identifier assigned to this Connection.
void	setName(String name) Sets the name assigned to this Connection.
void	setParentIdentifier(String parentIdentifier) Sets the unique identifier of the parent ConnectionGroup for this Connection.

Method Detail

getName

String getName()

Returns the name assigned to this Connection.

Returns:

The name assigned to this Connection.

setName

void setName(String name)

Sets the name assigned to this Connection.

Parameters:

name - The name to assign.

getIdentifier

String getIdentifier()

Returns the unique identifier assigned to this Connection. All connections must have a deterministic, unique identifier which may not be null.

Returns:

The unique identifier assigned to this Connection, which may not be null.

setIdentifier

void setIdentifier(String identifier)

Sets the identifier assigned to this Connection.

Parameters:

identifier - The identifier to assign.

getParentIdentifier

String getParentIdentifier()

Returns the unique identifier of the parent ConnectionGroup for this Connection.

Returns:

The unique identifier of the parent ConnectionGroup for this Connection.

setParentIdentifier

void setParentIdentifier(String parentIdentifier)

Sets the unique identifier of the parent ConnectionGroup for this Connection.

Parameters:

parentIdentifier - The unique identifier of the parent ConnectionGroup for this Connection.

getConfiguration

GuacamoleConfiguration getConfiguration()

Returns the GuacamoleConfiguration associated with this Connection. Note that because configurations may contain sensitive information, some data in this configuration may be omitted or tokenized.

Returns:

The GuacamoleConfiguration associated with this Connection.

setConfiguration

void setConfiguration(GuacamoleConfiguration config)

Sets the GuacamoleConfiguration associated with this Connection.

Parameters:

config - The GuacamoleConfiguration to associate with this Connection.

connect

GuacamoleSocket connect(GuacamoleClientInformation info)
                        throws GuacamoleException

Establishes a connection to guacd using the GuacamoleConfiguration associated with this Connection, and returns the resulting, connected GuacamoleSocket. The GuacamoleSocket will be pre-configured and will already have passed the handshake stage.

Parameters:

info - Information associated with the connecting client.

Returns:

A fully-established GuacamoleSocket.

Throws:

GuacamoleException - If an error occurs while connecting to guacd, or if permission to connect is denied.

getHistory

List<? extends ConnectionRecord> getHistory()
                                            throws GuacamoleException

Returns a list of ConnectionRecords representing the usage history of this Connection, including any active users. ConnectionRecords in this list will be sorted in descending order of end time (active connections are first), and then in descending order of start time (newer connections are first).

Returns:

A list of ConnectionRecrods representing the usage history of this Connection.

Throws:

GuacamoleException - If an error occurs while reading the history of this connection, or if permission is denied.