org.apache.guacamole.net.auth

Interface SharingProfile

All Superinterfaces:

Identifiable

All Known Implementing Classes:

AbstractSharingProfile

public interface SharingProfile
extends Identifiable

Represents the semantics which apply to an existing connection when shared, along with a human-readable name and unique identifier.

Author:

Michael Jumper

Method Summary

Modifier and Type	Method and Description
Map<String,String>	getAttributes() Returns all attributes associated with this sharing profile.
String	getName() Returns the human-readable name assigned to this SharingProfile.
Map<String,String>	getParameters() Returns a map which contains connection parameter name/value pairs as key/value pairs.
String	getPrimaryConnectionIdentifier() Returns the identifier of the primary connection associated with this connection.
void	setAttributes(Map<String,String> attributes) Sets the given attributes.
void	setName(String name) Sets the human-readable name assigned to this SharingProfile.
void	setParameters(Map<String,String> parameters) Replaces all current parameters with the parameters defined within the given map.
void	setPrimaryConnectionIdentifier(String identifier) Sets the identifier of the primary connection associated with this connection.

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

getIdentifier, setIdentifier

Method Detail

getName

String getName()

Returns the human-readable name assigned to this SharingProfile.

Returns:

The name assigned to this SharingProfile.

setName

void setName(String name)

Sets the human-readable name assigned to this SharingProfile.

Parameters:

name - The name to assign.

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.

getAttributes

Map<String,String> getAttributes()

Returns all attributes associated with this sharing profile. The returned map may not be modifiable.

Returns:

A map of all attribute identifiers to their corresponding values, for all attributes associated with this sharing profile, which may not be modifiable.

setAttributes

void setAttributes(Map<String,String> 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.

Parameters:

attributes - A map of all attribute identifiers to their corresponding values.