com.exalead.security.sources.common

Class SecuritySource

java.lang.Object

com.exalead.security.sources.common.SecuritySource

All Implemented Interfaces:

CVComponent

Direct Known Subclasses:

DummySecuritySource

public abstract class SecuritySource
extends java.lang.Object
implements CVComponent

Security source. Handles user authentication and authorization. It allows you to verify the credentials of a given user and to retrieve user's security information. *

Constructor Summary

Constructors

Constructor and Description
SecuritySource()

Method Summary

Modifier and Type	Method and Description
abstract AuthenticationResult	authenticate(java.lang.String login, java.lang.String password, boolean needPassword) Authenticates a user and returns authorizations.
AuthenticationResult	authenticate(java.lang.String login, java.lang.String password, boolean needPassword, java.util.List<exa.bee.KeyValue> params) Authenticates a user and returns authorizations.
java.util.List<java.lang.String>	getGroups() Get the groups contained in this security source.
SecurityToken	getGroupToken(java.lang.String group) Get the security token of a group
java.util.List<exa.bee.KeyValue>	getInfo(java.util.List<exa.bee.KeyValue> params)
java.util.List<java.lang.String>	getUsers() Get the users contained in this security source.
SecurityToken	getUserToken(java.lang.String user) Get the security token of a user
void	init() Initialization function for this security source This can be used by security sources to initialize internal data
abstract void	reset() Restore the security source to its initial state.

Methods inherited from class java.lang.Object

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

Constructor Detail

SecuritySource

public SecuritySource()

Method Detail

authenticate

public abstract AuthenticationResult authenticate(java.lang.String login,
                                                  java.lang.String password,
                                                  boolean needPassword)
                                           throws SecurityException

Authenticates a user and returns authorizations.

Parameters:

login - the user login

password - the user password

needPassword - should the user password be checked

Returns:

authentication information about this user.

Throws:

SecurityException

authenticate

public AuthenticationResult authenticate(java.lang.String login,
                                         java.lang.String password,
                                         boolean needPassword,
                                         java.util.List<exa.bee.KeyValue> params)
                                  throws SecurityException

Authenticates a user and returns authorizations.

Parameters:

login - the user login

password - the user password

needPassword - should the user password be checked

params - custom parameters

Returns:

authentication information about this user.

Throws:

SecurityException

reset

public abstract void reset()
                    throws SecurityException

Restore the security source to its initial state.

Throws:

SecurityException

getInfo

public java.util.List<exa.bee.KeyValue> getInfo(java.util.List<exa.bee.KeyValue> params)
                                         throws SecurityException

Parameters:

params -

Returns:

Throws:

SecurityException

getUsers

public java.util.List<java.lang.String> getUsers()
                                          throws java.lang.Exception

Get the users contained in this security source.

Returns:

an enumeration of user identifiers

Throws:

java.lang.Exception

getGroups

public java.util.List<java.lang.String> getGroups()
                                           throws java.lang.Exception

Get the groups contained in this security source.

Returns:

an enumeration of group identifiers

Throws:

java.lang.Exception

getUserToken

public SecurityToken getUserToken(java.lang.String user)

Get the security token of a user

Returns:

a security token

getGroupToken

public SecurityToken getGroupToken(java.lang.String group)

Get the security token of a group

Returns:

a security token

init

public void init()

Initialization function for this security source This can be used by security sources to initialize internal data