Package org.apache.guacamole.net.auth

Class AbstractSharingProfile

java.lang.Object
org.apache.guacamole.net.auth.AbstractSharingProfile
All Implemented Interfaces:
Attributes, Identifiable, Nameable, ReadableAttributes, SharingProfile
public abstract class AbstractSharingProfile extends Object implements SharingProfile
Base implementation of a sharing profile which can be used to share a Guacamole connection.

  • Constructor Details

    • AbstractSharingProfile

      public AbstractSharingProfile()

  • 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.

    • 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.

    • getPrimaryConnectionIdentifier

      public String getPrimaryConnectionIdentifier()
      Description copied from interface: SharingProfile
      Returns the identifier of the primary connection associated with this connection. The primary connection is the connection that this sharing profile can be used to share.
      Specified by:
      getPrimaryConnectionIdentifier in interface SharingProfile
      Returns:
      The identifier of the primary connection associated with this connection.

    • setPrimaryConnectionIdentifier

      public void setPrimaryConnectionIdentifier(String primaryConnectionIdentifier)
      Description copied from interface: SharingProfile
      Sets the identifier of the primary connection associated with this connection. The primary connection is the connection that this sharing profile can be used to share.
      Specified by:
      setPrimaryConnectionIdentifier in interface SharingProfile
      Parameters:
      primaryConnectionIdentifier - The identifier of the primary connection associated with this connection.

    • getParameters

      public Map<String,String> getParameters()
      Description copied from interface: SharingProfile
      Returns a map which contains connection parameter name/value pairs as key/value pairs. Changes to this map will affect the parameters stored within this sharing profile. The differences in these parameters compared to those of the associated primary connection yield different levels of access to users joining the primary connection via this sharing profile. Note that because configurations may contain sensitive information, some data in this map may be omitted or tokenized.
      Specified by:
      getParameters in interface SharingProfile
      Returns:
      A map which contains all connection parameter name/value pairs as key/value pairs.

    • setParameters

      public void setParameters(Map<String,String> parameters)
      Description copied from interface: SharingProfile
      Replaces all current parameters with the parameters defined within the given map. Key/value pairs within the map represent parameter name/value pairs. The differences in these parameters compared to those of the associated primary connection yield different levels of access to users joining the primary connection via this sharing profile.
      Specified by:
      setParameters in interface SharingProfile
      Parameters:
      parameters - A map which contains all connection parameter name/value pairs as key/value pairs.

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object