com.google.enterprise.connector.spi

Interface AuthenticationManager

public interface AuthenticationManager

Authentication Manager. All calls for end-user query authentication pass through this interface.

Since:

1.0

Method Summary

Modifier and Type	Method and Description
AuthenticationResponse	authenticate(AuthenticationIdentity identity) Authenticates against the repository and returns an AuthenticationResponse indicating whether authentication was successful.

Method Detail

authenticate

AuthenticationResponse authenticate(AuthenticationIdentity identity)
                             throws RepositoryLoginException,
                                    RepositoryException

Authenticates against the repository and returns an AuthenticationResponse indicating whether authentication was successful. If the authentication was successful, the connector may return a Collection of group names representing any groups for which the user is a member. If the password supplied in the AuthenticationIdentity is null, the connector may skip authentication, but still return a valid AuthenticationResponse containing a Collection of group names representing any groups for which the user is a member. If an exception is thrown, the implementor should provide an explanatory message.

Parameters:

identity - an AuthenticationIdentity object that encapsulates the user's identity

Returns:

an AuthenticationResponse indicating whether authentication was successful, or if the identity password was null, the Collection of groups to which the user belongs

Throws:

RepositoryLoginException - if there is a credentials-related problem that prohibits authentication

RepositoryException - if there is a more general problem, such as the system is unreachable or down