org.apache.guacamole.net.auth

Interface User

All Superinterfaces:

Identifiable

All Known Implementing Classes:

AbstractUser, SimpleUser

public interface User
extends Identifiable

A user of the Guacamole web application.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	User.Attribute All standard attribute names with semantics defined by the Guacamole web application.

Method Summary

Modifier and Type	Method and Description
ObjectPermissionSet	getActiveConnectionPermissions() Returns all permissions given to this user regarding currently-active connections.
Map<String,String>	getAttributes() Returns all attributes associated with this user.
ObjectPermissionSet	getConnectionGroupPermissions() Returns all connection group permissions given to this user.
ObjectPermissionSet	getConnectionPermissions() Returns all connection permissions given to this user.
String	getPassword() Returns this user's password.
ObjectPermissionSet	getSharingProfilePermissions() Returns all sharing profile permissions given to this user.
SystemPermissionSet	getSystemPermissions() Returns all system-level permissions given to this user.
ObjectPermissionSet	getUserPermissions() Returns all user permissions given to this user.
void	setAttributes(Map<String,String> attributes) Sets the given attributes.
void	setPassword(String password) Sets this user's password.

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

getIdentifier, setIdentifier

Method Detail

getPassword

String getPassword()

Returns this user's password. Note that the password returned may be hashed or completely arbitrary.

Returns:

A String which may (or may not) be the user's password.

setPassword

void setPassword(String password)

Sets this user's password. Note that while this function is guaranteed to change the password of this User object, there is no guarantee that getPassword() will return the value given to setPassword().

Parameters:

password - The password to set.

getAttributes

Map<String,String> getAttributes()

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

Returns:

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

getSystemPermissions

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

Returns all system-level permissions given to this user.

Returns:

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

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 user.

Returns:

An ObjectPermissionSet of all connection permissions granted to this user.

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 user.

Returns:

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

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 user.

Returns:

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

Throws:

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

getActiveConnectionPermissions

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

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

Returns:

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

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 user.

Returns:

An ObjectPermissionSet of all user permissions granted to this user.

Throws:

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