/*
 * 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.authentication;

import io.vertx.reactivex.RxHelper;
import io.vertx.reactivex.ObservableHelper;
import io.vertx.reactivex.FlowableHelper;
import io.vertx.reactivex.impl.AsyncResultMaybe;
import io.vertx.reactivex.impl.AsyncResultSingle;
import io.vertx.reactivex.impl.AsyncResultCompletable;
import io.vertx.reactivex.WriteStreamObserver;
import io.vertx.reactivex.WriteStreamSubscriber;
import java.util.Map;
import java.util.Set;
import java.util.List;
import java.util.Iterator;
import java.util.function.Function;
import java.util.stream.Collectors;
import io.vertx.core.Handler;
import io.vertx.core.AsyncResult;
import io.vertx.core.json.JsonObject;
import io.vertx.core.json.JsonArray;
import io.vertx.lang.rx.RxGen;
import io.vertx.lang.rx.TypeArg;
import io.vertx.lang.rx.MappingIterator;

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.authentication.AuthenticationProvider original} non RX-ified interface using Vert.x codegen. */
@RxGen(io.vertx.ext.auth.authentication.AuthenticationProvider.class) public class AuthenticationProvider { @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; AuthenticationProvider that = (AuthenticationProvider) o; return delegate.equals(that.delegate); } @Override public int hashCode() { return delegate.hashCode(); } public static final TypeArg<AuthenticationProvider> __TYPE_ARG = new TypeArg<>( obj -> new AuthenticationProvider((io.vertx.ext.auth.authentication.AuthenticationProvider) obj), AuthenticationProvider::getDelegate ); private final io.vertx.ext.auth.authentication.AuthenticationProvider delegate; public AuthenticationProvider(io.vertx.ext.auth.authentication.AuthenticationProvider delegate) { this.delegate = delegate; } public AuthenticationProvider(Object delegate) { this.delegate = (io.vertx.ext.auth.authentication.AuthenticationProvider)delegate; } public io.vertx.ext.auth.authentication.AuthenticationProvider 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 object is passed to the handler in an . 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 object is passed to the handler in an . * The user object can then be used for authorisation. * @param credentials The credentials * @param resultHandler The result handler */
public void authenticate(JsonObject credentials, Handler<AsyncResult<io.vertx.reactivex.ext.auth.User>> resultHandler) { delegate.authenticate(credentials, 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((io.vertx.ext.auth.User)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 object is passed to the handler in an . The user object can then be used for authorisation.

Params:
  • credentials – The credentials
/** * 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 object is passed to the handler in an . * The user object can then be used for authorisation. * @param credentials The credentials */
public void authenticate(JsonObject credentials) { authenticate(credentials, ar -> { }); }
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 object is passed to the handler in an . The user object can then be used for authorisation.

Params:
  • credentials – The credentials
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 object is passed to the handler in an . * The user object can then be used for authorisation. * @param credentials The credentials * @return */
public io.reactivex.Single<io.vertx.reactivex.ext.auth.User> rxAuthenticate(JsonObject credentials) { return AsyncResultSingle.toSingle($handler -> { authenticate(credentials, $handler); }); }
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 object is passed to the handler in an . 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 object is passed to the handler in an . * The user object can then be used for authorisation. * @param credentials The credentials * @param resultHandler The result handler */
public void authenticate(io.vertx.ext.auth.authentication.Credentials credentials, Handler<AsyncResult<io.vertx.reactivex.ext.auth.User>> resultHandler) { delegate.authenticate(credentials, 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((io.vertx.ext.auth.User)ar.result()))); } else { resultHandler.handle(io.vertx.core.Future.failedFuture(ar.cause())); } } }); }
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 object is passed to the handler in an . The user object can then be used for authorisation.

Params:
  • credentials – The credentials
/** * 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 object is passed to the handler in an . * The user object can then be used for authorisation. * @param credentials The credentials */
public void authenticate(io.vertx.ext.auth.authentication.Credentials credentials) { authenticate(credentials, ar -> { }); }
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 object is passed to the handler in an . The user object can then be used for authorisation.

Params:
  • credentials – The credentials
Returns:
/** * 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 object is passed to the handler in an . * The user object can then be used for authorisation. * @param credentials The credentials * @return */
public io.reactivex.Single<io.vertx.reactivex.ext.auth.User> rxAuthenticate(io.vertx.ext.auth.authentication.Credentials credentials) { return AsyncResultSingle.toSingle($handler -> { authenticate(credentials, $handler); }); } public static AuthenticationProvider newInstance(io.vertx.ext.auth.authentication.AuthenticationProvider arg) { return arg != null ? new AuthenticationProvider(arg) : null; } }