org.apache.guacamole.net.auth

Interface Permissions

All Known Subinterfaces:

User, UserGroup

All Known Implementing Classes:

AbstractUser, AbstractUserGroup, DelegatingUser, DelegatingUserGroup, SimpleUser, SimpleUserGroup

public interface Permissions

An object which may be granted permissions to access/manipulate various other objects or aspects of the system. The permissions granted are exposed through subclasses of PermissionSet, and may be mutable depending on the access level of the current user.

Method Summary

Modifier and Type	Method and Description
ObjectPermissionSet	getActiveConnectionPermissions() Returns all permissions given to this object regarding currently-active connections.
ObjectPermissionSet	getConnectionGroupPermissions() Returns all connection group permissions given to this object.
ObjectPermissionSet	getConnectionPermissions() Returns all connection permissions given to this object.
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.
ObjectPermissionSet	getUserPermissions() Returns all user permissions given to this object.

Method Detail

getActiveConnectionPermissions

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

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

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.

getConnectionGroupPermissions

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

Returns all connection group permissions given to this object.

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.

getConnectionPermissions

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

Returns all connection permissions given to this object.

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.

getSharingProfilePermissions

ObjectPermissionSet getSharingProfilePermissions()
                                          throws org.apache.guacamole.GuacamoleException

Returns all sharing profile permissions given to this object.

Returns:

An ObjectPermissionSet of all sharing profile 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.

getSystemPermissions

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

Returns all system-level permissions given to this object.

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.

getUserPermissions

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

Returns all user permissions given to this object.

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

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

Returns all user group permissions given to this object.

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.