org.glyptodon.guacamole.net.auth

Interface User

All Known Implementing Classes:

AbstractUser, SimpleUser

public interface User

A user of the Guacamole web application.

Author:

Michael Jumper

Method Summary

Methods

Modifier and Type	Method and Description
void	addPermission(Permission permission) Adds the specified permission to this user.
String	getPassword() Returns this user's password.
Set<Permission>	getPermissions() Lists all permissions given to this user.
String	getUsername() Returns the name of this user, which must be unique across all users.
boolean	hasPermission(Permission permission) Tests whether this user has the specified permission.
void	removePermission(Permission permission) Removes the specified permission from this specified user.
void	setPassword(String password) Sets this user's password.
void	setUsername(String username) Sets the name of this user, which must be unique across all users.

Method Detail

getUsername

String getUsername()

Returns the name of this user, which must be unique across all users.

Returns:

The name of this user.

setUsername

void setUsername(String username)

Sets the name of this user, which must be unique across all users.

Parameters:

username - The name of this user.

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.

getPermissions

Set<Permission> getPermissions()
                               throws org.glyptodon.guacamole.GuacamoleException

Lists all permissions given to this user.

Returns:

A Set of all permissions granted to this user.

Throws:

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

hasPermission

boolean hasPermission(Permission permission)
                      throws org.glyptodon.guacamole.GuacamoleException

Tests whether this user has the specified permission.

Parameters:

permission - The permission to check.

Returns:

true if the permission is granted to this user, false otherwise.

Throws:

org.glyptodon.guacamole.GuacamoleException - If an error occurs while checking permissions, or if permissions cannot be checked due to lack of permissions to do so.

addPermission

void addPermission(Permission permission)
                   throws org.glyptodon.guacamole.GuacamoleException

Adds the specified permission to this user.

Parameters:

permission - The permission to add.

Throws:

org.glyptodon.guacamole.GuacamoleException - If an error occurs while adding the permission. or if permission to add permissions is denied.

removePermission

void removePermission(Permission permission)
                      throws org.glyptodon.guacamole.GuacamoleException

Removes the specified permission from this specified user.

Parameters:

permission - The permission to remove.

Throws:

org.glyptodon.guacamole.GuacamoleException - If an error occurs while removing the permission. or if permission to remove permissions is denied.