/*
 * Copyright 2015 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.oauth2;

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;

Functional interface that allows users to implement custom RBAC verifiers for OAuth2/OpenId Connect.
Users are to implement the isAuthorized method to verify authorities. For provides that do not
export the permissions/roles in the token, this interface allows you to communicate with 3rd party services
such as graph APIs to collect the required data.
The contract is that once an authority is checked for a given user, it's value is cached during the execution
of the request. If a user is stored to a persistent storage, or the token is introspected, the cache is cleared
and a new call will be handled to the implementation.
Deprecated:
use the new Authorization API AuthorizationProvider/**
 * Functional interface that allows users to implement custom RBAC verifiers for OAuth2/OpenId Connect.
 *
 * Users are to implement the <code>isAuthorized</code> method to verify authorities. For provides that do not
 * export the permissions/roles in the token, this interface allows you to communicate with 3rd party services
 * such as graph APIs to collect the required data.
 *
 * The contract is that once an authority is checked for a given user, it's value is cached during the execution
 * of the request. If a user is stored to a persistent storage, or the token is introspected, the cache is cleared
 * and a new call will be handled to the implementation.
 *
 * @deprecated use the new Authorization API {@link io.vertx.ext.auth.authorization.AuthorizationProvider}
 */
@VertxGen
@FunctionalInterface
@Deprecated
public interface OAuth2RBAC {

  
This method should verify if the user has the given authority and return either a boolean value or an error.
Note that false and errors are not the same. A user might not have a given authority but that doesn't mean that
there was an error during the call.
Params:
user – the given user to assert on
authority – the authority to lookup
handler – the result handler./**
   * This method should verify if the user has the given authority and return either a boolean value or an error.
   *
   * Note that false and errors are not the same. A user might not have a given authority but that doesn't mean that
   * there was an error during the call.
   *
   * @param user the given user to assert on
   * @param authority the authority to lookup
   * @param handler the result handler.
   */
  void isAuthorized(AccessToken user, String authority, Handler<AsyncResult<Boolean>> handler);

  
This method should verify if the user has the given authority and return either a boolean value or an error.
Note that false and errors are not the same. A user might not have a given authority but that doesn't mean that
there was an error during the call.
Params:
user – the given user to assert on
authority – the authority to lookup
See Also:
isAuthorized.isAuthorized(AccessToken, String, Handler)
Returns:
future with the result./**
   * This method should verify if the user has the given authority and return either a boolean value or an error.
   *
   * Note that false and errors are not the same. A user might not have a given authority but that doesn't mean that
   * there was an error during the call.
   *
   * @see OAuth2RBAC#isAuthorized(AccessToken, String, Handler)
   * @param user the given user to assert on
   * @param authority the authority to lookup
   * @return future with the result.
   */
  default Future<Boolean> isAuthorized(AccessToken user, String authority) {
    Promise<Boolean> promise = Promise.promise();
    isAuthorized(user, authority, promise);
    return promise.future();
  }
}