Package org.apache.guacamole.net.auth

Class AbstractConnection

java.lang.Object

org.apache.guacamole.net.auth.AbstractIdentifiable

org.apache.guacamole.net.auth.AbstractConnection

All Implemented Interfaces:

Attributes, Connectable, Connection, Identifiable, ReadableAttributes

Direct Known Subclasses:

SimpleConnection

public abstract class AbstractConnection
extends AbstractIdentifiable
implements Connection

Basic implementation of a Guacamole connection.

Constructor Summary

Constructors

Constructor	Description
AbstractConnection()

Method Summary

Modifier and Type	Method	Description
org.apache.guacamole.protocol.GuacamoleConfiguration	getConfiguration()	Returns the GuacamoleConfiguration associated with this Connection.
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	setConfiguration(org.apache.guacamole.protocol.GuacamoleConfiguration configuration)	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 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.Attributes

setAttributes

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

connect, connect, getActiveConnections

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

getConnectionHistory, getHistory, getLastActive

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

getIdentifier, setIdentifier

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

getAttributes

Constructor Detail

AbstractConnection

public AbstractConnection()

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.

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

Description copied from interface: Connection

Sets the GuacamoleConfiguration associated with this Connection.

Specified by:

setConfiguration in interface Connection

Parameters:

configuration - The GuacamoleConfiguration to associate with this Connection.

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.