DelegatingUser (guacamole-ext 1.0.0 API)

java.lang.Object
- org.apache.guacamole.net.auth.DelegatingUser

All Implemented Interfaces:

Attributes, Identifiable, Permissions, User
```
public class DelegatingUser
extends Object
implements User
```
User implementation which simply delegates all function calls to an underlying User.

Nested Class Summary
- Nested classes/interfaces inherited from interface org.apache.guacamole.net.auth.User
  User.Attribute

Constructor Summary

Constructors
Constructor and Description

DelegatingUser(User user)
Wraps the given User such that all function calls against this DelegatingUser will be delegated to it.

Constructors
Constructor and Description
`DelegatingUser(User user)` Wraps the given User such that all function calls against this DelegatingUser will be delegated to it.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ObjectPermissionSet`	`getActiveConnectionPermissions()` Returns all permissions given to this object regarding currently-active connections.
`Map<String,String>`	`getAttributes()` Returns all attributes associated with this object.
`ObjectPermissionSet`	`getConnectionGroupPermissions()` Returns all connection group permissions given to this object.
`ObjectPermissionSet`	`getConnectionPermissions()` Returns all connection permissions given to this object.
`protected User`	`getDelegateUser()` Returns the underlying User wrapped by this DelegatingUser.
`Permissions`	`getEffectivePermissions()` Returns a read-only view of all permissions granted to this user.
`List<? extends ActivityRecord>`	`getHistory()` Returns a list of ActivityRecords representing the login history of this user, including any active sessions.
`String`	`getIdentifier()` Returns the unique identifier assigned to this object.
`Date`	`getLastActive()` Returns the date and time that this user was last active.
`String`	`getPassword()` Returns this user's password.
`ObjectPermissionSet`	`getSharingProfilePermissions()` Returns all sharing profile permissions given to this object.
`SystemPermissionSet`	`getSystemPermissions()` Returns all system-level permissions given to this object.
`ObjectPermissionSet`	`getUserGroupPermissions()` Returns all user group permissions given to this object.
`RelatedObjectSet`	`getUserGroups()` Returns a set of all readable user groups of which this user is a member.
`ObjectPermissionSet`	`getUserPermissions()` Returns all user permissions given to this object.
`void`	`setAttributes(Map<String,String> attributes)` Sets the given attributes.
`void`	`setIdentifier(String identifier)` Sets the identifier assigned to this object.
`void`	`setPassword(String password)` Sets this user's password.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - DelegatingUser
```
public DelegatingUser(User user)
```
    Wraps the given User such that all function calls against this DelegatingUser will be delegated to it.
    
    Parameters:
    
    user - The User to wrap.
- Method Detail
  - getDelegateUser
```
protected User getDelegateUser()
```
    Returns the underlying User wrapped by this DelegatingUser.
    
    Returns:
    
    The User wrapped by this DelegatingUser.
  - getIdentifier
```
public String getIdentifier()
```
    Description copied from interface: Identifiable
    
    Returns the unique identifier assigned to this object. All identifiable objects must have a deterministic, unique identifier which may not be null.
    
    Specified by:
    
    getIdentifier in interface Identifiable
    
    Returns:
    
    The unique identifier assigned to this object, which may not be null.
  - setIdentifier
```
public void setIdentifier(String identifier)
```
    Description copied from interface: Identifiable
    
    Sets the identifier assigned to this object.
    
    Specified by:
    
    setIdentifier in interface Identifiable
    
    Parameters:
    
    identifier - The identifier to assign.
  - getPassword
```
public String getPassword()
```
    Description copied from interface: User
    
    Returns this user's password. Note that the password returned may be hashed or completely arbitrary.
    
    Specified by:
    
    getPassword in interface User
    
    Returns:
    
    A String which may (or may not) be the user's password.
  - setPassword
```
public void setPassword(String password)
```
    Description copied from interface: User
    
    Sets this user's password. Note that while this function is guaranteed to change the password of this User object, there is no guarantee that getPassword() will return the value given to setPassword().
    
    Specified by:
    
    setPassword in interface User
    
    Parameters:
    
    password - The password to set.
  - getAttributes
```
public Map<String,String> getAttributes()
```
    Description copied from interface: Attributes
    
    Returns all attributes associated with this object. The returned map may not be modifiable.
    
    Specified by:
    
    getAttributes in interface Attributes
    
    Returns:
    
    A map of all attribute identifiers to their corresponding values, for all attributes associated with this object, which may not be modifiable.
  - setAttributes
```
public void setAttributes(Map<String,String> attributes)
```
    Description copied from interface: Attributes
    
    Sets the given attributes. If an attribute within the map is not supported, it will simply be dropped. Any attributes not within the given map will be left untouched. Attributes which are not declared within the associated UserContext MUST NOT be submitted, but other extensions may manipulate the declared attributes through decorate() and redecorate(). Implementations may optionally allow storage of unsupported attributes. Extensions which rely on other extensions to store their attribute values should verify that such storage is supported by first testing that the attribute value is retrievable via getAttributes() after being set.
    
    Specified by:
    
    setAttributes in interface Attributes
    
    Parameters:
    
    attributes - A map of all attribute identifiers to their corresponding values.
  - getLastActive
```
public Date getLastActive()
```
    Description copied from interface: User
    
    Returns the date and time that this user was last active. If the user was never active, the time that the user was last active is unknown, or this information is not visible to the current user, this may be null.
    
    Specified by:
    
    getLastActive in interface User
    
    Returns:
    
    The date and time this user was last active, or null if this information is unavailable or inapplicable.
  - getHistory
```
public List<? extends ActivityRecord> getHistory()
                                          throws org.apache.guacamole.GuacamoleException
```
    Description copied from interface: User
    
    Returns a list of ActivityRecords representing the login history of this user, including any active sessions. ActivityRecords in this list will be sorted in descending order of end time (active sessions are first), and then in descending order of start time (newer sessions are first).
    
    Specified by:
    
    getHistory in interface User
    
    Returns:
    
    A list of ActivityRecords representing the login history of this User.
    
    Throws:
    
    org.apache.guacamole.GuacamoleException - If an error occurs while reading the history of this user, or if permission is denied.
  - getSystemPermissions
```
public SystemPermissionSet getSystemPermissions()
                                         throws org.apache.guacamole.GuacamoleException
```
    Description copied from interface: Permissions
    
    Returns all system-level permissions given to this object.
    
    Specified by:
    
    getSystemPermissions in interface Permissions
    
    Returns:
    
    A SystemPermissionSet of all system-level permissions granted to this object.
    
    Throws:
    
    org.apache.guacamole.GuacamoleException - If an error occurs while retrieving permissions, or if reading all permissions is not allowed.
  - getConnectionPermissions
```
public ObjectPermissionSet getConnectionPermissions()
                                             throws org.apache.guacamole.GuacamoleException
```
    Description copied from interface: Permissions
    
    Returns all connection permissions given to this object.
    
    Specified by:
    
    getConnectionPermissions in interface Permissions
    
    Returns:
    
    An ObjectPermissionSet of all connection permissions granted to this object.
    
    Throws:
    
    org.apache.guacamole.GuacamoleException - If an error occurs while retrieving permissions, or if reading all permissions is not allowed.
  - getConnectionGroupPermissions
```
public ObjectPermissionSet getConnectionGroupPermissions()
                                                  throws org.apache.guacamole.GuacamoleException
```
    Description copied from interface: Permissions
    
    Returns all connection group permissions given to this object.
    
    Specified by:
    
    getConnectionGroupPermissions in interface Permissions
    
    Returns:
    
    An ObjectPermissionSet of all connection group permissions granted to this object.
    
    Throws:
    
    org.apache.guacamole.GuacamoleException - If an error occurs while retrieving permissions, or if reading all permissions is not allowed.
  - getSharingProfilePermissions
```
public ObjectPermissionSet getSharingProfilePermissions()
                                                 throws org.apache.guacamole.GuacamoleException
```
    Description copied from interface: Permissions
    
    Returns all sharing profile permissions given to this object.
    
    Specified by:
    
    getSharingProfilePermissions in interface Permissions
    
    Returns:
    
    An ObjectPermissionSet of all sharing profile permissions granted to this object.
    
    Throws:
    
    org.apache.guacamole.GuacamoleException - If an error occurs while retrieving permissions, or if reading all permissions is not allowed.
  - getActiveConnectionPermissions
```
public ObjectPermissionSet getActiveConnectionPermissions()
                                                   throws org.apache.guacamole.GuacamoleException
```
    Description copied from interface: Permissions
    
    Returns all permissions given to this object regarding currently-active connections.
    
    Specified by:
    
    getActiveConnectionPermissions in interface Permissions
    
    Returns:
    
    An ObjectPermissionSet of all active connection permissions granted to this object.
    
    Throws:
    
    org.apache.guacamole.GuacamoleException - If an error occurs while retrieving permissions, or if reading all permissions is not allowed.
  - getUserPermissions
```
public ObjectPermissionSet getUserPermissions()
                                       throws org.apache.guacamole.GuacamoleException
```
    Description copied from interface: Permissions
    
    Returns all user permissions given to this object.
    
    Specified by:
    
    getUserPermissions in interface Permissions
    
    Returns:
    
    An ObjectPermissionSet of all user permissions granted to this object.
    
    Throws:
    
    org.apache.guacamole.GuacamoleException - If an error occurs while retrieving permissions, or if reading all permissions is not allowed.
  - getUserGroupPermissions
```
public ObjectPermissionSet getUserGroupPermissions()
                                            throws org.apache.guacamole.GuacamoleException
```
    Description copied from interface: Permissions
    
    Returns all user group permissions given to this object.
    
    Specified by:
    
    getUserGroupPermissions in interface Permissions
    
    Returns:
    
    An ObjectPermissionSet of all user group permissions granted to this object.
    
    Throws:
    
    org.apache.guacamole.GuacamoleException - If an error occurs while retrieving permissions, or if reading all permissions is not allowed.
  - getUserGroups
```
public RelatedObjectSet getUserGroups()
                               throws org.apache.guacamole.GuacamoleException
```
    Description copied from interface: User
    
    Returns a set of all readable user groups of which this user is a member. If permission is granted for the current user to modify the membership of this user, then the returned set will be mutable, and any such modifications should be made through changes to the returned set.
    
    Specified by:
    
    getUserGroups in interface User
    
    Returns:
    
    The set of all readable user groups of which this user is a member.
    
    Throws:
    
    org.apache.guacamole.GuacamoleException - If an error occurs while retrieving the user groups.
  - getEffectivePermissions
```
public Permissions getEffectivePermissions()
                                    throws org.apache.guacamole.GuacamoleException
```
    Description copied from interface: User
    
    Returns a read-only view of all permissions granted to this user. The exact semantics of what permissions are granted are up to the implementation, and the permissions within this view may be implied, derived dynamically, inherited through multiple levels of group membership, etc.
    
    Specified by:
    
    getEffectivePermissions in interface User
    
    Returns:
    
    A read-only view of the permissions which are granted to this user.
    
    Throws:
    
    org.apache.guacamole.GuacamoleException - If an error occurs while retrieving permissions, or if reading all permissions is not allowed.

Class DelegatingUser

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.guacamole.net.auth.User

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DelegatingUser

Method Detail

getDelegateUser

getIdentifier

setIdentifier

getPassword

setPassword

getAttributes

setAttributes

getLastActive

getHistory

getSystemPermissions

getConnectionPermissions

getConnectionGroupPermissions

getSharingProfilePermissions

getActiveConnectionPermissions

getUserPermissions

getUserGroupPermissions

getUserGroups

getEffectivePermissions