com.yammer.dropwizard.auth.Authenticator Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of dropwizard-auth Show documentation

There is a newer version: 0.6.2

package com.yammer.dropwizard.auth;

import com.google.common.base.Optional;

/**
 * An interface for classes which authenticate user-provided credentials and return principal
 * objects.
 *
 * @param     the type of credentials the authenticator can authenticate
 * @param     the type of principals the authenticator returns
 */
public interface Authenticator {
    /**
     * Given a set of user-provided credentials, return an optional principal.
     *
     * 
If the credentials are valid and map to a principal, returns an {@code Optional.of(p)}.
     *
     * If the credentials are invalid, returns an {@code Optional.absent()}.
     *
     * @param credentials    a set of user-provided credentials
     * @return either an authenticated principal or an absent optional
     * @throws AuthenticationException if the credentials cannot be authenticated due to an
     *                                 underlying error
     */
    Optional authenticate(C credentials) throws AuthenticationException;
}