org.glyptodon.guacamole.net.basic.rest.connection

Class APIConnectionWrapper

java.lang.Object

org.glyptodon.guacamole.net.basic.rest.connection.APIConnectionWrapper

All Implemented Interfaces:

Connectable, Connection, Identifiable

public class APIConnectionWrapper
extends Object
implements Connection

A wrapper to make an APIConnection look like a Connection. Useful where a org.glyptodon.guacamole.net.auth.Connection is required.

Author:

James Muehlner

Constructor Summary

Constructors

Constructor and Description
APIConnectionWrapper(APIConnection apiConnection) Creates a new APIConnectionWrapper which wraps the given APIConnection as a Connection.

Method Summary

Modifier and Type	Method and Description
GuacamoleTunnel	connect(GuacamoleClientInformation info) Establishes a connection to guacd using the information associated with this object.
int	getActiveConnections() Returns the number of active connections associated with this object.
Map<String,String>	getAttributes() Returns all attributes associated with this connection.
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 object.
String	getName() Returns the name assigned to this Connection.
String	getParentIdentifier() Returns the unique identifier of the parent ConnectionGroup for this Connection.
void	setAttributes(Map<String,String> attributes) Sets the given attributes.
void	setConfiguration(GuacamoleConfiguration config) Sets the GuacamoleConfiguration associated with this Connection.
void	setIdentifier(String identifier) Sets the identifier assigned to this object.
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.

Methods inherited from class java.lang.Object

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

Constructor Detail

APIConnectionWrapper

public APIConnectionWrapper(APIConnection apiConnection)

Creates a new APIConnectionWrapper which wraps the given APIConnection as a Connection.

Parameters:

apiConnection - The APIConnection to wrap.

Method Detail

getName

public String getName()

Description copied from interface: Connection

Returns the name assigned to this Connection.

Specified by:

getName in interface Connection

Returns:

The name assigned to this Connection.

setName

public void setName(String name)

Description copied from interface: Connection

Sets the name assigned to this Connection.

Specified by:

setName in interface Connection

Parameters:

name - The name to assign.

getIdentifier

public String getIdentifier()

Description copied from interface: Identifiable

Returns the unique identifier assigned to this object. All identifiable objects must have a deterministic, unique identifier which may not be null.

Specified by:

getIdentifier in interface Identifiable

Returns:

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

setIdentifier

public void setIdentifier(String identifier)

Description copied from interface: Identifiable

Sets the identifier assigned to this object.

Specified by:

setIdentifier in interface Identifiable

Parameters:

identifier - The identifier to assign.

getParentIdentifier

public String getParentIdentifier()

Description copied from interface: Connection

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

Specified by:

getParentIdentifier in interface Connection

Returns:

The unique identifier of the parent ConnectionGroup for this Connection.

setParentIdentifier

public void setParentIdentifier(String parentIdentifier)

Description copied from interface: Connection

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

Specified by:

setParentIdentifier in interface Connection

Parameters:

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

getActiveConnections

public int getActiveConnections()

Description copied from interface: Connectable

Returns the number of active connections associated with this object. Implementations may simply return 0 if this value is not tracked.

Specified by:

getActiveConnections in interface Connectable

Returns:

The number of active connections associated with this object.

getConfiguration

public GuacamoleConfiguration getConfiguration()

Description copied from interface: Connection

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.

Specified by:

getConfiguration in interface Connection

Returns:

The GuacamoleConfiguration associated with this Connection.

setConfiguration

public void setConfiguration(GuacamoleConfiguration config)

Description copied from interface: Connection

Sets the GuacamoleConfiguration associated with this Connection.

Specified by:

setConfiguration in interface Connection

Parameters:

config - The GuacamoleConfiguration to associate with this Connection.

getAttributes

public Map<String,String> getAttributes()

Description copied from interface: Connection

Returns all attributes associated with this connection. The returned map may not be modifiable.

Specified by:

getAttributes in interface Connection

Returns:

A map of all attribute identifiers to their corresponding values, for all attributes associated with this connection, which may not be modifiable.

setAttributes

public void setAttributes(Map<String,String> attributes)

Description copied from interface: Connection

Sets the given attributes. If an attribute within the map is not supported, it will simply be dropped. Any attributes not within the given map will be left untouched.

Specified by:

setAttributes in interface Connection

Parameters:

attributes - A map of all attribute identifiers to their corresponding values.

connect

public GuacamoleTunnel connect(GuacamoleClientInformation info)
                        throws GuacamoleException

Description copied from interface: Connectable

Establishes a connection to guacd using the information associated with this object. The connection will be provided the given client information.

Specified by:

connect in interface Connectable

Parameters:

info - Information associated with the connecting client.

Returns:

A fully-established GuacamoleTunnel.

Throws:

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

getHistory

public List<? extends ConnectionRecord> getHistory()
                                            throws GuacamoleException

Description copied from interface: Connection

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).

Specified by:

getHistory in interface Connection

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.