Package org.apache.guacamole.net.auth

Interface UserGroup

All Superinterfaces:

Attributes, Identifiable, Permissions, ReadableAttributes

All Known Implementing Classes:

AbstractUserGroup, DelegatingUserGroup, SimpleUserGroup

public interface UserGroup
extends Identifiable, Attributes, Permissions

A user group of the Guacamole web application. Each user group may contain any number of Guacamole users and other user groups, and defines the permissions implicitly granted to its members.

Method Summary

Modifier and Type	Method	Description
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.
RelatedObjectSet	getUserGroups()	Returns a set of all readable user groups of which this user group is a member.

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

setAttributes

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

getIdentifier, setIdentifier

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

getActiveConnectionPermissions, getConnectionGroupPermissions, getConnectionPermissions, getSharingProfilePermissions, getSystemPermissions, getUserGroupPermissions, getUserPermissions

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

getAttributes

Method Detail

getUserGroups

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.

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

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.

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

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.

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.