org.glyptodon.guacamole.net.basic.rest.user

Class APIUserWrapper

java.lang.Object

org.glyptodon.guacamole.net.basic.rest.user.APIUserWrapper

All Implemented Interfaces:

Identifiable, User

public class APIUserWrapper
extends Object
implements User

A wrapper to make an APIUser look like a User. Useful where an org.glyptodon.guacamole.net.auth.User is required. As a simple wrapper for APIUser, access to permissions is not provided. Any attempt to access or manipulate permissions on an APIUserWrapper will result in an exception.

Author:

James Muehlner

Constructor Summary

Constructors

Constructor and Description
APIUserWrapper(APIUser apiUser) Wrap a given APIUser to expose as a User.

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	getIdentifier() Returns the unique identifier assigned to this object.
String	getPassword() Returns this user's password.
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	setIdentifier(String username) Sets the identifier assigned to this object.
void	setPassword(String password) Sets this user's password.

Methods inherited from class java.lang.Object

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

Constructor Detail

APIUserWrapper

public APIUserWrapper(APIUser apiUser)

Wrap a given APIUser to expose as a User.

Parameters:

apiUser - The APIUser to wrap.

Method Detail

getIdentifier

public String getIdentifier()

Description copied from interface: Identifiable

Returns the unique identifier assigned to this object. All identifiable objects must have a deterministic, unique identifier which may not be null.

Specified by:

getIdentifier in interface Identifiable

Returns:

The unique identifier assigned to this object, which may not be null.

setIdentifier

public void setIdentifier(String username)

Description copied from interface: Identifiable

Sets the identifier assigned to this object.

Specified by:

setIdentifier in interface Identifiable

Parameters:

username - The identifier to assign.

getPassword

public String getPassword()

Description copied from interface: User

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

Specified by:

getPassword in interface User

Returns:

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

setPassword

public void setPassword(String password)

Description copied from interface: User

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().

Specified by:

setPassword in interface User

Parameters:

password - The password to set.

getAttributes

public Map<String,String> getAttributes()

Description copied from interface: User

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

Specified by:

getAttributes in interface User

Returns:

A map of all attribute identifiers to their corresponding values, for all attributes associated with this user, which may not be modifiable.

setAttributes

public void setAttributes(Map<String,String> attributes)

Description copied from interface: User

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.

Specified by:

setAttributes in interface User

Parameters:

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

getSystemPermissions

public SystemPermissionSet getSystemPermissions()
                                         throws GuacamoleException

Description copied from interface: User

Returns all system-level permissions given to this user.

Specified by:

getSystemPermissions in interface User

Returns:

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

Throws:

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

getConnectionPermissions

public ObjectPermissionSet getConnectionPermissions()
                                             throws GuacamoleException

Description copied from interface: User

Returns all connection permissions given to this user.

Specified by:

getConnectionPermissions in interface User

Returns:

An ObjectPermissionSet of all connection permissions granted to this user.

Throws:

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

getConnectionGroupPermissions

public ObjectPermissionSet getConnectionGroupPermissions()
                                                  throws GuacamoleException

Description copied from interface: User

Returns all connection group permissions given to this user.

Specified by:

getConnectionGroupPermissions in interface User

Returns:

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

Throws:

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

getUserPermissions

public ObjectPermissionSet getUserPermissions()
                                       throws GuacamoleException

Description copied from interface: User

Returns all user permissions given to this user.

Specified by:

getUserPermissions in interface User

Returns:

An ObjectPermissionSet of all user permissions granted to this user.

Throws:

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

getActiveConnectionPermissions

public ObjectPermissionSet getActiveConnectionPermissions()
                                                   throws GuacamoleException

Description copied from interface: User

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

Specified by:

getActiveConnectionPermissions in interface User

Returns:

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

Throws:

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