org.eclipse.scada.sec.authn

Class AbstractPlainAuthenticationService

java.lang.Object

org.eclipse.scada.sec.authn.AbstractPlainAuthenticationService

All Implemented Interfaces:

AuthenticationService

Direct Known Subclasses:

AuthenticationServiceImpl, PropertyAuthenticationService

public abstract class AbstractPlainAuthenticationService
extends Object
implements AuthenticationService

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractPlainAuthenticationService.UserEntry

Constructor Summary

Constructors

Constructor and Description
AbstractPlainAuthenticationService()

Method Summary

Modifier and Type	Method and Description
UserInformation	authenticate(CredentialsRequest credentialsRequest) Authenticate a user based on credentials
UserInformation	getUser(String user) The the user information of the named user
protected abstract AbstractPlainAuthenticationService.UserEntry	getUserEntry(String name)
void	joinRequest(CredentialsRequest request)
protected UserInformation	makeInfo(String name, AbstractPlainAuthenticationService.UserEntry user)

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractPlainAuthenticationService

public AbstractPlainAuthenticationService()

Method Detail

getUserEntry

protected abstract AbstractPlainAuthenticationService.UserEntry getUserEntry(String name)
                                                                      throws Exception

Throws:

Exception

getUser

public UserInformation getUser(String user)

Description copied from interface: AuthenticationService

The the user information of the named user

Specified by:

getUser in interface AuthenticationService

Parameters:

user - the user to get the information for

Returns:

the user information or null if the user is unknown

authenticate

public UserInformation authenticate(CredentialsRequest credentialsRequest)
                             throws AuthenticationException

Description copied from interface: AuthenticationService

Authenticate a user based on credentials

Specified by:

authenticate in interface AuthenticationService

Returns:

a valid user information instance if the user is a known user and is allowed to log on using the provided credentials. Or null if it is a valid anonymous login.

Throws:

AuthenticationException - in the case the login is invalid (e.g. username and password don't match)

joinRequest

public void joinRequest(CredentialsRequest request)

Specified by:

joinRequest in interface AuthenticationService

makeInfo

protected UserInformation makeInfo(String name,
                                   AbstractPlainAuthenticationService.UserEntry user)