org.apache.guacamole.net.auth.simple

Class SimpleUserContext

java.lang.Object

org.apache.guacamole.net.auth.simple.SimpleUserContext

All Implemented Interfaces:

UserContext

public class SimpleUserContext
extends Object
implements UserContext

An extremely simple UserContext implementation which provides access to a defined and restricted set of GuacamoleConfigurations. Access to querying or modifying either users or permissions is denied.

Author:

Michael Jumper

Constructor Summary

Constructors

Constructor and Description
SimpleUserContext(AuthenticationProvider authProvider, Map<String,org.apache.guacamole.protocol.GuacamoleConfiguration> configs) Creates a new SimpleUserContext which provides access to only those configurations within the given Map.
SimpleUserContext(AuthenticationProvider authProvider, String username, Map<String,org.apache.guacamole.protocol.GuacamoleConfiguration> configs) Creates a new SimpleUserContext for the user with the given username which provides access to only those configurations within the given Map.

Method Summary

Modifier and Type	Method and Description
Directory<ActiveConnection>	getActiveConnectionDirectory() Retrieves a Directory which can be used to view and manipulate active connections, but only as allowed by the permissions given to the user.
AuthenticationProvider	getAuthenticationProvider() Returns the AuthenticationProvider which created this UserContext, which may not be the same AuthenticationProvider that authenticated the user associated with this UserContext.
Collection<Form>	getConnectionAttributes() Retrieves a collection of all attributes applicable to connections.
Directory<Connection>	getConnectionDirectory() Retrieves a Directory which can be used to view and manipulate connections and their configurations, but only as allowed by the permissions given to the user.
Collection<Form>	getConnectionGroupAttributes() Retrieves a collection of all attributes applicable to connection groups.
Directory<ConnectionGroup>	getConnectionGroupDirectory() Retrieves a Directory which can be used to view and manipulate connection groups and their members, but only as allowed by the permissions given to the user.
ConnectionRecordSet	getConnectionHistory() Retrieves all connection records visible to current user.
ConnectionGroup	getRootConnectionGroup() Retrieves a connection group which can be used to view and manipulate connections, but only as allowed by the permissions given to the user of this UserContext.
Collection<Form>	getSharingProfileAttributes() Retrieves a collection of all attributes applicable to sharing profiles.
Directory<SharingProfile>	getSharingProfileDirectory() Retrieves a Directory which can be used to view and manipulate sharing profiles and their configurations, but only as allowed by the permissions given to the user.
Collection<Form>	getUserAttributes() Retrieves a collection of all attributes applicable to users.
Directory<User>	getUserDirectory() Retrieves a Directory which can be used to view and manipulate other users, but only as allowed by the permissions given to the user of this UserContext.
User	self() Returns the User whose access rights control the operations of this UserContext.

Methods inherited from class java.lang.Object

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

Constructor Detail

SimpleUserContext

public SimpleUserContext(AuthenticationProvider authProvider,
                         Map<String,org.apache.guacamole.protocol.GuacamoleConfiguration> configs)

Creates a new SimpleUserContext which provides access to only those configurations within the given Map. The username is assigned arbitrarily.

Parameters:

authProvider - The AuthenticationProvider creating this UserContext.

configs - A Map of all configurations for which the user associated with this UserContext has read access.

SimpleUserContext

public SimpleUserContext(AuthenticationProvider authProvider,
                         String username,
                         Map<String,org.apache.guacamole.protocol.GuacamoleConfiguration> configs)

Creates a new SimpleUserContext for the user with the given username which provides access to only those configurations within the given Map.

Parameters:

authProvider - The AuthenticationProvider creating this UserContext.

username - The username of the user associated with this UserContext.

configs - A Map of all configurations for which the user associated with this UserContext has read access.

Method Detail

self

public User self()

Description copied from interface: UserContext

Returns the User whose access rights control the operations of this UserContext.

Specified by:

self in interface UserContext

Returns:

The User whose access rights control the operations of this UserContext.

getAuthenticationProvider

public AuthenticationProvider getAuthenticationProvider()

Description copied from interface: UserContext

Returns the AuthenticationProvider which created this UserContext, which may not be the same AuthenticationProvider that authenticated the user associated with this UserContext.

Specified by:

getAuthenticationProvider in interface UserContext

Returns:

The AuthenticationProvider that created this UserContext.

getUserDirectory

public Directory<User> getUserDirectory()
                                 throws org.apache.guacamole.GuacamoleException

Description copied from interface: UserContext

Retrieves a Directory which can be used to view and manipulate other users, but only as allowed by the permissions given to the user of this UserContext.

Specified by:

getUserDirectory in interface UserContext

Returns:

A Directory whose operations are bound by the restrictions of this UserContext.

Throws:

org.apache.guacamole.GuacamoleException - If an error occurs while creating the Directory.

getConnectionDirectory

public Directory<Connection> getConnectionDirectory()
                                             throws org.apache.guacamole.GuacamoleException

Description copied from interface: UserContext

Retrieves a Directory which can be used to view and manipulate connections and their configurations, but only as allowed by the permissions given to the user.

Specified by:

getConnectionDirectory in interface UserContext

Returns:

A Directory whose operations are bound by the permissions of the user.

Throws:

org.apache.guacamole.GuacamoleException - If an error occurs while creating the Directory.

getConnectionGroupDirectory

public Directory<ConnectionGroup> getConnectionGroupDirectory()
                                                       throws org.apache.guacamole.GuacamoleException

Description copied from interface: UserContext

Retrieves a Directory which can be used to view and manipulate connection groups and their members, but only as allowed by the permissions given to the user.

Specified by:

getConnectionGroupDirectory in interface UserContext

Returns:

A Directory whose operations are bound by the permissions of the user.

Throws:

org.apache.guacamole.GuacamoleException - If an error occurs while creating the Directory.

getRootConnectionGroup

public ConnectionGroup getRootConnectionGroup()
                                       throws org.apache.guacamole.GuacamoleException

Description copied from interface: UserContext

Retrieves a connection group which can be used to view and manipulate connections, but only as allowed by the permissions given to the user of this UserContext.

Specified by:

getRootConnectionGroup in interface UserContext

Returns:

A connection group whose operations are bound by the restrictions of this UserContext.

Throws:

org.apache.guacamole.GuacamoleException - If an error occurs while creating the Directory.

getSharingProfileDirectory

public Directory<SharingProfile> getSharingProfileDirectory()
                                                     throws org.apache.guacamole.GuacamoleException

Description copied from interface: UserContext

Retrieves a Directory which can be used to view and manipulate sharing profiles and their configurations, but only as allowed by the permissions given to the user.

Specified by:

getSharingProfileDirectory in interface UserContext

Returns:

A Directory whose operations are bound by the permissions of the user.

Throws:

org.apache.guacamole.GuacamoleException - If an error occurs while creating the Directory.

getActiveConnectionDirectory

public Directory<ActiveConnection> getActiveConnectionDirectory()
                                                         throws org.apache.guacamole.GuacamoleException

Description copied from interface: UserContext

Retrieves a Directory which can be used to view and manipulate active connections, but only as allowed by the permissions given to the user.

Specified by:

getActiveConnectionDirectory in interface UserContext

Returns:

A Directory whose operations are bound by the permissions of the user.

Throws:

org.apache.guacamole.GuacamoleException - If an error occurs while creating the Directory.

getConnectionHistory

public ConnectionRecordSet getConnectionHistory()
                                         throws org.apache.guacamole.GuacamoleException

Description copied from interface: UserContext

Retrieves all connection records visible to current user. The resulting set of connection records can be further filtered and ordered using the methods defined on ConnectionRecordSet.

Specified by:

getConnectionHistory in interface UserContext

Returns:

A set of all connection records visible to the current user.

Throws:

org.apache.guacamole.GuacamoleException - If an error occurs while retrieving the connection records.

getUserAttributes

public Collection<Form> getUserAttributes()

Description copied from interface: UserContext

Retrieves a collection of all attributes applicable to users. This collection will contain only those attributes which the current user has general permission to view or modify. If there are no such attributes, this collection will be empty.

Specified by:

getUserAttributes in interface UserContext

Returns:

A collection of all attributes applicable to users.

getConnectionAttributes

public Collection<Form> getConnectionAttributes()

Description copied from interface: UserContext

Retrieves a collection of all attributes applicable to connections. This collection will contain only those attributes which the current user has general permission to view or modify. If there are no such attributes, this collection will be empty.

Specified by:

getConnectionAttributes in interface UserContext

Returns:

A collection of all attributes applicable to connections.

getConnectionGroupAttributes

public Collection<Form> getConnectionGroupAttributes()

Description copied from interface: UserContext

Retrieves a collection of all attributes applicable to connection groups. This collection will contain only those attributes which the current user has general permission to view or modify. If there are no such attributes, this collection will be empty.

Specified by:

getConnectionGroupAttributes in interface UserContext

Returns:

A collection of all attributes applicable to connection groups.

getSharingProfileAttributes

public Collection<Form> getSharingProfileAttributes()

Description copied from interface: UserContext

Retrieves a collection of all attributes applicable to sharing profiles. This collection will contain only those attributes which the current user has general permission to view or modify. If there are no such attributes, this collection will be empty.

Specified by:

getSharingProfileAttributes in interface UserContext

Returns:

A collection of all attributes applicable to sharing profile.