com.acciente.oacc

Interface AuthenticationProvider

All Known Implementing Classes:

SQLPasswordAuthenticationProvider

public interface AuthenticationProvider

Provides the mechanism to authenticate a resource based on specified credentials and to update those credentials.

An application can provide an implementation of this interface to provide a custom authentication mechanism for resources. Such a custom authentication provider is free to use password, biometric or any other means for authentication.

Method Summary

Methods

Modifier and Type	Method and Description
Resource	authenticate(Credentials credentials) Authenticates the specified resource using the supplied credentials.
void	authenticate(Resource resource) Verifies that the specified resource is authenticated.
void	authenticate(Resource resource, Credentials credentials) Authenticates the specified resource using the supplied credentials.
void	deleteCredentials(Resource resource) Removes the authentication credentials of the specified resource.
void	setCredentials(Resource resource, Credentials credentials) Sets (or resets) the authentication credentials of the specified resource.
void	validateCredentials(String resourceClassName, String domainName, Credentials credentials) Checks if the the authentication credentials are valid for the specified resource class and domain.

Method Detail

authenticate

void authenticate(Resource resource,
                Credentials credentials)

Authenticates the specified resource using the supplied credentials.

Parameters:

resource - the resource to be authenticated

credentials - the credentials to authenticate the resource

Throws:

IncorrectCredentialsException - if authentication failed due to incorrect credentials

authenticate

void authenticate(Resource resource)

Verifies that the specified resource is authenticated.

The authentication provider implementation should throw a NotAuthenticatedException if the specified resource is currently NOT authenticated, or should throw an UnsupportedOperationException if it does not support reporting of the authentication status without credentials.

Parameters:

resource - the resource to be authenticated

authenticate

Resource authenticate(Credentials credentials)

Authenticates the specified resource using the supplied credentials.

This authentication method requires a custom authentication provider and is not supported by the built-in authentication provider. It is intended for use where the resource identification is embedded in the credentials, such as in authentication protocols using encrypted authentication tokens. When using this method the custom authentication provider must return the resource to OACC from the custom authentication provider implementation.

Parameters:

credentials - the credentials to authenticate the resource

Throws:

IncorrectCredentialsException - if authentication failed due to incorrect credentials

validateCredentials

void validateCredentials(String resourceClassName,
                       String domainName,
                       Credentials credentials)

Checks if the the authentication credentials are valid for the specified resource class and domain.

This method may check if the credentials satisfy the minimum strength requirements, for example.

Parameters:

resourceClassName - the resource class for which to validate the specified credentials

domainName - the domain for which to validate the specified credentials

credentials - the authentication credentials to validate

Throws:

InvalidCredentialsException - if the credentials are invalid

setCredentials

void setCredentials(Resource resource,
                  Credentials credentials)

Sets (or resets) the authentication credentials of the specified resource.

Parameters:

resource - the resource for which the credentials should be set

credentials - the new authentication credentials for the resource

deleteCredentials

void deleteCredentials(Resource resource)

Removes the authentication credentials of the specified resource.

Parameters:

resource - the resource for which the credentials should be removed