com.eibus.security.authentication

Interface Authenticator

public interface Authenticator

The Autenticator interface. This interface is implemented for authentication of Identities in the Cordys platform. The open and close methods can be used to implement elements that have the lifetime of the full Autenticator implementation. (Via the AuthenticatorFactory a specific implementation is loaded). The authenticate method does the actual authentication for the credentials.

See Also:

Credentials

Method Summary

Methods

Modifier and Type	Method and Description
boolean	authenticate(Credentials credentials) Authenticate the credentials with the implementation.
void	close() Close the implementation of the Authenticator
void	open(java.util.Properties props) Open the implementation of the Authenticator with properties.

Method Detail

open

void open(java.util.Properties props)
          throws com.eibus.security.authentication.InvalidAuthenticatorException

Open the implementation of the Authenticator with properties. It depends on the implementation what properties are expected.

Parameters:

props - The properties used for opening.

Throws:

InvalidAuthenticatorException

authenticate

boolean authenticate(Credentials credentials)
                     throws com.eibus.security.identity.InvalidCredentialsException,
                            com.eibus.security.authentication.AuthenticationException

Authenticate the credentials with the implementation. Credentials are authentication type specific. It is advised to check wether the implementation understands the credentials given (Use instanceof in order to check the type)

Parameters:

credentials - given credentials to authenticate.

Returns:

true when the authentication credentials are valid, false when the credentials are not valid

Throws:

com.eibus.security.identity.InvalidCredentialsException

AuthenticationException

See Also:

Credentials

close

void close()

Close the implementation of the Authenticator