org.eclipse.scada.sec

Interface AuthenticationService

All Known Implementing Classes:

AbstractPlainAuthenticationService, DummyAuthenticationProviderImpl, PropertyAuthenticationService

public interface AuthenticationService

An interface for a service that authenticates a user.

The service needs to ensure that the information provided identifies a valid user.

Since:

0.15.0

Method Summary

Methods

Modifier and Type	Method and Description
UserInformation	authenticate(CredentialsRequest request) Authenticate a user based on credentials
UserInformation	getUser(java.lang.String user) The the user information of the named user
void	joinRequest(CredentialsRequest request)

Method Detail

authenticate

UserInformation authenticate(CredentialsRequest request)
                             throws AuthenticationException

Authenticate a user based on credentials

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

void joinRequest(CredentialsRequest request)

Since:

1.1

getUser

UserInformation getUser(java.lang.String user)

The the user information of the named user

Parameters:

user - the user to get the information for

Returns:

the user information or null if the user is unknown

Since:

1.1