net.krotscheck.kangaroo.authz.common.authenticator

Interface IAuthenticator

All Known Implementing Classes:

AbstractOAuth2Authenticator, FacebookAuthenticator, GoogleAuthenticator, PasswordAuthenticator, TestAuthenticator

public interface IAuthenticator

This interface describes the methods used during user authentication, responsible for interfacing with a third party authentication provider. All authentication MUST be performed via redirect.

Author:

Michael Krotscheck

Method Summary

Modifier and Type	Method and Description
UserIdentity	authenticate(Authenticator authenticator, javax.ws.rs.core.MultivaluedMap<String,String> parameters, URI callback) Authenticate and/or create a user identity for a specific client, given the URI from an authentication delegate.
javax.ws.rs.core.Response	delegate(Authenticator configuration, URI callback) Delegate an authentication request to a third party authentication provider, such as Google, Facebook, etc.
default void	validate(Authenticator authenticator) Validate that a particular authentication configuration is valid for this IdP.

Method Detail

delegate

javax.ws.rs.core.Response delegate(Authenticator configuration,
                                   URI callback)

Delegate an authentication request to a third party authentication provider, such as Google, Facebook, etc.

Parameters:

configuration - The authenticator configuration.

callback - The redirect, on this server, where the response should go.

Returns:

An HTTP response, redirecting the client to the next step.

validate

default void validate(Authenticator authenticator)
               throws KangarooException

Validate that a particular authentication configuration is valid for this IdP.

Parameters:

authenticator - The authenticator configuration.

Throws:

KangarooException - Thrown if the internal parameters are invalid.

authenticate

UserIdentity authenticate(Authenticator authenticator,
                          javax.ws.rs.core.MultivaluedMap<String,String> parameters,
                          URI callback)

Authenticate and/or create a user identity for a specific client, given the URI from an authentication delegate.

Parameters:

authenticator - The authenticator configuration.

parameters - Parameters for the authenticator, retrieved from an appropriate source.

callback - The redirect that was provided to the original authorize call.

Returns:

A user identity, or a runtime error that will be sent back.