act.aaa

Class ActAAAService.Base<USER_TYPE>

java.lang.Object

act.util.LogSupport

act.util.DestroyableBase

act.util.SingletonBase

act.aaa.ActAAAService.Base<USER_TYPE>

All Implemented Interfaces:

ActAAAService, act.Destroyable, org.osgl.aaa.AuthenticationService

Enclosing interface:

ActAAAService

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

Nested Class Summary

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

ActAAAService.Base<USER_TYPE>

Nested classes/interfaces inherited from interface act.Destroyable

act.Destroyable.Util

Field Summary

Fields

Modifier and Type	Field and Description
protected org.osgl.logging.Logger	logger
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
ActAAAService.Base()
ActAAAService.Base(Class<USER_TYPE> userType)

Method Summary

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 name) Find a principal from data store by name.
protected USER_TYPE	findUser(String username)
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 serizlied 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 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.SingletonBase

instance

Methods inherited from class act.util.DestroyableBase

addSubResource, destroy, isDestroyed, releaseResources, reload, scope

Methods inherited from class act.util.LogSupport

debug, debug, error, error, fatal, fatal, info, info, isDebugEnabled, isTraceEnabled, trace, trace, warn, warn

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

logger

protected org.osgl.logging.Logger logger

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

ActAAAService.Base

public ActAAAService.Base()

ActAAAService.Base

public ActAAAService.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 name)

Find a principal from data store by name.

Specified by:

findByName in interface ActAAAService

Parameters:

name - the principal name (could be an email or username)

Returns:

the principal specified by the name

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

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 serizlied 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 USER_TYPE findUser(String username)

initUserType

protected void initUserType(Class<USER_TYPE> userType)

initUserDao

protected void initUserDao(Class<USER_TYPE> userType)