org.apache.guacamole.net.auth.simple

Class SimpleUser

java.lang.Object

org.apache.guacamole.net.auth.AbstractIdentifiable

org.apache.guacamole.net.auth.AbstractUser

org.apache.guacamole.net.auth.simple.SimpleUser

All Implemented Interfaces:

Identifiable, User

public class SimpleUser
extends AbstractUser

An extremely basic User implementation.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.guacamole.net.auth.User

User.Attribute

Constructor Summary

Constructors

Constructor and Description
SimpleUser() Creates a completely uninitialized SimpleUser.
SimpleUser(String username) Creates a new SimpleUser having the given username and no permissions.
SimpleUser(String username, Collection<String> connectionIdentifiers, Collection<String> connectionGroupIdentifiers) Creates a new SimpleUser having the given username and READ access to the connections and groups having the given identifiers.
SimpleUser(String username, Collection<String> userIdentifiers, Collection<String> connectionIdentifiers, Collection<String> connectionGroupIdentifiers) Creates a new SimpleUser having the given username and READ access to the users, connections, and groups having the given identifiers.

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

Methods inherited from class org.apache.guacamole.net.auth.AbstractUser

getPassword, setPassword

Methods inherited from class org.apache.guacamole.net.auth.AbstractIdentifiable

equals, getIdentifier, hashCode, setIdentifier

Methods inherited from class java.lang.Object

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

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

getIdentifier, setIdentifier

Constructor Detail

SimpleUser

public SimpleUser()

Creates a completely uninitialized SimpleUser.

SimpleUser

public SimpleUser(String username)

Creates a new SimpleUser having the given username and no permissions.

Parameters:

username - The username to assign to this SimpleUser.

SimpleUser

public SimpleUser(String username,
                  Collection<String> connectionIdentifiers,
                  Collection<String> connectionGroupIdentifiers)

Creates a new SimpleUser having the given username and READ access to the connections and groups having the given identifiers.

Parameters:

username - The username to assign to this SimpleUser.

connectionIdentifiers - The identifiers of all connections this user has READ access to.

connectionGroupIdentifiers - The identifiers of all connection groups this user has READ access to.

SimpleUser

public SimpleUser(String username,
                  Collection<String> userIdentifiers,
                  Collection<String> connectionIdentifiers,
                  Collection<String> connectionGroupIdentifiers)

Creates a new SimpleUser having the given username and READ access to the users, connections, and groups having the given identifiers.

Parameters:

username - The username to assign to this SimpleUser.

userIdentifiers - The identifiers of all users this user has READ access to.

connectionIdentifiers - The identifiers of all connections this user has READ access to.

connectionGroupIdentifiers - The identifiers of all connection groups this user has READ access to.

Method Detail

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.

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.

Parameters:

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

getSystemPermissions

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

Description copied from interface: User

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

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

Description copied from interface: User

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

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

Description copied from interface: User

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.

getUserPermissions

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

Description copied from interface: User

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.

getActiveConnectionPermissions

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

Description copied from interface: User

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.

getSharingProfilePermissions

public ObjectPermissionSet getSharingProfilePermissions()

Description copied from interface: User

Returns all sharing profile permissions given to this user.

Returns:

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