com.spotfire.server.security
Interface Authenticator

All Known Implementing Classes:

AbstractAuthenticator, JAASAuthenticator, JAASRegisteringAuthenticator

public interface Authenticator

An interface defining the methods that must be implemented by a class to which authentication duties can be delegated.

Since:

DSS 7.3

Method Summary

SecurityContext	authenticate(String userId, String password, AuthenticationContext authContext) Authenticates the user with the specified userId and password credentials.
void	setConfiguration(String configuration) Set authenticator configuration to be used when authenticating users.

Method Detail

setConfiguration

void setConfiguration(String configuration)
                      throws AuthenticatorException

Set authenticator configuration to be used when authenticating users. The semantics of the configuration argument is specific to the actual Authenticator implementation. E.g., it could be a configuration name, a filename or an option string.

Parameters:

configuration - configuration

Throws:

AuthenticatorException

authenticate

SecurityContext authenticate(String userId,
                             String password,
                             AuthenticationContext authContext)

Authenticates the user with the specified userId and password credentials. If the authentication is successful, the method returns a SecurityContext object. If the authentication fails, the method returns null.

The userId and password arguments may not be null.

The authContext argument can be used to perform additional authentication checks based on the client connection information provided in the argument. The authContext argument may be null, in which case no additional authentication checks should be performed.

Parameters:

userId - user id

password - password

authContext - authentication context

Returns:

a SecurityContext if the authentication is successful, null if it fails