io.quarkus.vertx.http.runtime.security

Enum HttpSecurityPolicy.CheckResult

java.lang.Object

java.lang.Enum<HttpSecurityPolicy.CheckResult>

io.quarkus.vertx.http.runtime.security.HttpSecurityPolicy.CheckResult

All Implemented Interfaces:

Serializable, Comparable<HttpSecurityPolicy.CheckResult>

Enclosing interface:

HttpSecurityPolicy

public static enum HttpSecurityPolicy.CheckResult
extends Enum<HttpSecurityPolicy.CheckResult>

The results of a permission check

Enum Constant Summary

Enum Constants

Enum Constant and Description
DENY Denies the request.
PERMIT If this is returned then the request is allowed.

Method Summary

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

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

PERMIT

public static final HttpSecurityPolicy.CheckResult PERMIT

If this is returned then the request is allowed. All permission checkers must permit a request for it to proceed.

DENY

public static final HttpSecurityPolicy.CheckResult DENY

Denies the request. If the SecurityIdentity represents the anonymous user then HttpAuthenticationMechanism.sendChallenge(RoutingContext) will be invoked, otherwise a 403 forbidden error code will be returned.

Method Detail

values

public static HttpSecurityPolicy.CheckResult[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (HttpSecurityPolicy.CheckResult c : HttpSecurityPolicy.CheckResult.values())
    System.out.println(c);

Returns:

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

valueOf

public static HttpSecurityPolicy.CheckResult valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type has no constant with the specified name

NullPointerException - if the argument is null