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, Nameable, ReadableAttributes
Direct Known Subclasses:
SimpleConnection
public abstract class AbstractConnection extends AbstractIdentifiable implements Connection
Basic implementation of a Guacamole connection.

  • Constructor Details

    • AbstractConnection

      public AbstractConnection()

  • Method Details

    • getName

      public String getName()
      Description copied from interface: Nameable
      Returns the human-readable name assigned to this object.
      Specified by:
      getName in interface Nameable
      Returns:
      The name assigned to this object.

    • setName

      public void setName(String name)
      Description copied from interface: Nameable
      Sets the human-readable name assigned to this object.
      Specified by:
      setName in interface Nameable
      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.