Package io.quarkus.oidc

Enum Class Redirect.Location

java.lang.Object

java.lang.Enum<Redirect.Location>

io.quarkus.oidc.Redirect.Location

All Implemented Interfaces:

Serializable, Comparable<Redirect.Location>, Constable

Enclosing class:

Redirect

public static enum Redirect.Location
extends Enum<Redirect.Location>

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ALL
ERROR_PAGE	Applies to the local redirect to a custom error page resource when an authorization code flow redirect from OIDC provider to Quarkus returns an error instead of an authorization code
LOCAL_ENDPOINT_CALLBACK	Applies to the local redirect to the callback resource which is done after successful authorization code flow completion in order to drop the code and state parameters from the callback URL.
OIDC_AUTHORIZATION	Applies to OIDC authorization endpoint
OIDC_LOGOUT	Applies to OIDC logout endpoint
SESSION_EXPIRED_PAGE	Applies to the local redirect to a custom session expired page resource when the current user's session has expired and no longer can be refreshed.

Method Summary

Modifier and Type	Method	Description
static Redirect.Location	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Redirect.Location[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

ALL

public static final Redirect.Location ALL

OIDC_AUTHORIZATION

public static final Redirect.Location OIDC_AUTHORIZATION

Applies to OIDC authorization endpoint

OIDC_LOGOUT

public static final Redirect.Location OIDC_LOGOUT

Applies to OIDC logout endpoint

ERROR_PAGE

public static final Redirect.Location ERROR_PAGE

Applies to the local redirect to a custom error page resource when an authorization code flow redirect from OIDC provider to Quarkus returns an error instead of an authorization code

SESSION_EXPIRED_PAGE

public static final Redirect.Location SESSION_EXPIRED_PAGE

Applies to the local redirect to a custom session expired page resource when the current user's session has expired and no longer can be refreshed.

LOCAL_ENDPOINT_CALLBACK

public static final Redirect.Location LOCAL_ENDPOINT_CALLBACK

Applies to the local redirect to the callback resource which is done after successful authorization code flow completion in order to drop the code and state parameters from the callback URL.

Method Details

values

public static Redirect.Location[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static Redirect.Location valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null