org.apache.guacamole.net.auth

Interface UserContext

All Known Implementing Classes:

AbstractUserContext, DelegatingUserContext, SimpleUserContext

public interface UserContext

The context of an active user. The functions of this class enforce all permissions and act only within the rights of the associated user.

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.
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.
User	self() Returns the User whose access rights control the operations of this UserContext.

Method Detail

self

User self()

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

Returns:

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

getResource

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

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.

getAuthenticationProvider

AuthenticationProvider getAuthenticationProvider()

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

Returns:

The AuthenticationProvider that created this UserContext.

getUserDirectory

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.

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

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.

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

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.

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

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.

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

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.

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

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.

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

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.

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

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.

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

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.

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

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.

Returns:

A collection of all attributes applicable to users.

getUserGroupAttributes

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.

Returns:

A collection of all attributes applicable to user groups.

getConnectionAttributes

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.

Returns:

A collection of all attributes applicable to connections.

getConnectionGroupAttributes

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.

Returns:

A collection of all attributes applicable to connection groups.

getSharingProfileAttributes

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.

Returns:

A collection of all attributes applicable to sharing profile.

invalidate

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.