Class FormAuthenticationMechanism
- java.lang.Object
-
- io.quarkus.vertx.http.runtime.security.FormAuthenticationMechanism
-
- All Implemented Interfaces:
HttpAuthenticationMechanism
public class FormAuthenticationMechanism extends Object implements HttpAuthenticationMechanism
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface io.quarkus.vertx.http.runtime.security.HttpAuthenticationMechanism
HttpAuthenticationMechanism.ChallengeSender
-
-
Field Summary
-
Fields inherited from interface io.quarkus.vertx.http.runtime.security.HttpAuthenticationMechanism
DEFAULT_PRIORITY
-
-
Constructor Summary
Constructors Constructor Description FormAuthenticationMechanism(String loginPage, String postLocation, String usernameParameter, String passwordParameter, String errorPage, String landingPage, boolean redirectAfterLogin, String locationCookie, String cookieSameSite, String cookiePath, PersistentLoginManager loginManager)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description io.smallrye.mutiny.Uni<io.quarkus.security.identity.SecurityIdentity>
authenticate(io.vertx.ext.web.RoutingContext context, io.quarkus.security.identity.IdentityProviderManager identityProviderManager)
io.smallrye.mutiny.Uni<ChallengeData>
getChallenge(io.vertx.ext.web.RoutingContext context)
io.smallrye.mutiny.Uni<HttpCredentialTransport>
getCredentialTransport(io.vertx.ext.web.RoutingContext context)
The credential transport, used for finding the best candidate for authenticating and challenging when more than one mechanism is installed.Set<Class<? extends io.quarkus.security.identity.request.AuthenticationRequest>>
getCredentialTypes()
Returns the required credential types.(package private) static io.smallrye.mutiny.Uni<ChallengeData>
getRedirect(io.vertx.ext.web.RoutingContext exchange, String location)
protected void
handleRedirectBack(io.vertx.ext.web.RoutingContext exchange)
io.smallrye.mutiny.Uni<io.quarkus.security.identity.SecurityIdentity>
runFormAuth(io.vertx.ext.web.RoutingContext exchange, io.quarkus.security.identity.IdentityProviderManager securityContext)
(package private) static void
sendRedirect(io.vertx.ext.web.RoutingContext exchange, String location)
protected void
servePage(io.vertx.ext.web.RoutingContext exchange, String location)
protected void
storeInitialLocation(io.vertx.ext.web.RoutingContext exchange)
protected void
verifyRedirectBackLocation(String requestURIString, String redirectUriString)
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface io.quarkus.vertx.http.runtime.security.HttpAuthenticationMechanism
getCredentialTransport, getPriority, sendChallenge
-
-
-
-
Constructor Detail
-
FormAuthenticationMechanism
public FormAuthenticationMechanism(String loginPage, String postLocation, String usernameParameter, String passwordParameter, String errorPage, String landingPage, boolean redirectAfterLogin, String locationCookie, String cookieSameSite, String cookiePath, PersistentLoginManager loginManager)
-
-
Method Detail
-
runFormAuth
public io.smallrye.mutiny.Uni<io.quarkus.security.identity.SecurityIdentity> runFormAuth(io.vertx.ext.web.RoutingContext exchange, io.quarkus.security.identity.IdentityProviderManager securityContext)
-
handleRedirectBack
protected void handleRedirectBack(io.vertx.ext.web.RoutingContext exchange)
-
verifyRedirectBackLocation
protected void verifyRedirectBackLocation(String requestURIString, String redirectUriString)
-
storeInitialLocation
protected void storeInitialLocation(io.vertx.ext.web.RoutingContext exchange)
-
servePage
protected void servePage(io.vertx.ext.web.RoutingContext exchange, String location)
-
sendRedirect
static void sendRedirect(io.vertx.ext.web.RoutingContext exchange, String location)
-
getRedirect
static io.smallrye.mutiny.Uni<ChallengeData> getRedirect(io.vertx.ext.web.RoutingContext exchange, String location)
-
authenticate
public io.smallrye.mutiny.Uni<io.quarkus.security.identity.SecurityIdentity> authenticate(io.vertx.ext.web.RoutingContext context, io.quarkus.security.identity.IdentityProviderManager identityProviderManager)
- Specified by:
authenticate
in interfaceHttpAuthenticationMechanism
-
getChallenge
public io.smallrye.mutiny.Uni<ChallengeData> getChallenge(io.vertx.ext.web.RoutingContext context)
- Specified by:
getChallenge
in interfaceHttpAuthenticationMechanism
-
getCredentialTypes
public Set<Class<? extends io.quarkus.security.identity.request.AuthenticationRequest>> getCredentialTypes()
Description copied from interface:HttpAuthenticationMechanism
Returns the required credential types. If there are no identity managers installed that support the listed types then this mechanism will not be enabled.- Specified by:
getCredentialTypes
in interfaceHttpAuthenticationMechanism
-
getCredentialTransport
public io.smallrye.mutiny.Uni<HttpCredentialTransport> getCredentialTransport(io.vertx.ext.web.RoutingContext context)
Description copied from interface:HttpAuthenticationMechanism
The credential transport, used for finding the best candidate for authenticating and challenging when more than one mechanism is installed. May be null if this mechanism cannot interfere with other mechanisms- Specified by:
getCredentialTransport
in interfaceHttpAuthenticationMechanism
-
-