org.wso2.broker.auth.authentication.authenticator

Interface Authenticator

All Known Implementing Classes:

DefaultAuthenticator, JaasAuthenticator

public interface Authenticator

Interface represents the authenticator. This provides ability to extend different authentication strategies for broker auth.

authenticate(String, char[]) is used to authenticate user on given username and credentials.

Method Summary

Modifier and Type	Method and Description
boolean	authenticate(String username, char[] credentials) Authenticate given user based on defined authentication strategy.
void	initialize(org.wso2.broker.common.StartupContext startupContext) Initiate authenticator with startup context.

Method Detail

initialize

void initialize(org.wso2.broker.common.StartupContext startupContext)
         throws Exception

Initiate authenticator with startup context.

Parameters:

startupContext - the startup context provides registered services for authenticator functionality.

Throws:

Exception

authenticate

boolean authenticate(String username,
                     char[] credentials)
              throws BrokerAuthException

Authenticate given user based on defined authentication strategy.

Parameters:

username - an username

credentials - the credentials of the user

Returns:

authentication result with user information

Throws:

BrokerAuthException - if error occurred while authenticating user.