org.apache.guacamole.net.auth

Interface UserContext

All Known Implementing Classes:

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.

Author:

Michael Jumper

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.

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.

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.

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

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

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.

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.

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.

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.