/*
 * 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.rxjava.ext.web.handler;

import java.util.Map;
import rx.Observable;
import rx.Single;
import java.util.Set;
import io.vertx.core.json.JsonObject;
import io.vertx.core.AsyncResult;
import io.vertx.core.Handler;

An auth handler that provides HTTP Basic Authentication support.
 NOTE: This class has been automatically generated from the original non RX-ified interface using Vert.x codegen. /**
 * An auth handler that provides HTTP Basic Authentication support.
 *
 * <p/>
 * NOTE: This class has been automatically generated from the {@link io.vertx.ext.web.handler.BasicAuthHandler original} non RX-ified interface using Vert.x codegen.
 */

@io.vertx.lang.rx.RxGen(io.vertx.ext.web.handler.BasicAuthHandler.class)
public class BasicAuthHandler implements io.vertx.rxjava.ext.web.handler.AuthHandler, io.vertx.core.Handler<io.vertx.rxjava.ext.web.RoutingContext> {

  @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;
    BasicAuthHandler that = (BasicAuthHandler) o;
    return delegate.equals(that.delegate);
  }
  
  @Override
  public int hashCode() {
    return delegate.hashCode();
  }

  public static final io.vertx.lang.rx.TypeArg<BasicAuthHandler> __TYPE_ARG = new io.vertx.lang.rx.TypeArg<>(    obj -> new BasicAuthHandler((io.vertx.ext.web.handler.BasicAuthHandler) obj),
    BasicAuthHandler::getDelegate
  );

  private final io.vertx.ext.web.handler.BasicAuthHandler delegate;
  
  public BasicAuthHandler(io.vertx.ext.web.handler.BasicAuthHandler delegate) {
    this.delegate = delegate;
  }

  public io.vertx.ext.web.handler.BasicAuthHandler getDelegate() {
    return delegate;
  }

  
Something has happened, so handle it.
Params:
event – the event to handle/**
   * Something has happened, so handle it.
   * @param event the event to handle
   */
  public void handle(io.vertx.rxjava.ext.web.RoutingContext event) { 
    delegate.handle(event.getDelegate());
  }

  
Add a required authority for this auth handler
Params:
authority – the authority
Returns:
a reference to this, so the API can be used fluently/**
   * Add a required authority for this auth handler
   * @param authority the authority
   * @return a reference to this, so the API can be used fluently
   */
  public io.vertx.rxjava.ext.web.handler.AuthHandler addAuthority(String authority) { 
    delegate.addAuthority(authority);
    return this;
  }

  
Add a set of required authorities for this auth handler
Params:
authorities – the set of authorities
Returns:
a reference to this, so the API can be used fluently/**
   * Add a set of required authorities for this auth handler
   * @param authorities the set of authorities
   * @return a reference to this, so the API can be used fluently
   */
  public io.vertx.rxjava.ext.web.handler.AuthHandler addAuthorities(Set<String> authorities) { 
    delegate.addAuthorities(authorities);
    return this;
  }

  
Parses the credentials from the request into a JsonObject. The implementation should
be able to extract the required info for the auth provider in the format the provider
expects.
Params:
context – the routing context
handler – the handler to be called once the information is available./**
   * Parses the credentials from the request into a JsonObject. The implementation should
   * be able to extract the required info for the auth provider in the format the provider
   * expects.
   * @param context the routing context
   * @param handler the handler to be called once the information is available.
   */
  public void parseCredentials(io.vertx.rxjava.ext.web.RoutingContext context, Handler<AsyncResult<JsonObject>> handler) { 
    delegate.parseCredentials(context.getDelegate(), handler);
  }

    
Parses the credentials from the request into a JsonObject. The implementation should
be able to extract the required info for the auth provider in the format the provider
expects.
Params:
context – the routing context
Returns:
Deprecated:
use rxParseCredentials instead/**
   * Parses the credentials from the request into a JsonObject. The implementation should
   * be able to extract the required info for the auth provider in the format the provider
   * expects.
   * @param context the routing context
   * @return 
   * @deprecated use {@link #rxParseCredentials} instead
   */
  @Deprecated()
  public Observable<JsonObject> parseCredentialsObservable(io.vertx.rxjava.ext.web.RoutingContext context) { 
    io.vertx.rx.java.ObservableFuture<JsonObject> handler = io.vertx.rx.java.RxHelper.observableFuture();
    parseCredentials(context, handler.toHandler());
    return handler;
  }

  
Parses the credentials from the request into a JsonObject. The implementation should
be able to extract the required info for the auth provider in the format the provider
expects.
Params:
context – the routing context
Returns:
/**
   * Parses the credentials from the request into a JsonObject. The implementation should
   * be able to extract the required info for the auth provider in the format the provider
   * expects.
   * @param context the routing context
   * @return 
   */
  public Single<JsonObject> rxParseCredentials(io.vertx.rxjava.ext.web.RoutingContext context) { 
    return Single.create(new io.vertx.rx.java.SingleOnSubscribeAdapter<>(fut -> {
      parseCredentials(context, fut);
    }));
  }

  
Authorizes the given user against all added authorities.
Params:
user – a user.
handler – the handler for the result./**
   * Authorizes the given user against all added authorities.
   * @param user a user.
   * @param handler the handler for the result.
   */
  public void authorize(io.vertx.rxjava.ext.auth.User user, Handler<AsyncResult<Void>> handler) { 
    delegate.authorize(user.getDelegate(), handler);
  }

    
Authorizes the given user against all added authorities.
Params:
user – a user.
Returns:
Deprecated:
use rxAuthorize instead/**
   * Authorizes the given user against all added authorities.
   * @param user a user.
   * @return 
   * @deprecated use {@link #rxAuthorize} instead
   */
  @Deprecated()
  public Observable<Void> authorizeObservable(io.vertx.rxjava.ext.auth.User user) { 
    io.vertx.rx.java.ObservableFuture<Void> handler = io.vertx.rx.java.RxHelper.observableFuture();
    authorize(user, handler.toHandler());
    return handler;
  }

  
Authorizes the given user against all added authorities.
Params:
user – a user.
Returns:
/**
   * Authorizes the given user against all added authorities.
   * @param user a user.
   * @return 
   */
  public Single<Void> rxAuthorize(io.vertx.rxjava.ext.auth.User user) { 
    return Single.create(new io.vertx.rx.java.SingleOnSubscribeAdapter<>(fut -> {
      authorize(user, fut);
    }));
  }

  
Create a basic auth handler
Params:
authProvider – the auth provider to use
Returns:
the auth handler/**
   * Create a basic auth handler
   * @param authProvider the auth provider to use
   * @return the auth handler
   */
  public static io.vertx.rxjava.ext.web.handler.AuthHandler create(io.vertx.rxjava.ext.auth.AuthProvider authProvider) { 
    io.vertx.rxjava.ext.web.handler.AuthHandler ret = io.vertx.rxjava.ext.web.handler.AuthHandler.newInstance(io.vertx.ext.web.handler.BasicAuthHandler.create(authProvider.getDelegate()));
    return ret;
  }

  
Create a basic auth handler, specifying realm
Params:
authProvider – the auth service to use
realm – the realm to use
Returns:
the auth handler/**
   * Create a basic auth handler, specifying realm
   * @param authProvider the auth service to use
   * @param realm the realm to use
   * @return the auth handler
   */
  public static io.vertx.rxjava.ext.web.handler.AuthHandler create(io.vertx.rxjava.ext.auth.AuthProvider authProvider, String realm) { 
    io.vertx.rxjava.ext.web.handler.AuthHandler ret = io.vertx.rxjava.ext.web.handler.AuthHandler.newInstance(io.vertx.ext.web.handler.BasicAuthHandler.create(authProvider.getDelegate(), realm));
    return ret;
  }

  
The default realm to use
/**
   * The default realm to use
   */
  public static final String DEFAULT_REALM = io.vertx.ext.web.handler.BasicAuthHandler.DEFAULT_REALM;

  public static  BasicAuthHandler newInstance(io.vertx.ext.web.handler.BasicAuthHandler arg) {
    return arg != null ? new BasicAuthHandler(arg) : null;
  }
}