org.apache.guacamole.net.auth.simple

Class SimpleConnection

java.lang.Object

org.apache.guacamole.net.auth.AbstractIdentifiable

org.apache.guacamole.net.auth.AbstractConnection

org.apache.guacamole.net.auth.simple.SimpleConnection

All Implemented Interfaces:

Attributes, Connectable, Connection, Identifiable

public class SimpleConnection
extends AbstractConnection

An extremely basic Connection implementation.

Constructor Summary

Constructors

Constructor and Description
SimpleConnection() Creates a completely uninitialized SimpleConnection.
SimpleConnection(String name, String identifier, org.apache.guacamole.protocol.GuacamoleConfiguration config) Creates a new SimpleConnection having the given identifier and GuacamoleConfiguration.

Method Summary

Modifier and Type	Method and Description
org.apache.guacamole.net.GuacamoleTunnel	connect(org.apache.guacamole.protocol.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 object.
List<ConnectionRecord>	getHistory() Returns a list of ConnectionRecords representing the usage history of this Connection, including any active users.
Date	getLastActive() Returns the date and time that this connection was last used.
void	setAttributes(Map<String,String> attributes) Sets the given attributes.

Methods inherited from class org.apache.guacamole.net.auth.AbstractConnection

getConfiguration, getName, getParentIdentifier, getSharingProfileIdentifiers, setConfiguration, setName, setParentIdentifier

Methods inherited from class org.apache.guacamole.net.auth.AbstractIdentifiable

equals, getIdentifier, hashCode, setIdentifier

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.guacamole.net.auth.Identifiable

getIdentifier, setIdentifier

Constructor Detail

SimpleConnection

public SimpleConnection()

Creates a completely uninitialized SimpleConnection.

SimpleConnection

public SimpleConnection(String name,
                        String identifier,
                        org.apache.guacamole.protocol.GuacamoleConfiguration config)

Creates a new SimpleConnection having the given identifier and GuacamoleConfiguration.

Parameters:

name - The name to associate with this connection.

identifier - The identifier to associate with this connection.

config - The configuration describing how to connect to this connection.

Method Detail

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.

Returns:

The number of active connections associated with this object.

getAttributes

public Map<String,String> getAttributes()

Description copied from interface: Attributes

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

Returns:

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

setAttributes

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

Description copied from interface: Attributes

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. Attributes which are not declared within the associated UserContext MUST NOT be submitted, but other extensions may manipulate the declared attributes through decorate() and redecorate(). Implementations may optionally allow storage of unsupported attributes. Extensions which rely on other extensions to store their attribute values should verify that such storage is supported by first testing that the attribute value is retrievable via getAttributes() after being set.

Parameters:

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

connect

public org.apache.guacamole.net.GuacamoleTunnel connect(org.apache.guacamole.protocol.GuacamoleClientInformation info)
                                                 throws org.apache.guacamole.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.

Parameters:

info - Information associated with the connecting client.

Returns:

A fully-established GuacamoleTunnel.

Throws:

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

getLastActive

public Date getLastActive()

Description copied from interface: Connection

Returns the date and time that this connection was last used. If the connection was never used, the time that the connection was last used is unknown, or this information is not visible to the current user, this may be null.

Returns:

The date and time this connection was last used, or null if this information is unavailable or inapplicable.

getHistory

public List<ConnectionRecord> getHistory()
                                  throws org.apache.guacamole.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).

Returns:

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

Throws:

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