io.vertx.rxjava.ext.web.handler.AuthHandler Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of vertx-rx-java Show documentation
There is a newer version: 5.0.0.CR2
/*
 * 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 rx.Observable;
import rx.Single;
import io.vertx.rx.java.RxHelper;
import io.vertx.rx.java.WriteStreamSubscriber;
import io.vertx.rx.java.SingleOnSubscribeAdapter;
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;

/**
 * Base interface for auth handlers.
 * 
 * An auth handler allows your application to provide authentication/authorization support.
 * 

 * Auth handler requires a {@link io.vertx.rxjava.ext.web.handler.SessionHandler} to be on the routing chain before it.
 *
 * 
 * NOTE: This class has been automatically generated from the {@link io.vertx.ext.web.handler.AuthHandler original} non RX-ified interface using Vert.x codegen.
 */

@RxGen(io.vertx.ext.web.handler.AuthHandler.class)
public interface AuthHandler extends io.vertx.rxjava.ext.web.handler.AuthenticationHandler, Handler {

  io.vertx.ext.web.handler.AuthHandler getDelegate();

  /**
   * Something has happened, so handle it.
   * @param event the event to handle
   */
  @Deprecated()
  public void handle(io.vertx.rxjava.ext.web.RoutingContext event);

  /**
   * 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.
   */
  @Deprecated()
  public void parseCredentials(io.vertx.rxjava.ext.web.RoutingContext context, Handler> 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.
   * @param context the routing context
   */
  @Deprecated()
  public void parseCredentials(io.vertx.rxjava.ext.web.RoutingContext context);

    /**
   * 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()
  public Single rxParseCredentials(io.vertx.rxjava.ext.web.RoutingContext context);

  /**
   * Returns
   * @param context 
   * @return 
   */
  @Deprecated()
  public String authenticateHeader(io.vertx.rxjava.ext.web.RoutingContext context);

  /**
   * This method is called to perform any post authentication tasks, such as redirects.
   * Overrides must call context.next() on success.
   * @param ctx the routing context
   */
  @Deprecated()
  public void postAuthentication(io.vertx.rxjava.ext.web.RoutingContext ctx);

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

  /**
   * 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
   */
  @Deprecated()
  public io.vertx.rxjava.ext.web.handler.AuthHandler addAuthorities(Set authorities);

  /**
   * Authorizes the given user against all added authorities.
   * @param user a user.
   * @param handler the handler for the result.
   */
  @Deprecated()
  public void authorize(io.vertx.rxjava.ext.auth.User user, Handler> handler);

  /**
   * Authorizes the given user against all added authorities.
   * @param user a user.
   */
  @Deprecated()
  public void authorize(io.vertx.rxjava.ext.auth.User user);

    /**
   * Authorizes the given user against all added authorities.
   * @param user a user.
   * @return 
   */
  @Deprecated()
  public Single rxAuthorize(io.vertx.rxjava.ext.auth.User user);

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

}

class AuthHandlerImpl implements AuthHandler {
  private final io.vertx.ext.web.handler.AuthHandler delegate;
  
  public AuthHandlerImpl(io.vertx.ext.web.handler.AuthHandler delegate) {
    this.delegate = delegate;
  }

  public AuthHandlerImpl(Object delegate) {
    this.delegate = (io.vertx.ext.web.handler.AuthHandler)delegate;
  }

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

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

  /**
   * 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.
   */
  @Deprecated()
  public void parseCredentials(io.vertx.rxjava.ext.web.RoutingContext context, Handler> handler) { 
    delegate.parseCredentials(context.getDelegate(), new Handler>() {
      public void handle(AsyncResult ar) {
        if (ar.succeeded()) {
          handler.handle(io.vertx.core.Future.succeededFuture(io.vertx.rxjava.ext.auth.authentication.Credentials.newInstance((io.vertx.ext.auth.authentication.Credentials)ar.result())));
        } else {
          handler.handle(io.vertx.core.Future.failedFuture(ar.cause()));
        }
      }
    });
  }

  /**
   * 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
   */
  @Deprecated()
  public void parseCredentials(io.vertx.rxjava.ext.web.RoutingContext context) {
    parseCredentials(context, ar -> { });
  }

    /**
   * 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()
  public Single rxParseCredentials(io.vertx.rxjava.ext.web.RoutingContext context) { 
    return Single.create(new SingleOnSubscribeAdapter<>(fut -> {
      parseCredentials(context, fut);
    }));
  }

  /**
   * Returns
   * @param context 
   * @return 
   */
  @Deprecated()
  public String authenticateHeader(io.vertx.rxjava.ext.web.RoutingContext context) { 
    String ret = delegate.authenticateHeader(context.getDelegate());
    return ret;
  }

  /**
   * This method is called to perform any post authentication tasks, such as redirects.
   * Overrides must call context.next() on success.
   * @param ctx the routing context
   */
  @Deprecated()
  public void postAuthentication(io.vertx.rxjava.ext.web.RoutingContext ctx) { 
    delegate.postAuthentication(ctx.getDelegate());
  }

  /**
   * Add a required authority for this auth handler
   * @param authority the authority
   * @return a reference to this, so the API can be used fluently
   */
  @Deprecated()
  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
   * @param authorities the set of authorities
   * @return a reference to this, so the API can be used fluently
   */
  @Deprecated()
  public io.vertx.rxjava.ext.web.handler.AuthHandler addAuthorities(Set authorities) { 
    delegate.addAuthorities(authorities);
    return this;
  }

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

  /**
   * Authorizes the given user against all added authorities.
   * @param user a user.
   */
  @Deprecated()
  public void authorize(io.vertx.rxjava.ext.auth.User user) {
    authorize(user, ar -> { });
  }

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

}