org.apache.guacamole.net.auth

Interface Connection

All Superinterfaces:

Connectable, Identifiable

All Known Implementing Classes:

AbstractConnection, SimpleConnection

public interface Connection
extends Identifiable, Connectable

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.

Method Summary

Modifier and Type	Method and Description
Map<String,String>	getAttributes() Returns all attributes associated with this connection.
org.apache.guacamole.protocol.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	getName() Returns the name assigned to this Connection.
String	getParentIdentifier() Returns the unique identifier of the parent ConnectionGroup for this Connection.
Set<String>	getSharingProfileIdentifiers() Returns identifiers of all readable sharing profiles that can be used to join this connection when it is active.
void	setAttributes(Map<String,String> attributes) Sets the given attributes.
void	setConfiguration(org.apache.guacamole.protocol.GuacamoleConfiguration config) Sets the GuacamoleConfiguration associated with 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.

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

getIdentifier, setIdentifier

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

connect, getActiveConnections

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.

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

org.apache.guacamole.protocol.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(org.apache.guacamole.protocol.GuacamoleConfiguration config)

Sets the GuacamoleConfiguration associated with this Connection.

Parameters:

config - The GuacamoleConfiguration to associate with this Connection.

getAttributes

Map<String,String> getAttributes()

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

Returns:

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

setAttributes

void setAttributes(Map<String,String> 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.

Parameters:

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

getHistory

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

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

getSharingProfileIdentifiers

Set<String> getSharingProfileIdentifiers()
                                  throws org.apache.guacamole.GuacamoleException

Returns identifiers of all readable sharing profiles that can be used to join this connection when it is active. The level of access granted to a joining user is dictated by the connection parameters associated with the sharing profile, not necessarily the parameters of the primary connection being joined.

Returns:

A Set of identifiers representing the sharing profiles for this connection.

Throws:

org.apache.guacamole.GuacamoleException - If an error occurs while fetching the sharing profiles for this connection.