org.apache.guacamole.net.auth

Class AbstractUserGroup

java.lang.Object

org.apache.guacamole.net.auth.AbstractIdentifiable

org.apache.guacamole.net.auth.AbstractUserGroup

All Implemented Interfaces:

Attributes, Identifiable, Permissions, UserGroup

Direct Known Subclasses:

SimpleUserGroup

public class AbstractUserGroup
extends AbstractIdentifiable
implements UserGroup

Base implementation of UserGroup which provides default implementations of most functions.

Constructor Summary

Constructors

Constructor and Description
AbstractUserGroup()

Method Summary

Modifier and Type	Method and Description
ObjectPermissionSet	getActiveConnectionPermissions() Returns all permissions given to this object regarding currently-active connections.
Map<String,String>	getAttributes() Returns all attributes associated with this object.
ObjectPermissionSet	getConnectionGroupPermissions() Returns all connection group permissions given to this object.
ObjectPermissionSet	getConnectionPermissions() Returns all connection permissions given to this object.
RelatedObjectSet	getMemberUserGroups() Returns a set of all readable user groups that are members of this user group.
RelatedObjectSet	getMemberUsers() Returns a set of all readable users that are members of this user group.
ObjectPermissionSet	getSharingProfilePermissions() Returns all sharing profile permissions given to this object.
SystemPermissionSet	getSystemPermissions() Returns all system-level permissions given to this object.
ObjectPermissionSet	getUserGroupPermissions() Returns all user group permissions given to this object.
RelatedObjectSet	getUserGroups() Returns a set of all readable user groups of which this user group is a member.
ObjectPermissionSet	getUserPermissions() Returns all user permissions given to this object.
void	setAttributes(Map<String,String> attributes) Sets the given attributes.

Methods inherited from class org.apache.guacamole.net.auth.AbstractIdentifiable

equals, getIdentifier, hashCode, setIdentifier

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

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

getIdentifier, setIdentifier

Constructor Detail

AbstractUserGroup

public AbstractUserGroup()

Method Detail

getAttributes

public Map<String,String> getAttributes()

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

This implementation simply an immutable, empty map. Implementations that wish to expose custom attributes should override this function.

Specified by:

getAttributes in interface Attributes

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)

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.

This implementation simply ignores all attributes given. Implementations that wish to support modification of custom attributes should override this function.

Specified by:

setAttributes in interface Attributes

Parameters:

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

getSystemPermissions

public SystemPermissionSet getSystemPermissions()
                                         throws org.apache.guacamole.GuacamoleException

Returns all system-level permissions given to this object.

This implementation simply an immutable, empty permission set. Implementations that wish to expose permissions should override this function.

Specified by:

getSystemPermissions in interface Permissions

Returns:

A SystemPermissionSet of all system-level permissions granted to this object.

Throws:

org.apache.guacamole.GuacamoleException - If an error occurs while retrieving permissions, or if reading all permissions is not allowed.

getConnectionPermissions

public ObjectPermissionSet getConnectionPermissions()
                                             throws org.apache.guacamole.GuacamoleException

Returns all connection permissions given to this object.

This implementation simply an immutable, empty permission set. Implementations that wish to expose permissions should override this function.

Specified by:

getConnectionPermissions in interface Permissions

Returns:

An ObjectPermissionSet of all connection permissions granted to this object.

Throws:

org.apache.guacamole.GuacamoleException - If an error occurs while retrieving permissions, or if reading all permissions is not allowed.

getConnectionGroupPermissions

public ObjectPermissionSet getConnectionGroupPermissions()
                                                  throws org.apache.guacamole.GuacamoleException

Returns all connection group permissions given to this object.

This implementation simply an immutable, empty permission set. Implementations that wish to expose permissions should override this function.

Specified by:

getConnectionGroupPermissions in interface Permissions

Returns:

An ObjectPermissionSet of all connection group permissions granted to this object.

Throws:

org.apache.guacamole.GuacamoleException - If an error occurs while retrieving permissions, or if reading all permissions is not allowed.

getUserPermissions

public ObjectPermissionSet getUserPermissions()
                                       throws org.apache.guacamole.GuacamoleException

Returns all user permissions given to this object.

This implementation simply an immutable, empty permission set. Implementations that wish to expose permissions should override this function.

Specified by:

getUserPermissions in interface Permissions

Returns:

An ObjectPermissionSet of all user permissions granted to this object.

Throws:

org.apache.guacamole.GuacamoleException - If an error occurs while retrieving permissions, or if reading all permissions is not allowed.

getUserGroupPermissions

public ObjectPermissionSet getUserGroupPermissions()
                                            throws org.apache.guacamole.GuacamoleException

Returns all user group permissions given to this object.

This implementation simply an immutable, empty permission set. Implementations that wish to expose permissions should override this function.

Specified by:

getUserGroupPermissions in interface Permissions

Returns:

An ObjectPermissionSet of all user group permissions granted to this object.

Throws:

org.apache.guacamole.GuacamoleException - If an error occurs while retrieving permissions, or if reading all permissions is not allowed.

getActiveConnectionPermissions

public ObjectPermissionSet getActiveConnectionPermissions()
                                                   throws org.apache.guacamole.GuacamoleException

Returns all permissions given to this object regarding currently-active connections.

This implementation simply an immutable, empty permission set. Implementations that wish to expose permissions should override this function.

Specified by:

getActiveConnectionPermissions in interface Permissions

Returns:

An ObjectPermissionSet of all active connection permissions granted to this object.

Throws:

org.apache.guacamole.GuacamoleException - If an error occurs while retrieving permissions, or if reading all permissions is not allowed.

getSharingProfilePermissions

public ObjectPermissionSet getSharingProfilePermissions()

Returns all sharing profile permissions given to this object.

This implementation simply an immutable, empty permission set. Implementations that wish to expose permissions should override this function.

Specified by:

getSharingProfilePermissions in interface Permissions

Returns:

An ObjectPermissionSet of all sharing profile permissions granted to this object.

getUserGroups

public RelatedObjectSet getUserGroups()
                               throws org.apache.guacamole.GuacamoleException

Returns a set of all readable user groups of which this user group is a member. If permission is granted for the current user to modify the membership of this user group, then the returned set will be mutable, and any such modifications should be made through changes to the returned set.

This implementation simply an immutable, empty related object set. Implementations that wish to expose group membership should override this function.

Specified by:

getUserGroups in interface UserGroup

Returns:

The set of all readable user groups of which this user group is a member.

Throws:

org.apache.guacamole.GuacamoleException - If an error occurs while retrieving the user groups.

getMemberUsers

public RelatedObjectSet getMemberUsers()
                                throws org.apache.guacamole.GuacamoleException

Returns a set of all readable users that are members of this user group. If permission is granted for the current user to modify the members of this group, then the returned set will be mutable, and any such modifications should be made through changes to the returned set.

This implementation simply an immutable, empty related object set. Implementations that wish to expose group membership should override this function.

Specified by:

getMemberUsers in interface UserGroup

Returns:

The set all readable users that are members of this user group, which may be mutable.

Throws:

org.apache.guacamole.GuacamoleException - If an error occurs while retrieving the users.

getMemberUserGroups

public RelatedObjectSet getMemberUserGroups()
                                     throws org.apache.guacamole.GuacamoleException

Returns a set of all readable user groups that are members of this user group. If permission is granted for the current user to modify the members of this group, then the returned set will be mutable, and any such modifications should be made through changes to the returned set.

This implementation simply an immutable, empty related object set. Implementations that wish to expose group membership should override this function.

Specified by:

getMemberUserGroups in interface UserGroup

Returns:

The set of all readable user groups that are members of this user group, which may be mutable.

Throws:

org.apache.guacamole.GuacamoleException - If an error occurs while retrieving the user groups.