Package io.vertx.mutiny.ext.web.handler

Class RedirectAuthHandler

java.lang.Object

io.vertx.mutiny.ext.web.handler.RedirectAuthHandler

All Implemented Interfaces:

io.vertx.core.Handler<RoutingContext>, AuthenticationHandler, Consumer<RoutingContext>

public class RedirectAuthHandler
extends Object
implements AuthenticationHandler, io.vertx.core.Handler<RoutingContext>, Consumer<RoutingContext>

An auth handler that's used to handle auth by redirecting user to a custom login page.

NOTE: This class has been automatically generated from the original non Mutiny-ified interface using Vert.x codegen.

Field Summary

Fields

Modifier and Type	Field	Description
static TypeArg<RedirectAuthHandler>	__TYPE_ARG
static String	DEFAULT_LOGIN_REDIRECT_URL	Default path the user will be redirected to
static String	DEFAULT_RETURN_URL_PARAM	Default name of param used to store return url information in session

Constructor Summary

Constructors

Constructor	Description
RedirectAuthHandler(io.vertx.ext.web.handler.RedirectAuthHandler delegate)
RedirectAuthHandler(Object delegate)

Method Summary

Modifier and Type	Method	Description
void	accept(RoutingContext item)
static RedirectAuthHandler	create(AuthenticationProvider authProvider)
static RedirectAuthHandler	create(AuthenticationProvider authProvider, String loginRedirectURL)
static RedirectAuthHandler	create(AuthenticationProvider authProvider, String loginRedirectURL, String returnURLParam)
boolean	equals(Object o)
io.vertx.ext.web.handler.RedirectAuthHandler	getDelegate()
void	handle(RoutingContext arg0)
int	hashCode()
static RedirectAuthHandler	newInstance(io.vertx.ext.web.handler.RedirectAuthHandler arg)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.function.Consumer

andThen

Field Detail

__TYPE_ARG

public static final TypeArg<RedirectAuthHandler> __TYPE_ARG

DEFAULT_LOGIN_REDIRECT_URL

public static final String DEFAULT_LOGIN_REDIRECT_URL

Default path the user will be redirected to

See Also:

Constant Field Values

DEFAULT_RETURN_URL_PARAM

public static final String DEFAULT_RETURN_URL_PARAM

Default name of param used to store return url information in session

See Also:

Constant Field Values

Constructor Detail

RedirectAuthHandler

public RedirectAuthHandler(io.vertx.ext.web.handler.RedirectAuthHandler delegate)

RedirectAuthHandler

public RedirectAuthHandler(Object delegate)

Method Detail

getDelegate

public io.vertx.ext.web.handler.RedirectAuthHandler getDelegate()

Specified by:

getDelegate in interface AuthenticationHandler

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

handle

public void handle(RoutingContext arg0)

Specified by:

handle in interface AuthenticationHandler

Specified by:

handle in interface io.vertx.core.Handler<RoutingContext>

create

public static RedirectAuthHandler create(AuthenticationProvider authProvider)

Parameters:

authProvider - the auth service to use

Returns:

the handler

create

public static RedirectAuthHandler create(AuthenticationProvider authProvider,
                                         String loginRedirectURL)

Parameters:

authProvider - the auth service to use

loginRedirectURL - the url to redirect the user to

Returns:

the handler

create

public static RedirectAuthHandler create(AuthenticationProvider authProvider,
                                         String loginRedirectURL,
                                         String returnURLParam)

Parameters:

authProvider - the auth service to use

loginRedirectURL - the url to redirect the user to

returnURLParam - the name of param used to store return url information in session

Returns:

the handler

accept

public void accept(RoutingContext item)

Specified by:

accept in interface AuthenticationHandler

Specified by:

accept in interface Consumer<RoutingContext>

newInstance

public static RedirectAuthHandler newInstance(io.vertx.ext.web.handler.RedirectAuthHandler arg)