org.icatproject.authentication

Interface Authenticator

public interface Authenticator

An interface to be implemented by an ICAT authenticator plugin. An implementation might make use of the AddressChecker.

Method Summary

Methods

Modifier and Type	Method and Description
Authentication	authenticate(Map<String,String> credentials, String remoteAddr)

Method Detail

authenticate

Authentication authenticate(Map<String,String> credentials,
                          String remoteAddr)
                            throws IcatException

Parameters:

credentials - a map with keys such as username and password. The names and meanings of the keys is the responsibility of the implementor of this interface.

remoteAddr - a string representation of the numeric form of an IP4 or IP6 address. This may be used by the authenticator making use of the AddressChecker to determine the outcome.

Returns:

an Authentication object

Throws:

IcatException - of type IcatException.IcatExceptionType.SESSION if unable to authenticate.