/*
 * Copyright 2014 Red Hat, Inc.
 *
 *  All rights reserved. This program and the accompanying materials
 *  are made available under the terms of the Eclipse Public License v1.0
 *  and Apache License v2.0 which accompanies this distribution.
 *
 *  The Eclipse Public License is available at
 *  http://www.eclipse.org/legal/epl-v10.html
 *
 *  The Apache License v2.0 is available at
 *  http://www.opensource.org/licenses/apache2.0.php
 *
 *  You may elect to redistribute this code under either of these licenses.
 */

package io.vertx.ext.auth.authentication;

import io.vertx.codegen.annotations.GenIgnore;
import io.vertx.codegen.annotations.VertxGen;
import io.vertx.core.AsyncResult;
import io.vertx.core.Future;
import io.vertx.core.Handler;
import io.vertx.core.Promise;
import io.vertx.core.json.JsonObject;
import io.vertx.ext.auth.User;

User-facing interface for authenticating users.
Author:
Tim Fox/**
 *
 * User-facing interface for authenticating users.
 *
 * @author <a href="http://tfox.org">Tim Fox</a>
 */
@VertxGen
public interface AuthenticationProvider {

  
Authenticate a user.

The first argument is a JSON object containing information for authenticating the user. What this actually contains
depends on the specific implementation. In the case of a simple username/password based
authentication it is likely to contain a JSON object with the following structure:
  {
    "username": "tim",
    "password": "mypassword"
  }

For other types of authentication it contain different information - for example a JWT token or OAuth bearer token.
 If the user is successfully authenticated a User object is passed to the handler in an AsyncResult. The user object can then be used for authorisation. 
Params:
credentials –  The credentials
resultHandler –  The result handler/**
   * Authenticate a user.
   * <p>
   * The first argument is a JSON object containing information for authenticating the user. What this actually contains
   * depends on the specific implementation. In the case of a simple username/password based
   * authentication it is likely to contain a JSON object with the following structure:
   * <pre>
   *   {
   *     "username": "tim",
   *     "password": "mypassword"
   *   }
   * </pre>
   * For other types of authentication it contain different information - for example a JWT token or OAuth bearer token.
   * <p>
   * If the user is successfully authenticated a {@link User} object is passed to the handler in an {@link AsyncResult}.
   * The user object can then be used for authorisation.
   *
   * @param credentials  The credentials
   * @param resultHandler  The result handler
   */
  void authenticate(JsonObject credentials, Handler<AsyncResult<User>> resultHandler);

  
Authenticate a user.

The first argument is a JSON object containing information for authenticating the user. What this actually contains
depends on the specific implementation. In the case of a simple username/password based
authentication it is likely to contain a JSON object with the following structure:
  {
    "username": "tim",
    "password": "mypassword"
  }

For other types of authentication it contain different information - for example a JWT token or OAuth bearer token.
 If the user is successfully authenticated a User object is passed to the handler in an AsyncResult. The user object can then be used for authorisation. 
Params:
credentials –  The credentials
See Also:
authenticate(JsonObject, Handler<AsyncResult<User>>)
Returns:
The result future/**
   * Authenticate a user.
   * <p>
   * The first argument is a JSON object containing information for authenticating the user. What this actually contains
   * depends on the specific implementation. In the case of a simple username/password based
   * authentication it is likely to contain a JSON object with the following structure:
   * <pre>
   *   {
   *     "username": "tim",
   *     "password": "mypassword"
   *   }
   * </pre>
   * For other types of authentication it contain different information - for example a JWT token or OAuth bearer token.
   * <p>
   * If the user is successfully authenticated a {@link User} object is passed to the handler in an {@link AsyncResult}.
   * The user object can then be used for authorisation.
   *
   * @see AuthenticationProvider#authenticate(JsonObject, Handler)
   * @param credentials  The credentials
   * @return The result future
   */
  default Future<User> authenticate(JsonObject credentials) {
    Promise<User> promise = Promise.promise();
    authenticate(credentials, promise);
    return promise.future();
  }

  
Authenticate a user.
 The first argument is a Credentials object containing information for authenticating the user. What this actually contains depends on the specific implementation. If the user is successfully authenticated a User object is passed to the handler in an AsyncResult. The user object can then be used for authorisation. 
Params:
credentials –  The credentials
resultHandler –  The result handler/**
   * Authenticate a user.
   * <p>
   * The first argument is a Credentials object containing information for authenticating the user.
   * What this actually contains depends on the specific implementation.
   *
   * If the user is successfully authenticated a {@link User} object is passed to the handler in an {@link AsyncResult}.
   * The user object can then be used for authorisation.
   *
   * @param credentials  The credentials
   * @param resultHandler  The result handler
   */
  @GenIgnore(GenIgnore.PERMITTED_TYPE)
  default void authenticate(Credentials credentials, Handler<AsyncResult<User>> resultHandler) {
    try {
      credentials.checkValid(null);
      authenticate(credentials.toJson(), resultHandler);
    } catch (CredentialValidationException e) {
      resultHandler.handle(Future.failedFuture(e));
    }
  }

  
Authenticate a user.

The first argument is a Credentials object containing information for authenticating the user.
What this actually contains depends on the specific implementation.
Params:
credentials –  The credentials
See Also:
authenticate.authenticate(Credentials, Handler)
Returns:
The result future/**
   * Authenticate a user.
   * <p>
   * The first argument is a Credentials object containing information for authenticating the user.
   * What this actually contains depends on the specific implementation.
   *
   * @see AuthenticationProvider#authenticate(Credentials, Handler)
   * @param credentials  The credentials
   * @return The result future
   */
  @GenIgnore(GenIgnore.PERMITTED_TYPE)
  default Future<User> authenticate(Credentials credentials) {
    Promise<User> promise = Promise.promise();
    authenticate(credentials, promise);
    return promise.future();
  }
}