io.quarkus.security.identity.IdentityProvider Maven / Gradle / Ivy
package io.quarkus.security.identity;
import io.quarkus.security.AuthenticationFailedException;
import io.quarkus.security.identity.request.AuthenticationRequest;
import io.smallrye.mutiny.Uni;
/**
*
* As the requirements for different providers are often different this interface has purposefully been
* made minimal. Interfaces that extend IdentityProvider should be created for different use cases, which can
* then be used directly.
*
* {@link IdentityProviderManager} should be used to get a specific type of {@link IdentityProvider} for a specific
* use case.
*/
public interface IdentityProvider {
/**
* The lowest priority provider Quarkus will register
*/
int SYSTEM_LAST = 0;
/**
* The highest priority provider Quarkus will register
*/
int SYSTEM_FIRST = 1000;
/**
* @return The type of request this store can handle
*/
Class getRequestType();
/**
* Attempts to authenticate the given authentication request. If this is unsuccessful because the provided
* credentials are invalid then this should fail with an {@link AuthenticationFailedException}, otherwise
* it should complete with a null value.
*
* Any other failure mode will be interpreted as a failure in the underlying store (e.g. LDAP is down), rather
* than the credentials being invalid. If multiple providers are installed that can handle the same type of request
* an {@link AuthenticationFailedException} will immediately stop processing, while any other failure will allow
* processing to continue.
*
* @param request The authentication request
* @param context The context of the request
* @return The future security identity
*/
Uni authenticate(T request, AuthenticationRequestContext context);
/**
* Returns the priority of this identity provider. System providers
* have a priority between 0 and 1000 by default, so to guarantee that
* your provider runs before the Quarkus ones it's priority should be
* over 1000.
*
* @return The priority of this identity provider
*/
default int priority() {
return SYSTEM_FIRST + 1;
}
}