A C D E F G H I L M N P R S T V W

A

Account - Class in fathom.realm

Account represents Credentials and Authorizations.

Account(String, Credentials) - Constructor for class fathom.realm.Account

Account(String, Credentials, Authorizations) - Constructor for class fathom.realm.Account

addAccount(String, String) - Method in class fathom.realm.MemoryRealm

addAccount(String, String, String) - Method in class fathom.realm.MemoryRealm

addAccount(Account) - Method in class fathom.realm.MemoryRealm

addEmailAddress(String) - Method in class fathom.realm.Account

addEmailAddresses(String...) - Method in class fathom.realm.Account

addEmailAddresses(Collection<String>) - Method in class fathom.realm.Account

addPermission(String) - Method in class fathom.authz.Authorizations

Adds (assigns) a permission to those directly associated with the Account.

addPermission(String) - Method in class fathom.authz.Role

addPermission(Permission) - Method in class fathom.authz.Role

addPermissions(String...) - Method in class fathom.authz.Authorizations

Adds (assigns) a permission to those directly associated with the Account.

addPermissions(Collection<Permission>) - Method in class fathom.authz.Authorizations

Adds (assigns) a permission to those directly associated with the Account.

addPermissions(String...) - Method in class fathom.authz.Role

addPermissions(Collection<Permission>) - Method in class fathom.authz.Role

addRole(String) - Method in class fathom.authz.Authorizations

Adds (assigns) multiple roles to those associated with the Account.

addRole(Role) - Method in class fathom.authz.Authorizations

Adds (assigns) multiple roles to those associated with the Account.

addRoles(String...) - Method in class fathom.authz.Authorizations

Adds roles to the Account Authorizations.

addRoles(Collection<Role>) - Method in class fathom.authz.Authorizations

Adds (assigns) multiple roles to those associated with the Account.

addToken(String) - Method in class fathom.realm.Account

addTokens(String...) - Method in class fathom.realm.Account

addTokens(Collection<String>) - Method in class fathom.realm.Account

aggregatePermissions - Variable in class fathom.authz.Authorizations

authenticate(AuthenticationToken) - Method in class fathom.realm.FileRealm

Force a re-read of the credentials file (if modified) before executing authentication.

authenticate(AuthenticationToken) - Method in class fathom.realm.MemoryRealm

authenticate(String, String) - Method in class fathom.realm.MemoryRealm

authenticate(AuthenticationToken) - Method in interface fathom.realm.Realm

authenticate(String, String) - Method in class fathom.realm.StandardCredentialsRealm

authenticate(AuthenticationToken) - Method in class fathom.realm.StandardCredentialsRealm

authenticate(StandardCredentials) - Method in class fathom.realm.StandardCredentialsRealm

authenticate(AuthenticationToken) - Method in class fathom.security.SecurityManager

Tries to authenticate an AuthenticationToken.

authenticateToken(TokenCredentials) - Method in class fathom.realm.MemoryRealm

AuthenticationException - Exception in fathom.authc

AuthenticationException(String, Object...) - Constructor for exception fathom.authc.AuthenticationException

AuthenticationToken - Interface in fathom.authc

An interface that identifies a client token for authentication.

AuthorizationException - Exception in fathom.authz

AuthorizationException(String, Object...) - Constructor for exception fathom.authz.AuthorizationException

Authorizations - Class in fathom.authz

Authorizations represents an Account's Roles & Permissions.

Authorizations() - Constructor for class fathom.authz.Authorizations

Authorizations(Set<String>) - Constructor for class fathom.authz.Authorizations

Creates a new instance with the specified roles and no permissions.

Authorizations(Set<Role>, Set<Permission>) - Constructor for class fathom.authz.Authorizations

Creates a new instance with the specified Roles and Permissions.

authorizations - Variable in class fathom.realm.Account

C

cacheAccount(Account) - Method in class fathom.realm.CachingRealm

CachingRealm - Class in fathom.realm

A CachingRealm maintains an expiring Guava Cache of Accounts.

CachingRealm() - Constructor for class fathom.realm.CachingRealm

canAuthenticate(AuthenticationToken) - Method in class fathom.realm.MemoryRealm

canAuthenticate(AuthenticationToken) - Method in interface fathom.realm.Realm

canAuthenticate(AuthenticationToken) - Method in class fathom.realm.StandardCredentialsRealm

check(AuthenticationToken) - Method in class fathom.security.SecurityManager

Tries to authenticate an AuthenticationToken.

checkAdministrator() - Method in class fathom.realm.Account

Ensures this Account is an administrator.

checkAuthenticated() - Method in class fathom.realm.Account

Ensures this Account has actively authenticated.

checkGuest() - Method in class fathom.realm.Account

Ensures this Account is the Guest account.

checkPermission(String) - Method in class fathom.realm.Account

Ensures this Account implies the specified permission String.

checkPermissions(String...) - Method in class fathom.realm.Account

Ensures this Account implies all of the specified permission strings.

checkPermissions(Collection<String>) - Method in class fathom.realm.Account

Ensures this Account implies all of the specified permission strings.

checkRole(String) - Method in class fathom.realm.Account

Asserts this Account has the specified role by returning quietly if they do or throwing an AuthorizationException if they do not.

checkRoles(String...) - Method in class fathom.realm.Account

Asserts this Account has all of the specified roles by returning quietly if they do or throwing an AuthorizationException if they do not.

checkRoles(Collection<String>) - Method in class fathom.realm.Account

Asserts this Account has all of the specified roles by returning quietly if they do or throwing an AuthorizationException if they do not.

checkToken(String) - Method in class fathom.realm.Account

Asserts this Account has the specified token by returning quietly if they do or throwing an AuthorizationException if they do not.

clearCache() - Method in class fathom.realm.CachingRealm

Clears this Realm's account cache.

clearCache() - Method in class fathom.security.SecurityManager

Clears the SecurityManager account cache and any CachingRealm's cache.

clone() - Method in class fathom.authz.Authorizations

Credentials - Interface in fathom.authc

credentials - Variable in class fathom.realm.Account

D

DEFAULT_CASE_SENSITIVE - Static variable in class fathom.authz.Permission

DomainPermission - Class in fathom.authz

Provides a base Permission class from which type-safe/domain-specific subclasses may extend.

DomainPermission() - Constructor for class fathom.authz.DomainPermission

Creates a domain permission with *all* actions for *all* targets;

DomainPermission(String) - Constructor for class fathom.authz.DomainPermission

DomainPermission(String, String) - Constructor for class fathom.authz.DomainPermission

DomainPermission(Set<String>, Set<String>) - Constructor for class fathom.authz.DomainPermission

E

emailAddresses - Variable in class fathom.realm.Account

equals(Object) - Method in class fathom.authc.StandardCredentials

equals(Object) - Method in class fathom.authc.TokenCredentials

equals(Object) - Method in class fathom.authz.Permission

equals(Object) - Method in class fathom.authz.Role

F

fathom.authc - package fathom.authc

fathom.authz - package fathom.authz

fathom.realm - package fathom.realm

fathom.security - package fathom.security

FileRealm - Class in fathom.realm

A FileRealm is a MemoryRealm that loads accounts and roles from an external file.

FileRealm() - Constructor for class fathom.realm.FileRealm

G

getAccount(String) - Method in class fathom.realm.CachingRealm

getAccount(String) - Method in class fathom.realm.MemoryRealm

getAccount(String) - Method in interface fathom.realm.Realm

getActions() - Method in class fathom.authz.DomainPermission

getAggregatePermissions() - Method in class fathom.authz.Authorizations

Gets the collection of permissions including the role permissions and discrete permissions.

getAuthorizations() - Method in class fathom.realm.Account

getCredentials() - Method in class fathom.realm.Account

getDomain(Class<? extends DomainPermission>) - Method in class fathom.authz.DomainPermission

getDomain() - Method in class fathom.authz.DomainPermission

getEmailAddress() - Method in class fathom.realm.Account

getEmailAddresses() - Method in class fathom.realm.Account

getName() - Method in class fathom.authz.Role

getName() - Method in class fathom.realm.Account

getParts() - Method in class fathom.authz.Permission

getPassword() - Method in class fathom.authc.StandardCredentials

getPermissions() - Method in class fathom.authz.Authorizations

Returns all type-safe Permissions assigned to the corresponding Account.

getPermissions() - Method in class fathom.authz.Role

getPreferredStartOrder() - Method in class fathom.security.SecurityManager

getRealmName() - Method in class fathom.realm.CachingRealm

getRealmName() - Method in class fathom.realm.MemoryRealm

getRealmName() - Method in interface fathom.realm.Realm

getRealms(Class<X>) - Method in class fathom.security.SecurityManager

getRoles() - Method in class fathom.authz.Authorizations

Returns the Roles assigned to the corresponding Account.

getTargets() - Method in class fathom.authz.DomainPermission

getToken() - Method in class fathom.authc.TokenCredentials

getToken() - Method in class fathom.realm.Account

getTokens() - Method in class fathom.realm.Account

getUsername() - Method in interface fathom.authc.Credentials

Returns the username of these credentials.

getUsername() - Method in class fathom.authc.StandardCredentials

getUsername() - Method in class fathom.realm.Account

GUEST - Static variable in class fathom.realm.Account

H

hasAccount(String) - Method in class fathom.realm.CachingRealm

hasAccount(String) - Method in class fathom.realm.MemoryRealm

hasAccount(String) - Method in interface fathom.realm.Realm

hashCode() - Method in class fathom.authc.StandardCredentials

hashCode() - Method in class fathom.authc.TokenCredentials

hashCode() - Method in class fathom.authz.Permission

hashCode() - Method in class fathom.authz.Role

hasRole(String) - Method in class fathom.authz.Authorizations

Returns true if this Account has the specified role, false otherwise.

hasRole(String) - Method in class fathom.realm.Account

Returns true if this Account has the specified role, false otherwise.

hasRoles(String...) - Method in class fathom.authz.Authorizations

Returns true if this Account has the specified roles, false otherwise.

hasRoles(Collection<String>) - Method in class fathom.authz.Authorizations

Returns true if this Account has the specified roles, false otherwise.

hasRoles(String...) - Method in class fathom.realm.Account

Returns true if this Account has the specified roles, false otherwise.

hasRoles(Collection<String>) - Method in class fathom.realm.Account

Returns true if this Account has the specified roles, false otherwise.

hasToken(String) - Method in class fathom.realm.Account

Returns true if this Account has the specified role, false otherwise.

I

implies(Permission) - Method in class fathom.authz.Permission

Returns true if this current instance implies all the functionality and/or resource access described by the specified Permission argument, false otherwise.

isAdministrator() - Method in class fathom.realm.Account

Returns true if this Account is an administrator.

isAuthenticated() - Method in class fathom.realm.Account

Returns true if this Account is authenticated.

isDisabled - Variable in class fathom.realm.Account

isDisabled() - Method in class fathom.realm.Account

Returns true if this Account is disabled.

isEnabled() - Method in class fathom.realm.Account

Returns true if this Account is enabled.

isGuest() - Method in class fathom.realm.Account

Returns true if this Account is the GUEST account.

isPermitted(String) - Method in class fathom.authz.Authorizations

Returns true if this Account is permitted to perform an action or access a resource summarized by the specified permission string.

isPermitted(String...) - Method in class fathom.authz.Authorizations

Checks if this Account implies the given permission strings and returns a boolean array indicating which permissions are implied.

isPermitted(Permission) - Method in class fathom.authz.Authorizations

isPermitted(String) - Method in class fathom.authz.Role

isPermitted(Permission) - Method in class fathom.authz.Role

isPermitted(String) - Method in class fathom.realm.Account

Returns true if this Account is permitted to perform an action or access a resource summarized by the specified permission string.

isPermitted(String...) - Method in class fathom.realm.Account

Checks if this Account implies the given permission strings and returns a boolean array indicating which permissions are implied.

isPermittedAll(String...) - Method in class fathom.authz.Authorizations

Returns true if this Account implies all of the specified permission strings, false otherwise.

isPermittedAll(Collection<String>) - Method in class fathom.authz.Authorizations

Returns true if this Account implies all of the specified permission strings, false otherwise.

isPermittedAll(String...) - Method in class fathom.realm.Account

Returns true if this Account implies all of the specified permission strings, false otherwise.

isPermittedAll(Collection<String>) - Method in class fathom.realm.Account

Returns true if this Account implies all of the specified permission strings, false otherwise.

isRunning() - Method in class fathom.security.SecurityManager

L

logCacheSettings(Logger) - Method in class fathom.realm.CachingRealm

M

MemoryRealm - Class in fathom.realm

A MemoryRealm caches all accounts in a ConcurrentHashMap.

MemoryRealm() - Constructor for class fathom.realm.MemoryRealm

N

name - Variable in class fathom.authz.Role

name - Variable in class fathom.realm.Account

P

parseAccount(Config) - Method in class fathom.realm.MemoryRealm

parseDefinedRealms(Config) - Method in class fathom.security.SecurityManager

Parse the Realms from the Config object.

parseDefinedRoles(Config) - Method in class fathom.realm.MemoryRealm

Parse the Roles specified in the Config object.

PART_DIVIDER_TOKEN - Static variable in class fathom.authz.Permission

Permission - Class in fathom.authz

A WildcardPermission is a very flexible permission construct supporting multiple levels of permission matching.

Permission() - Constructor for class fathom.authz.Permission

Default no-arg constructor for subclasses only - end-user developers instantiating Permission instances must provide a wildcard string at a minimum, since Permission instances are immutable once instantiated.

Permission(String) - Constructor for class fathom.authz.Permission

Permission(String, boolean) - Constructor for class fathom.authz.Permission

permissions - Variable in class fathom.authz.Authorizations

permissions - Variable in class fathom.authz.Role

R

readFile() - Method in class fathom.realm.FileRealm

Reads the realm file and rebuilds the in-memory lookup tables.

Realm - Interface in fathom.realm

Interface the defines a Realm.

removeAccount(String) - Method in class fathom.realm.MemoryRealm

Role - Class in fathom.authz

A simple representation of a security role that has a name and a collection of permissions.

Role(String) - Constructor for class fathom.authz.Role

Role(String, String...) - Constructor for class fathom.authz.Role

Role(String, Set<Permission>) - Constructor for class fathom.authz.Role

roles - Variable in class fathom.authz.Authorizations

S

sanitize() - Method in interface fathom.authc.Credentials

Creates a sanitized clone without any sensitive information.

sanitize() - Method in class fathom.authc.StandardCredentials

SecurityManager - Class in fathom.security

SecurityManager manages the Realms and handles authentication.

SecurityManager() - Constructor for class fathom.security.SecurityManager

SecurityModule - Class in fathom.security

Security Module.

SecurityModule() - Constructor for class fathom.security.SecurityModule

setActions(Set<String>) - Method in class fathom.authz.DomainPermission

setDisabled() - Method in class fathom.realm.Account

Disables this account.

setDomain(String) - Method in class fathom.authz.DomainPermission

setEnabled() - Method in class fathom.realm.Account

Enables this account.

setFile(File) - Method in class fathom.realm.FileRealm

setName(String) - Method in class fathom.realm.Account

setParts(String, Set<String>, Set<String>) - Method in class fathom.authz.DomainPermission

setParts(String, boolean) - Method in class fathom.authz.Permission

setParts(String) - Method in class fathom.authz.Permission

setPermissions(Collection<Permission>) - Method in class fathom.authz.Authorizations

Sets the string-based permissions assigned directly to the Account.

setPermissions(Set<Permission>) - Method in class fathom.authz.Role

setRoles(Set<Role>) - Method in class fathom.authz.Authorizations

Sets the roles assigned to the Account.

setTargets(Set<String>) - Method in class fathom.authz.DomainPermission

setup(Config) - Method in class fathom.realm.CachingRealm

setup(Config) - Method in class fathom.realm.FileRealm

setup(Config) - Method in class fathom.realm.MemoryRealm

setup(Config) - Method in interface fathom.realm.Realm

setup() - Method in class fathom.security.SecurityModule

StandardCredentials - Class in fathom.authc

Represents standard username/password credentials.

StandardCredentials(String, String) - Constructor for class fathom.authc.StandardCredentials

StandardCredentialsRealm - Class in fathom.realm

Parent class for StandardCredentials realms.

StandardCredentialsRealm() - Constructor for class fathom.realm.StandardCredentialsRealm

start() - Method in class fathom.realm.FileRealm

start() - Method in class fathom.realm.MemoryRealm

start() - Method in interface fathom.realm.Realm

start() - Method in class fathom.security.SecurityManager

stop() - Method in class fathom.realm.MemoryRealm

stop() - Method in interface fathom.realm.Realm

stop() - Method in class fathom.security.SecurityManager

SUBPART_DIVIDER_TOKEN - Static variable in class fathom.authz.Permission

T

TokenCredentials - Class in fathom.authc

Represents token credentials.

TokenCredentials(String) - Constructor for class fathom.authc.TokenCredentials

tokens - Variable in class fathom.realm.Account

toString() - Method in class fathom.authc.StandardCredentials

toString() - Method in class fathom.authc.TokenCredentials

toString() - Method in class fathom.authz.Permission

toString() - Method in class fathom.authz.Role

toString() - Method in class fathom.realm.Account

toString() - Method in class fathom.realm.StandardCredentialsRealm

V

validatePassword(StandardCredentials, StandardCredentials) - Method in class fathom.realm.StandardCredentialsRealm

Validate a password.

W

WILDCARD_TOKEN - Static variable in class fathom.authz.Permission

A C D E F G H I L M N P R S T V W