DelegatingConnection (guacamole-ext 1.0.0 API)

java.lang.Object
- org.apache.guacamole.net.auth.DelegatingConnection

All Implemented Interfaces:

Attributes, Connectable, Connection, Identifiable
```
public class DelegatingConnection
extends Object
implements Connection
```
Connection implementation which simply delegates all function calls to an underlying Connection.

Constructor Summary

Constructors
Constructor and Description
`DelegatingConnection(Connection connection)` Wraps the given Connection such that all function calls against this DelegatingConnection will be delegated to it.

Method Summary

All Methods Instance Methods Concrete Methods
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.
`org.apache.guacamole.protocol.GuacamoleConfiguration`	`getConfiguration()` Returns the GuacamoleConfiguration associated with this Connection.
`protected Connection`	`getDelegateConnection()` Returns the underlying Connection wrapped by this DelegatingConnection.
`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.
`Date`	`getLastActive()` Returns the date and time that this connection was last used.
`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`	`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
  - DelegatingConnection
```
public DelegatingConnection(Connection connection)
```
    Wraps the given Connection such that all function calls against this DelegatingConnection will be delegated to it.
    
    Parameters:
    
    connection - The Connection to wrap.
- Method Detail
  - getDelegateConnection
```
protected Connection getDelegateConnection()
```
    Returns the underlying Connection wrapped by this DelegatingConnection.
    
    Returns:
    
    The Connection wrapped by this DelegatingConnection.
  - 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.
  - 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.
  - 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.
  - getConfiguration
```
public org.apache.guacamole.protocol.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(org.apache.guacamole.protocol.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: Attributes
    
    Returns all attributes associated with this object. The returned map may not be modifiable.
    
    Specified by:
    
    getAttributes in interface Attributes
    
    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.
    
    Specified by:
    
    setAttributes in interface Attributes
    
    Parameters:
    
    attributes - A map of all attribute identifiers to their corresponding values.
  - 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.
    
    Specified by:
    
    getLastActive in interface Connection
    
    Returns:
    
    The date and time this connection was last used, or null if this information is unavailable or inapplicable.
  - getHistory
```
public List<? extends 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).
    
    Specified by:
    
    getHistory in interface Connection
    
    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
```
public Set<String> getSharingProfileIdentifiers()
                                         throws org.apache.guacamole.GuacamoleException
```
    Description copied from interface: Connection
    
    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.
    
    Specified by:
    
    getSharingProfileIdentifiers in interface Connection
    
    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.
  - 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.
    
    Specified by:
    
    connect in interface Connectable
    
    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.
  - 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.

Class DelegatingConnection

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DelegatingConnection

Method Detail

getDelegateConnection

getIdentifier

setIdentifier

getName

setName

getParentIdentifier

setParentIdentifier

getConfiguration

setConfiguration

getAttributes

setAttributes

getLastActive

getHistory

getSharingProfileIdentifiers

connect

getActiveConnections