Package org.apache.guacamole.net.auth

Class DelegatingSharingProfile

java.lang.Object
org.apache.guacamole.net.auth.DelegatingSharingProfile
All Implemented Interfaces:
Attributes, Identifiable, Nameable, ReadableAttributes, SharingProfile
public class DelegatingSharingProfile extends Object implements SharingProfile
SharingProfile implementation which simply delegates all function calls to an underlying SharingProfile.

  • Constructor Details

    • DelegatingSharingProfile

      public DelegatingSharingProfile(SharingProfile sharingProfile)
      Wraps the given SharingProfile such that all function calls against this DelegatingSharingProfile will be delegated to it.
      Parameters:
      sharingProfile - The SharingProfile to wrap.

  • Method Details

    • getDelegateSharingProfile

      protected SharingProfile getDelegateSharingProfile()
      Returns the underlying SharingProfile wrapped by this DelegatingSharingProfile.
      Returns:
      The SharingProfile wrapped by this DelegatingSharingProfile.

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

    • 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 identifier)
      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:
      identifier - 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.

    • getAttributes

      public Map<String,String> getAttributes()
      Description copied from interface: ReadableAttributes
      Returns all attributes associated with this object. The returned map may not be modifiable.
      Specified by:
      getAttributes in interface ReadableAttributes
      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.