Account (Fathom-Security 1.0.1 API)

java.lang.Object
- fathom.realm.Account

All Implemented Interfaces:

Serializable
```
public class Account
extends Object
implements Serializable
```
Account represents Credentials and Authorizations. This class is partially based on Apache Shiro Subject.

Author:

James Moger

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected Authorizations`	`authorizations`
`protected Credentials`	`credentials`
`protected Set<String>`	`emailAddresses`
`static Account`	`GUEST`
`protected boolean`	`isDisabled`
`protected String`	`name`
`protected Set<String>`	`tokens`

Constructor Summary

Constructors
Constructor and Description
`Account(String name, Credentials credentials)`
`Account(String name, Credentials credentials, Authorizations authorizations)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addEmailAddress(String address)`
`void`	`addEmailAddresses(Collection<String> addresses)`
`void`	`addEmailAddresses(String... addresses)`
`void`	`addToken(String token)`
`void`	`addTokens(Collection<String> tokens)`
`void`	`addTokens(String... tokens)`
`void`	`checkAdministrator()` Ensures this Account is an administrator.
`void`	`checkAuthenticated()` Ensures this Account has actively authenticated.
`void`	`checkGuest()` Ensures this Account is the Guest account.
`void`	`checkPermission(String permission)` Ensures this Account implies the specified permission String.
`void`	`checkPermissions(Collection<String> permissions)` Ensures this Account `implies` all of the specified permission strings.
`void`	`checkPermissions(String... permissions)` Ensures this Account `implies` all of the specified permission strings.
`void`	`checkRole(String roleIdentifier)` Asserts this Account has the specified role by returning quietly if they do or throwing an `AuthorizationException` if they do not.
`void`	`checkRoles(Collection<String> roleIdentifiers)` Asserts this Account has all of the specified roles by returning quietly if they do or throwing an `AuthorizationException` if they do not.
`void`	`checkRoles(String... roleIdentifiers)` Asserts this Account has all of the specified roles by returning quietly if they do or throwing an `AuthorizationException` if they do not.
`void`	`checkToken(String token)` Asserts this Account has the specified token by returning quietly if they do or throwing an `AuthorizationException` if they do not.
`Authorizations`	`getAuthorizations()`
`Credentials`	`getCredentials()`
`String`	`getEmailAddress()`
`Collection<String>`	`getEmailAddresses()`
`String`	`getName()`
`String`	`getToken()`
`Collection<String>`	`getTokens()`
`String`	`getUsername()`
`boolean`	`hasRole(String roleIdentifier)` Returns `true` if this Account has the specified role, `false` otherwise.
`boolean`	`hasRoles(Collection<String> roleIdentifiers)` Returns `true` if this Account has the specified roles, `false` otherwise.
`boolean`	`hasRoles(String... roleIdentifiers)` Returns `true` if this Account has the specified roles, `false` otherwise.
`boolean`	`hasToken(String token)` Returns `true` if this Account has the specified role, `false` otherwise.
`boolean`	`isAdministrator()` Returns `true` if this Account is an administrator.
`boolean`	`isAuthenticated()` Returns `true` if this Account is authenticated.
`boolean`	`isDisabled()` Returns `true` if this Account is disabled.
`boolean`	`isEnabled()` Returns `true` if this Account is enabled.
`boolean`	`isGuest()` Returns `true` if this Account is the GUEST account.
`boolean[]`	`isPermitted(String... permissions)` Checks if this Account implies the given permission strings and returns a boolean array indicating which permissions are implied.
`boolean`	`isPermitted(String permission)` Returns `true` if this Account is permitted to perform an action or access a resource summarized by the specified permission string.
`boolean`	`isPermittedAll(Collection<String> permissions)` Returns `true` if this Account implies all of the specified permission strings, `false` otherwise.
`boolean`	`isPermittedAll(String... permissions)` Returns `true` if this Account implies all of the specified permission strings, `false` otherwise.
`void`	`setDisabled()` Disables this account.
`void`	`setEnabled()` Enables this account.
`void`	`setName(String name)`
`String`	`toString()`

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

- Field Detail
  - GUEST
```
public static final transient Account GUEST
```
  - credentials
```
protected final Credentials credentials
```
  - authorizations
```
protected final Authorizations authorizations
```
  - emailAddresses
```
protected final Set<String> emailAddresses
```
  - tokens
```
protected final Set<String> tokens
```
  - name
```
protected String name
```
  - isDisabled
```
protected boolean isDisabled
```
- Constructor Detail
  - Account
```
public Account(String name,
               Credentials credentials)
```
  - Account
```
public Account(String name,
               Credentials credentials,
               Authorizations authorizations)
```
- Method Detail
  - getCredentials
```
public Credentials getCredentials()
```
  - getAuthorizations
```
public Authorizations getAuthorizations()
```
  - getName
```
public String getName()
```
  - setName
```
public void setName(String name)
```
  - getUsername
```
public String getUsername()
```
  - addEmailAddress
```
public void addEmailAddress(String address)
```
  - addEmailAddresses
```
public void addEmailAddresses(String... addresses)
```
  - addEmailAddresses
```
public void addEmailAddresses(Collection<String> addresses)
```
  - getEmailAddress
```
public String getEmailAddress()
```
  - getEmailAddresses
```
public Collection<String> getEmailAddresses()
```
  - addToken
```
public void addToken(String token)
```
  - addTokens
```
public void addTokens(String... tokens)
```
  - addTokens
```
public void addTokens(Collection<String> tokens)
```
  - getToken
```
public String getToken()
```
  - getTokens
```
public Collection<String> getTokens()
```
  - setDisabled
```
public void setDisabled()
```
    Disables this account.
  - setEnabled
```
public void setEnabled()
```
    Enables this account.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - isGuest
```
public boolean isGuest()
```
    Returns true if this Account is the GUEST account.
    
    Returns:
    
    true if this Account is the GUEST account.
  - isAuthenticated
```
public boolean isAuthenticated()
```
    Returns true if this Account is authenticated.
    
    Returns:
    
    true if this Account is authenticated.
  - isAdministrator
```
public boolean isAdministrator()
```
    Returns true if this Account is an administrator.
    
    Returns:
    
    true if this Account is an administrator.
  - isDisabled
```
public boolean isDisabled()
```
    Returns true if this Account is disabled.
    
    Returns:
    
    true if this Account is disabled.
  - isEnabled
```
public boolean isEnabled()
```
    Returns true if this Account is enabled.
    
    Returns:
    
    true if this Account is enabled.
  - checkGuest
```
public void checkGuest()
                throws AuthenticationException
```
    Ensures this Account is the Guest account.
    
    Throws:
    
    AuthenticationException - if the Account is not the Guest account.
  - checkAuthenticated
```
public void checkAuthenticated()
                        throws AuthenticationException
```
    Ensures this Account has actively authenticated.
    
    Throws:
    
    AuthenticationException - if the Account is not authenticated.
  - checkAdministrator
```
public void checkAdministrator()
                        throws AuthenticationException
```
    Ensures this Account is an administrator.
    
    Throws:
    
    AuthenticationException - if the Account is not an administrator.
  - isPermitted
```
public boolean isPermitted(String permission)
```
    Returns true if this Account is permitted to perform an action or access a resource summarized by the specified permission string.
    This is an overloaded method for the corresponding type-safe Permission variant. Please see the class-level JavaDoc for more information on these String-based permission methods.
    
    Parameters:
    
    permission - the String representation of a Permission that is being checked.
    
    Returns:
    
    true if this Account is permitted, false otherwise.
  - isPermitted
```
public boolean[] isPermitted(String... permissions)
```
    Checks if this Account implies the given permission strings and returns a boolean array indicating which permissions are implied.
    This is an overloaded method for the corresponding type-safe Permission variant. Please see the class-level JavaDoc for more information on these String-based permission methods.
    
    Parameters:
    
    permissions - the String representations of the Permissions that are being checked.
    
    Returns:
    
    a boolean array where indices correspond to the index of the permissions in the given list. A true value at an index indicates this Account is permitted for for the associated Permission string in the list. A false value at an index indicates otherwise.
  - isPermittedAll
```
public boolean isPermittedAll(String... permissions)
```
    Returns true if this Account implies all of the specified permission strings, false otherwise.
    This is an overloaded method for the corresponding type-safe Permission variant. Please see the class-level JavaDoc for more information on these String-based permission methods.
    
    Parameters:
    
    permissions - the String representations of the Permissions that are being checked.
    
    Returns:
    
    true if this Account has all of the specified permissions, false otherwise.
    
    Since:
    
    0.9
  - isPermittedAll
```
public boolean isPermittedAll(Collection<String> permissions)
```
    Returns true if this Account implies all of the specified permission strings, false otherwise.
    This is an overloaded method for the corresponding type-safe Permission variant. Please see the class-level JavaDoc for more information on these String-based permission methods.
    
    Parameters:
    
    permissions - the String representations of the Permissions that are being checked.
    
    Returns:
    
    true if this Account has all of the specified permissions, false otherwise.
    
    Since:
    
    0.9
  - checkPermission
```
public void checkPermission(String permission)
                     throws AuthorizationException
```
    Ensures this Account implies the specified permission String.
    If this Account's existing associated permissions do not Permission.implies(fathom.authz.Permission) imply} the given permission, an AuthorizationException will be thrown.
    This is an overloaded method for the corresponding type-safe Permission variant. Please see the class-level JavaDoc for more information on these String-based permission methods.
    
    Parameters:
    
    permission - the String representation of the Permission to check.
    
    Throws:
    
    AuthorizationException - if the user does not have the permission.
  - checkPermissions
```
public void checkPermissions(String... permissions)
                      throws AuthorizationException
```
    Ensures this Account implies all of the specified permission strings.
    If this Account's existing associated permissions do not imply all of the given permissions, an AuthorizationException will be thrown.
    This is an overloaded method for the corresponding type-safe Permission variant. Please see the class-level JavaDoc for more information on these String-based permission methods.
    
    Parameters:
    
    permissions - the string representations of Permissions to check.
    
    Throws:
    
    AuthorizationException - if this Account does not have all of the given permissions.
  - checkPermissions
```
public void checkPermissions(Collection<String> permissions)
                      throws AuthorizationException
```
    Ensures this Account implies all of the specified permission strings.
    If this Account's existing associated permissions do not imply all of the given permissions, an AuthorizationException will be thrown.
    This is an overloaded method for the corresponding type-safe Permission variant. Please see the class-level JavaDoc for more information on these String-based permission methods.
    
    Parameters:
    
    permissions - the string representations of Permissions to check.
    
    Throws:
    
    AuthorizationException - if this Account does not have all of the given permissions.
  - hasRole
```
public boolean hasRole(String roleIdentifier)
```
    Returns true if this Account has the specified role, false otherwise.
    
    Parameters:
    
    roleIdentifier - the application-specific role identifier (usually a role id or role name).
    
    Returns:
    
    true if this Account has the specified role, false otherwise.
  - hasRoles
```
public boolean hasRoles(String... roleIdentifiers)
```
    Returns true if this Account has the specified roles, false otherwise.
    
    Parameters:
    
    roleIdentifiers - the application-specific role identifiers to check (usually role ids or role names).
    
    Returns:
    
    true if this Account has all the specified roles, false otherwise.
  - hasRoles
```
public boolean hasRoles(Collection<String> roleIdentifiers)
```
    Returns true if this Account has the specified roles, false otherwise.
    
    Parameters:
    
    roleIdentifiers - the application-specific role identifiers to check (usually role ids or role names).
    
    Returns:
    
    true if this Account has all the specified roles, false otherwise.
  - checkRole
```
public void checkRole(String roleIdentifier)
               throws AuthorizationException
```
    Asserts this Account has the specified role by returning quietly if they do or throwing an AuthorizationException if they do not.
    
    Parameters:
    
    roleIdentifier - the application-specific role identifier (usually a role id or role name ).
    
    Throws:
    
    AuthorizationException - if this Account does not have the role.
  - checkRoles
```
public void checkRoles(String... roleIdentifiers)
                throws AuthorizationException
```
    Asserts this Account has all of the specified roles by returning quietly if they do or throwing an AuthorizationException if they do not.
    
    Parameters:
    
    roleIdentifiers - roleIdentifiers the application-specific role identifiers to check (usually role ids or role names).
    
    Throws:
    
    AuthorizationException - fathom.authz.AuthorizationException if this Account does not have all of the specified roles.
  - checkRoles
```
public void checkRoles(Collection<String> roleIdentifiers)
                throws AuthorizationException
```
    Asserts this Account has all of the specified roles by returning quietly if they do or throwing an AuthorizationException if they do not.
    
    Parameters:
    
    roleIdentifiers - roleIdentifiers the application-specific role identifiers to check (usually role ids or role names).
    
    Throws:
    
    AuthorizationException - fathom.authz.AuthorizationException if this Account does not have all of the specified roles.
  - hasToken
```
public boolean hasToken(String token)
```
    Returns true if this Account has the specified role, false otherwise.
    
    Parameters:
    
    token - the authentication token.
    
    Returns:
    
    true if this Account has the specified token, false otherwise.
  - checkToken
```
public void checkToken(String token)
                throws AuthorizationException
```
    Asserts this Account has the specified token by returning quietly if they do or throwing an AuthorizationException if they do not.
    
    Parameters:
    
    token - the authentication token.
    
    Throws:
    
    AuthorizationException - if this Account does not have the token.

Class Account

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

GUEST

credentials

authorizations

emailAddresses

tokens

name

isDisabled

Constructor Detail

Account

Account

Method Detail

getCredentials

getAuthorizations

getName

setName

getUsername

addEmailAddress

addEmailAddresses

addEmailAddresses

getEmailAddress

getEmailAddresses

addToken

addTokens

addTokens

getToken

getTokens

setDisabled

setEnabled

toString

isGuest

isAuthenticated

isAdministrator

isDisabled

isEnabled

checkGuest

checkAuthenticated

checkAdministrator

isPermitted

isPermitted

isPermittedAll

isPermittedAll

checkPermission

checkPermissions

checkPermissions

hasRole

hasRoles

hasRoles

checkRole

checkRoles

checkRoles

hasToken

checkToken