com.cafesoft.core.message
Interface ConnectionAuthenticator

All Known Implementing Classes:

StandardConnectionAuthenticator

public interface ConnectionAuthenticator

Defines an API that allows for a pluggable authentication mechanism for authenticating connections for usage

Since:

4/8/02

Method Summary

AuthStatus

authenticate(String type, Object principal, Object credential, Map authParams, ConnectionMetaData metaData) Authenticate a Connection.

Method Detail

authenticate

public AuthStatus authenticate(String type,
                               Object principal,
                               Object credential,
                               Map authParams,
                               ConnectionMetaData metaData)
                        throws ConnectionAuthenticationException

Authenticate a Connection.

Parameters:

type - the type of authentication

principal - the principal of the connection

credential - the credential of the connection

authParams - contains aditional information for authentication

metaData - Meta-data about the connection attempting to authenticate

Returns:

an AuthStatus object that contains the result of the the authentication

Throws:

ConnectionAuthenticationException - thrown if there is an error trying to authenticate the connection