com.outbrain.ob1k.security.server.CredentialsAuthenticator Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of ob1k-security Show documentation

The newest version!

package com.outbrain.ob1k.security.server;

import com.outbrain.ob1k.concurrent.ComposableFuture;

public interface CredentialsAuthenticator {

  /**
   * Authenticates the given credentials.
   * It is left to the implementation to define the structure of the credentials object.
   *
   * @return {@code true} if authentication succeeded
   */
  ComposableFuture authenticate(Credentials credentials);

  /**
   * Returns the unique identifier of this CredentialsAuthenticator.

   * The return value must fulfill the following promises:
   * 
   *   Different implementations of the {@code CredentialsAuthenticator} must return a different id
   *   
   *     Different instances of the same {@code CredentialsAuthenticator} will return a different id
   *     iff their configuration is different
   *   
   * 
   */
  String getId();

}