/*
 * Copyright 2014 Red Hat, Inc.
 *
 * Red Hat licenses this file to you under the Apache License, version 2.0
 * (the "License"); you may not use this file except in compliance with the
 * License.  You may obtain a copy of the License at:
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the
 * License for the specific language governing permissions and limitations
 * under the License.
 */

package io.vertx.reactivex.ext.auth;

import java.util.Map;
import io.reactivex.Observable;
import io.reactivex.Flowable;
import io.reactivex.Single;
import io.reactivex.Completable;
import io.reactivex.Maybe;
import io.vertx.core.json.JsonObject;
import io.vertx.core.AsyncResult;
import io.vertx.core.Handler;

User-facing interface for authenticating users.

NOTE: This class has been automatically generated from the original non RX-ified interface using Vert.x codegen.
/** * * User-facing interface for authenticating users. * * <p/> * NOTE: This class has been automatically generated from the {@link io.vertx.ext.auth.AuthProvider original} non RX-ified interface using Vert.x codegen. */
@io.vertx.lang.rx.RxGen(io.vertx.ext.auth.AuthProvider.class) public class AuthProvider { @Override public String toString() { return delegate.toString(); } @Override public boolean equals(Object o) { if (this == o) return true; if (o == null || getClass() != o.getClass()) return false; AuthProvider that = (AuthProvider) o; return delegate.equals(that.delegate); } @Override public int hashCode() { return delegate.hashCode(); } public static final io.vertx.lang.rx.TypeArg<AuthProvider> __TYPE_ARG = new io.vertx.lang.rx.TypeArg<>( obj -> new AuthProvider((io.vertx.ext.auth.AuthProvider) obj), AuthProvider::getDelegate ); private final io.vertx.ext.auth.AuthProvider delegate; public AuthProvider(io.vertx.ext.auth.AuthProvider delegate) { this.delegate = delegate; } public io.vertx.ext.auth.AuthProvider getDelegate() { return delegate; }
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:
  • authInfo – The auth information
  • 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 io.vertx.reactivex.ext.auth.User} object is passed to the handler in an {@link io.vertx.core.AsyncResult}. * The user object can then be used for authorisation. * @param authInfo The auth information * @param resultHandler The result handler */
public void authenticate(JsonObject authInfo, Handler<AsyncResult<io.vertx.reactivex.ext.auth.User>> resultHandler) { delegate.authenticate(authInfo, new Handler<AsyncResult<io.vertx.ext.auth.User>>() { public void handle(AsyncResult<io.vertx.ext.auth.User> ar) { if (ar.succeeded()) { resultHandler.handle(io.vertx.core.Future.succeededFuture(io.vertx.reactivex.ext.auth.User.newInstance(ar.result()))); } else { resultHandler.handle(io.vertx.core.Future.failedFuture(ar.cause())); } } }); }
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:
  • authInfo – The auth information
Returns:
/** * 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 io.vertx.reactivex.ext.auth.User} object is passed to the handler in an {@link io.vertx.core.AsyncResult}. * The user object can then be used for authorisation. * @param authInfo The auth information * @return */
public Single<io.vertx.reactivex.ext.auth.User> rxAuthenticate(JsonObject authInfo) { return io.vertx.reactivex.impl.AsyncResultSingle.toSingle(handler -> { authenticate(authInfo, handler); }); } public static AuthProvider newInstance(io.vertx.ext.auth.AuthProvider arg) { return arg != null ? new AuthProvider(arg) : null; } }