com.arangodb.shaded.vertx.ext.auth.ChainAuth Maven / Gradle / Ivy
/*
* Copyright 2014 Red Hat, Inc.
*
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* and Apache License v2.0 which accompanies this distribution.
*
* The Eclipse Public License is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* The Apache License v2.0 is available at
* http://www.opensource.org/licenses/apache2.0.php
*
* You may elect to redistribute this code under either of these licenses.
*/
package com.arangodb.shaded.vertx.ext.auth;
import com.arangodb.shaded.vertx.codegen.annotations.Fluent;
import com.arangodb.shaded.vertx.codegen.annotations.VertxGen;
import com.arangodb.shaded.vertx.ext.auth.authentication.AuthenticationProvider;
import com.arangodb.shaded.vertx.ext.auth.impl.ChainAuthImpl;
/**
* Chain several authentication providers as if they were one. This is useful for cases where one want to authenticate across
* several providers, for example, database and fallback to passwd file.
*/
@VertxGen
public interface ChainAuth extends AuthenticationProvider {
/**
* Create a Chainable Auth Provider auth provider
*
* @return the auth provider
*/
@Deprecated
static ChainAuth create() {
return any();
}
/**
* Create a Chainable Auth Provider auth provider that will resolve if all auth providers are successful.
*
* @return the auth provider
*/
static ChainAuth all() {
return new ChainAuthImpl(true);
}
/**
* Create a Chainable Auth Provider auth provider that will resolve on the first success.
*
* @return the auth provider
*/
static ChainAuth any() {
return new ChainAuthImpl(false);
}
/**
* Appends a auth provider to the chain.
*
* @param other auth provider
* @return self
*/
@Fluent
ChainAuth add(AuthenticationProvider other);
}