org.apache.guacamole.net.auth

Class AbstractUserContext

java.lang.Object

org.apache.guacamole.net.auth.AbstractUserContext

All Implemented Interfaces:

UserContext

Direct Known Subclasses:

SimpleUserContext

public abstract class AbstractUserContext
extends Object
implements UserContext

Base implementation of UserContext which provides default implementations of most functions. Implementations must provide their own UserContext.self() and UserContext.getAuthenticationProvider(), but otherwise need only override an implemented function if they wish to actually implement the functionality defined for that function by the UserContext interface.

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	DEFAULT_ROOT_CONNECTION_GROUP The unique identifier that will be used for the root connection group if getRootConnectionGroup() is not overridden.

Constructor Summary

Constructors

Constructor and Description
AbstractUserContext()

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.
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.
ActivityRecordSet<ConnectionRecord>	getConnectionHistory() Retrieves all connection records visible to current user.
Object	getResource() Returns an arbitrary REST resource representing this UserContext.
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.
Collection<Form>	getUserGroupAttributes() Retrieves a collection of all attributes applicable to user groups.
Directory<UserGroup>	getUserGroupDirectory() Retrieves a Directory which can be used to view and manipulate user groups, but only as allowed by the permissions given to the user of this UserContext.
ActivityRecordSet<ActivityRecord>	getUserHistory() Retrieves all user history records visible to current user.
void	invalidate() Invalidates this user context, releasing all associated resources.

Methods inherited from class java.lang.Object

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

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

getAuthenticationProvider, self

Field Detail

DEFAULT_ROOT_CONNECTION_GROUP

protected static final String DEFAULT_ROOT_CONNECTION_GROUP

The unique identifier that will be used for the root connection group if getRootConnectionGroup() is not overridden.

See Also:

Constant Field Values

Constructor Detail

AbstractUserContext

public AbstractUserContext()

Method Detail

getResource

public Object getResource()
                   throws org.apache.guacamole.GuacamoleException

Returns an arbitrary REST resource representing this UserContext. The REST resource returned must be properly annotated with JSR-311 annotations, and may serve as the root resource for any number of subresources. The returned resource is ultimately exposed at ".../api/session/ext/IDENTIFIER/", where IDENTIFIER is the identifier of the AuthenticationProvider associated with this UserContext. REST resources returned by this function will only be reachable by authenticated users with valid authentication tokens. REST resources which should be accessible by all users regardless of whether they have authenticated should instead be returned from AuthenticationProvider.getResource().

This implementation simply returns null. Implementations that wish to expose REST resources specific to a user's session should override this function.

Specified by:

getResource in interface UserContext

Returns:

An arbitrary REST resource, annotated with JSR-311 annotations, or null if no such resource is defined.

Throws:

org.apache.guacamole.GuacamoleException - If the REST resource cannot be returned due to an error.

getUserDirectory

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

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.

This implementation returns a Directory which contains only the User returned by UserContext.self() (the current user associated with this UserContext. Implementations that wish to expose the existence of other users should override this function.

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.

getUserGroupDirectory

public Directory<UserGroup> getUserGroupDirectory()
                                           throws org.apache.guacamole.GuacamoleException

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

This implementation simply returns an empty Directory. Implementations that wish to expose user groups should override this function.

Specified by:

getUserGroupDirectory 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

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.

This implementation simply returns an empty Directory. Implementations that wish to expose connections should override this function.

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

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.

This implementation returns a Directory which contains only the root connection group returned by getRootConnectionGroup(). Implementations that wish to provide a structured connection hierarchy should override this function. If only a flat list of connections will be used, only getConnectionDirectory() needs to be overridden.

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.

getActiveConnectionDirectory

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

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

This implementation simply returns an empty Directory. Implementations that wish to expose the status of active connections should override this function.

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.

getSharingProfileDirectory

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

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.

This implementation simply returns an empty Directory. Implementations that wish to provide screen sharing functionality through the use of sharing profiles should override this function.

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.

getConnectionHistory

public ActivityRecordSet<ConnectionRecord> getConnectionHistory()
                                                         throws org.apache.guacamole.GuacamoleException

Retrieves all connection records visible to current user. Connection history records describe the start and end times of connections, and correspond to the times that users connect or disconnect to individual remote desktops. The resulting set of connection records can be further filtered and ordered using the methods defined on ActivityRecordSet.

This implementation simply returns an empty ActivityRecordSet. Implementations that wish to expose connection usage history should override this function.

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.

getUserHistory

public ActivityRecordSet<ActivityRecord> getUserHistory()
                                                 throws org.apache.guacamole.GuacamoleException

Retrieves all user history records visible to current user. User history records describe the start and end times of user sessions, and correspond to the times that users logged in or out. The resulting set of user records can be further filtered and ordered using the methods defined on ActivityRecordSet.

This implementation simply returns an empty ActivityRecordSet. Implementations that wish to expose user login/logout history should override this function.

Specified by:

getUserHistory in interface UserContext

Returns:

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

Throws:

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

getRootConnectionGroup

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

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.

This implementation returns a new ConnectionGroup with the identifier defined by DEFAULT_ROOT_CONNECTION_GROUP and containing all connections exposed by the Directory returned by getConnectionDirectory(). Implementations that wish to provide a structured connection hierarchy should override this function. If only a flat list of connections will be used, only getConnectionDirectory() needs to be overridden.

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.

getUserAttributes

public Collection<Form> getUserAttributes()

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.

This implementation simply returns an empty Collection. Implementations that wish to expose custom user attributes as fields within user edit screens should override this function.

Specified by:

getUserAttributes in interface UserContext

Returns:

A collection of all attributes applicable to users.

getUserGroupAttributes

public Collection<Form> getUserGroupAttributes()

Retrieves a collection of all attributes applicable to user 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.

This implementation simply returns an empty Collection. Implementations that wish to expose custom user group attributes as fields within user group edit screens should override this function.

Specified by:

getUserGroupAttributes in interface UserContext

Returns:

A collection of all attributes applicable to user groups.

getConnectionAttributes

public Collection<Form> getConnectionAttributes()

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.

This implementation simply returns an empty Collection. Implementations that wish to expose custom connection attributes as fields within connection edit screens should override this function.

Specified by:

getConnectionAttributes in interface UserContext

Returns:

A collection of all attributes applicable to connections.

getConnectionGroupAttributes

public Collection<Form> getConnectionGroupAttributes()

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.

This implementation simply returns an empty Collection. Implementations that wish to expose custom connection group attributes as fields within connection group edit screens should override this function.

Specified by:

getConnectionGroupAttributes in interface UserContext

Returns:

A collection of all attributes applicable to connection groups.

getSharingProfileAttributes

public Collection<Form> getSharingProfileAttributes()

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.

This implementation simply returns an empty Collection. Implementations that wish to expose custom sharing profile attributes as fields within sharing profile edit screens should override this function.

Specified by:

getSharingProfileAttributes in interface UserContext

Returns:

A collection of all attributes applicable to sharing profile.

invalidate

public void invalidate()

Invalidates this user context, releasing all associated resources. This function will be invoked when the user logs out, or when their session is automatically invalidated.

This implementation does nothing. Implementations that wish to perform cleanup tasks when the user associated with this UserContext is being logged out should override this function.

Specified by:

invalidate in interface UserContext