/*
* 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.web.handler;
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;
Base interface for auth handlers.
An auth handler allows your application to provide authentication/authorization support.
Auth handler requires a SessionHandler
to be on the routing chain before it.
NOTE: This class has been automatically generated from the original
non RX-ified interface using Vert.x codegen. /**
* Base interface for auth handlers.
* <p>
* An auth handler allows your application to provide authentication/authorization support.
* <p>
* Auth handler requires a {@link io.vertx.reactivex.ext.web.handler.SessionHandler} to be on the routing chain before it.
*
* <p/>
* NOTE: This class has been automatically generated from the {@link io.vertx.ext.web.handler.AuthenticationHandler original} non RX-ified interface using Vert.x codegen.
*/
@RxGen(io.vertx.ext.web.handler.AuthenticationHandler.class)
public interface AuthenticationHandler extends Handler<io.vertx.reactivex.ext.web.RoutingContext> {
io.vertx.ext.web.handler.AuthenticationHandler getDelegate();
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.reactivex.ext.web.RoutingContext event);
Returns
Params: - context –
Returns:
/**
* Returns
* @param context
* @return
*/
public String authenticateHeader(io.vertx.reactivex.ext.web.RoutingContext context);
This method is called to perform any post authentication tasks, such as redirects.
Overrides must call context.next() on success.
Params: - ctx – the routing 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
*/
public void postAuthentication(io.vertx.reactivex.ext.web.RoutingContext ctx);
public static AuthenticationHandler newInstance(io.vertx.ext.web.handler.AuthenticationHandler arg) {
return arg != null ? new AuthenticationHandlerImpl(arg) : null;
}
}
class AuthenticationHandlerImpl implements AuthenticationHandler {
private final io.vertx.ext.web.handler.AuthenticationHandler delegate;
public AuthenticationHandlerImpl(io.vertx.ext.web.handler.AuthenticationHandler delegate) {
this.delegate = delegate;
}
public AuthenticationHandlerImpl(Object delegate) {
this.delegate = (io.vertx.ext.web.handler.AuthenticationHandler)delegate;
}
public io.vertx.ext.web.handler.AuthenticationHandler 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.reactivex.ext.web.RoutingContext event) {
delegate.handle(event.getDelegate());
}
Returns
Params: - context –
Returns:
/**
* Returns
* @param context
* @return
*/
public String authenticateHeader(io.vertx.reactivex.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.
Params: - ctx – the routing 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
*/
public void postAuthentication(io.vertx.reactivex.ext.web.RoutingContext ctx) {
delegate.postAuthentication(ctx.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.
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.reactivex.ext.web.RoutingContext context, Handler<AsyncResult<io.vertx.ext.auth.authentication.Credentials>> 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
/**
* 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
*/
public void parseCredentials(io.vertx.reactivex.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.
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 io.reactivex.Single<io.vertx.ext.auth.authentication.Credentials> rxParseCredentials(io.vertx.reactivex.ext.web.RoutingContext context) {
return AsyncResultSingle.toSingle($handler -> {
parseCredentials(context, $handler);
});
}
}