Package org.apache.guacamole.net.auth

Interface SharingProfile

All Superinterfaces:
Attributes, Identifiable, Nameable, ReadableAttributes
All Known Implementing Classes:
AbstractSharingProfile, DelegatingSharingProfile
public interface SharingProfile extends Identifiable, Attributes, Nameable
Represents the semantics which apply to an existing connection when shared, along with a human-readable name and unique identifier.

  • Method Details

    • getPrimaryConnectionIdentifier

      String getPrimaryConnectionIdentifier()
      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.
      Returns:
      The identifier of the primary connection associated with this connection.

    • setPrimaryConnectionIdentifier

      void setPrimaryConnectionIdentifier(String identifier)
      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.
      Parameters:
      identifier - The identifier of the primary connection associated with this connection.

    • getParameters

      Map<String,String> getParameters()
      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.
      Returns:
      A map which contains all connection parameter name/value pairs as key/value pairs.

    • setParameters

      void setParameters(Map<String,String> parameters)
      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.
      Parameters:
      parameters - A map which contains all connection parameter name/value pairs as key/value pairs.