public interface User extends Identifiable, Attributes, Permissions
Modifier and Type | Interface and Description |
---|---|
static class |
User.Attribute
All standard attribute names with semantics defined by the Guacamole web
application.
|
Modifier and Type | Method and Description |
---|---|
Permissions |
getEffectivePermissions()
Returns a read-only view of all permissions granted to this user.
|
default List<? extends ActivityRecord> |
getHistory()
Deprecated.
This function is deprecated in favor of
getUserHistory , which
returns the login history as an ActivityRecordSet which supports
various sort and filter functions. While this continues to be defined
for API compatibility, new implementation should avoid this function
and use getUserHistory(), instead. |
Date |
getLastActive()
Returns the date and time that this user was last active.
|
String |
getPassword()
Returns this user's password.
|
RelatedObjectSet |
getUserGroups()
Returns a set of all readable user groups of which this user is a member.
|
default ActivityRecordSet<ActivityRecord> |
getUserHistory()
Returns an ActivityRecordSet containing ActivityRecords representing
the login history for this user, including any active sessions.
|
void |
setPassword(String password)
Sets this user's password.
|
getIdentifier, setIdentifier
getAttributes, setAttributes
getActiveConnectionPermissions, getConnectionGroupPermissions, getConnectionPermissions, getSharingProfilePermissions, getSystemPermissions, getUserGroupPermissions, getUserPermissions
String getPassword()
void setPassword(String password)
password
- The password to set.Date getLastActive()
@Deprecated default List<? extends ActivityRecord> getHistory() throws org.apache.guacamole.GuacamoleException
getUserHistory
, which
returns the login history as an ActivityRecordSet which supports
various sort and filter functions. While this continues to be defined
for API compatibility, new implementation should avoid this function
and use getUserHistory(), instead.org.apache.guacamole.GuacamoleException
- If history tracking is not implemented, if an error occurs while
reading the history of this user, or if permission is denied.default ActivityRecordSet<ActivityRecord> getUserHistory() throws org.apache.guacamole.GuacamoleException
getHistory
method, this method should throw GuacamoleUnsupportedException.org.apache.guacamole.GuacamoleException
- If history tracking is not implemented, if an error occurs while
reading the history of this user, or if permission is denied.RelatedObjectSet getUserGroups() throws org.apache.guacamole.GuacamoleException
org.apache.guacamole.GuacamoleException
- If an error occurs while retrieving the user groups.Permissions getEffectivePermissions() throws org.apache.guacamole.GuacamoleException
org.apache.guacamole.GuacamoleException
- If an error occurs while retrieving permissions, or if reading all
permissions is not allowed.Copyright © 2020. All rights reserved.