ActAAAService.Base (ACT AAA Plugin 1.6.1 API)

java.lang.Object
- act.util.LogSupport
- - act.aaa.ActAAAService.Base<USER_TYPE>

All Implemented Interfaces:

ActAAAService, org.osgl.aaa.AuthenticationService

Direct Known Subclasses:

AAAAdaptor

Enclosing interface:

ActAAAService
```
public abstract static class ActAAAService.Base<USER_TYPE>
extends act.util.LogSupport
implements ActAAAService
```

Nested Class Summary
- Nested classes/interfaces inherited from interface act.aaa.ActAAAService
  ActAAAService.Base<USER_TYPE>

Field Summary

Fields
Modifier and Type Field and Description

protected act.db.Dao<?,USER_TYPE,?> userDao
The user model DAO class

protected Class<USER_TYPE> userType
The user model class
- Fields inherited from class act.util.LogSupport
  DASHED_LINE, DOUBLE_DASHED_LINE, HASH_SYMBOL_LINE, logger, STAR_LINE, TILD_LINE

Fields
Modifier and Type	Field and Description
`protected act.db.Dao<?,USER_TYPE,?>`	`userDao` The user model DAO class
`protected Class<USER_TYPE>`	`userType` The user model class

Constructor Summary

Constructors
Constructor and Description

Base()

Base(Class<USER_TYPE> userType)

Constructors
Constructor and Description
`Base()`
`Base(Class<USER_TYPE> userType)`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`org.osgl.aaa.Principal`	`authenticate(String username, char[] password)` Authenticate a username against a password, return a `Principal` instance if authenticated, or `null` if failed to authenticate.
`org.osgl.aaa.Principal`	`authenticate(String username, String password)` Authenticate a username against a password, return a `Principal` instance if authenticated, or `null` if failed to authenticate.
`org.osgl.aaa.Principal`	`findByName(String identifier)` Find a principal from data store by user identifier.
`protected USER_TYPE`	`findUser(String identifier)`
`protected USER_TYPE`	`findUser(String key, String value)` Sub class can overwrite this method to return a User entity by field name and field value.
`protected void`	`initUserDao(Class<USER_TYPE> userType)`
`protected void`	`initUserType(Class<USER_TYPE> userType)`
`protected String`	`nameOf(USER_TYPE user)` Deprecated.
`protected Set<String>`	`permissionsOf(USER_TYPE user)` Returns direct permission names of specified user
`protected org.osgl.aaa.Principal`	`principalOf(USER_TYPE user)` Get `Principal` instance from a user instance.
`protected Integer`	`privilegeOf(USER_TYPE user)` Returns the privilege level of a user.
`void`	`removeAllPrincipals()` Remove all principals from data store.
`protected Set<String>`	`rolesOf(USER_TYPE user)` Returns role names of specified user
`void`	`save(org.osgl.aaa.Principal principal)` Save an new principal into data store
`protected void`	`setPrincipalProperties(org.osgl.aaa.Principal principal, USER_TYPE user)` Sub class can overwrite this method to store any user data (can be serialised to a String) into principal’s property.
`protected String`	`userKey()` Return the key name used to find out the user entity from data store.
`protected String`	`username(USER_TYPE user)` Get username of the user passed in.
`protected String`	`usernameField()` Return the username field name used to find out the user entity from data store.
`protected abstract boolean`	`verifyPassword(USER_TYPE user, char[] password)` Sub class must overwrite this method to implement password verification logic.

Methods inherited from class act.util.LogSupport
debug, debug, error, error, fatal, fatal, info, info, isDebugEnabled, isTraceEnabled, printCenter, printCenterWithLead, printDashedLine, printDoubleDashedLine, printHashSimbolLine, println, printStarLine, printTildLine, trace, trace, warn, warn

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

- Field Detail
  - userType
```
protected Class<USER_TYPE> userType
```
    The user model class
  - userDao
```
protected act.db.Dao<?,USER_TYPE,?> userDao
```
    The user model DAO class
- Constructor Detail
  - Base
```
public Base()
```
  - Base
```
public Base(Class<USER_TYPE> userType)
```
- Method Detail
  - save
```
public void save(org.osgl.aaa.Principal principal)
```
    Save an new principal into data store
    
    Called when there are principals defined in the _act.yml file
    
    The default implementation is to throw out UnsupportedException
    
    Specified by:
    
    save in interface ActAAAService
    
    Parameters:
    
    principal - the principal instance defined in _act.yml file
  - removeAllPrincipals
```
public void removeAllPrincipals()
```
    Remove all principals from data store.
    
    Called when loading yaml content and the aaa.ddl.delete configuration is enabled.
    
    The default implementation is to throw out UnsupportedException
    
    Specified by:
    
    removeAllPrincipals in interface ActAAAService
  - findByName
```
public org.osgl.aaa.Principal findByName(String identifier)
```
    Find a principal from data store by user identifier.
    
    Specified by:
    
    findByName in interface ActAAAService
    
    Parameters:
    
    identifier - the user identifier, could be id, username, email, depends on how AAAConfig.user.key is configured.
    
    Returns:
    
    the principal specified by the identifier
  - authenticate
```
public org.osgl.aaa.Principal authenticate(String username,
                                           String password)
```
    Authenticate a username against a password, return a Principal instance if authenticated, or null if failed to authenticate.
    
    Sub class can (but not required to) overwrite this method
    
    Specified by:
    
    authenticate in interface org.osgl.aaa.AuthenticationService
    
    Parameters:
    
    username - the username
    
    password - the password
    
    Returns:
    
    the principal matches the username/password pair or null if failed to authenticate
  - authenticate
```
public org.osgl.aaa.Principal authenticate(String username,
                                           char[] password)
```
    Authenticate a username against a password, return a Principal instance if authenticated, or null if failed to authenticate.
    
    Sub class can (but not required to) overwrite this method
    
    Specified by:
    
    authenticate in interface org.osgl.aaa.AuthenticationService
    
    Parameters:
    
    username - the username
    
    password - the password
    
    Returns:
    
    the principal matches the username/password pair or null if failed to authenticate
  - userKey
```
protected String userKey()
```
    Return the key name used to find out the user entity from data store.
    
    The default implementation returns null, meaning AAA will use the aaa.user.key configuration as the userKey
    
    Returns:
    
    the key name to get the user from data store
  - usernameField
```
protected String usernameField()
```
    Return the username field name used to find out the user entity from data store.
    
    The default implementation returns null, meaning AAA will use the aaa.user.username configuration as the usernameField
    
    Returns:
    
    the username field name to get the user from data store
  - principalOf
```
protected org.osgl.aaa.Principal principalOf(USER_TYPE user)
```
    Get Principal instance from a user instance.
    
    Parameters:
    
    user - the user instance
    
    Returns:
    
    the principal instance
  - username
```
protected String username(USER_TYPE user)
```
    Get username of the user passed in.
    
    This method will use reflection to find the username by _userKey(). However sub class can overwrite this method to provide fast implementation
    
    Parameters:
    
    user - the user instance
    
    Returns:
    
    the username of the user
  - nameOf
```
@Deprecated
protected String nameOf(USER_TYPE user)
```
    Deprecated.
    
    Get username of the user passed in
    
    This method is deprecated. Please use username(Object) instead
    
    Parameters:
    
    user - the user instance
    
    Returns:
    
    the username of the user
  - privilegeOf
```
protected Integer privilegeOf(USER_TYPE user)
```
    Returns the privilege level of a user.
    
    If not overwritten by sub class, this method will return null, meaning there is no privilege granted to the user
    
    Parameters:
    
    user - the user instance
    
    Returns:
    
    the privilege level
  - rolesOf
```
protected Set<String> rolesOf(USER_TYPE user)
```
    Returns role names of specified user
    
    If not overwritten by sub class, this method returns an empty set
    
    Parameters:
    
    user - the user instance
    
    Returns:
    
    name of roles granted to the user
  - permissionsOf
```
protected Set<String> permissionsOf(USER_TYPE user)
```
    Returns direct permission names of specified user
    
    If not overwritten by sub class, this method returns an empty set. If sub class overwrite this method, it shall not return permissions inferred by roles
    
    Parameters:
    
    user - the user instance
    
    Returns:
    
    name of roles granted to the user
  - setPrincipalProperties
```
protected void setPrincipalProperties(org.osgl.aaa.Principal principal,
                                      USER_TYPE user)
```
    Sub class can overwrite this method to store any user data (can be serialised to a String) into principal’s property. For example user’s account ID
    
    Default implementation is empty
    
    Parameters:
    
    principal - the principal instance
    
    user - the user instance
  - verifyPassword
```
protected abstract boolean verifyPassword(USER_TYPE user,
                                          char[] password)
```
    Sub class must overwrite this method to implement password verification logic.
    
    Normally it should be something like:
```
return Act.crypto().verifyPassword(password, user.getPassword());
```
    Parameters:
    
    user - the user instance
    
    password - password supplied
    
    Returns:
    
    true if password matches or false otherwise
  - findUser
```
protected final USER_TYPE findUser(String identifier)
```
  - findUser
```
protected USER_TYPE findUser(String key,
                             String value)
```
    Sub class can overwrite this method to return a User entity by field name and field value.
    
    Parameters:
    
    key - the field name, e.g. “email” or “username” etc
    
    value - the field value
    
    Returns:
    
    A user entity
  - initUserType
```
protected void initUserType(Class<USER_TYPE> userType)
```
  - initUserDao
```
protected void initUserDao(Class<USER_TYPE> userType)
```

Class ActAAAService.Base<USER_TYPE>

Nested Class Summary

Nested classes/interfaces inherited from interface act.aaa.ActAAAService

Field Summary

Fields inherited from class act.util.LogSupport

Constructor Summary

Method Summary

Methods inherited from class act.util.LogSupport

Methods inherited from class java.lang.Object

Field Detail

userType

userDao

Constructor Detail

Base

Base

Method Detail

save

removeAllPrincipals

findByName

authenticate

authenticate

userKey

usernameField

principalOf

username

nameOf

privilegeOf

rolesOf

permissionsOf

setPrincipalProperties

verifyPassword

findUser

findUser

initUserType

initUserDao