org.apache.guacamole.net.auth

Interface Attributes

All Known Subinterfaces:

Connection, ConnectionGroup, SharingProfile, User, UserGroup

All Known Implementing Classes:

AbstractConnection, AbstractConnectionGroup, AbstractSharingProfile, AbstractUser, AbstractUserGroup, DelegatingConnection, DelegatingConnectionGroup, DelegatingSharingProfile, DelegatingUser, DelegatingUserGroup, SimpleConnection, SimpleConnectionGroup, SimpleUser, SimpleUserGroup, TokenInjectingConnection, TokenInjectingConnectionGroup

public interface Attributes

An object which is associated with a set of arbitrary attributes, defined as name/value pairs.

Method Summary

Modifier and Type	Method and Description
Map<String,String>	getAttributes() Returns all attributes associated with this object.
void	setAttributes(Map<String,String> attributes) Sets the given attributes.

Method Detail

getAttributes

Map<String,String> getAttributes()

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

Returns:

A map of all attribute identifiers to their corresponding values, for all attributes associated with this object, 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. 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.

Parameters:

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