Package io.helidon.security

Enum SecurityResponse.SecurityStatus

java.lang.Object

java.lang.Enum<SecurityResponse.SecurityStatus>

io.helidon.security.SecurityResponse.SecurityStatus

All Implemented Interfaces:

Serializable, Comparable<SecurityResponse.SecurityStatus>

Enclosing class:

SecurityResponse

public static enum SecurityResponse.SecurityStatus
extends Enum<SecurityResponse.SecurityStatus>

Status of a security operation.

Enum Constant Summary

Enum Constants

Enum Constant	Description
ABSTAIN	Cannot process, not an error.
FAILURE	Indicates that the message processing by the security module was NOT successful.
FAILURE_FINISH	Failed and provider did everything to be done.
SUCCESS	Indicates that the message processing by the security component was successful and that the runtime is to proceed with its normal processing of the resulting message.
SUCCESS_FINISH	Succeeded and provider did everything to be done.

Method Summary

Modifier and Type	Method	Description
boolean	isSuccess()
static SecurityResponse.SecurityStatus	valueOf(String name)	Returns the enum constant of this type with the specified name.
static SecurityResponse.SecurityStatus[]	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

SUCCESS

public static final SecurityResponse.SecurityStatus SUCCESS

Indicates that the message processing by the security component was successful and that the runtime is to proceed with its normal processing of the resulting message. Example: authentication successful, continue with request processing.

SUCCESS_FINISH

public static final SecurityResponse.SecurityStatus SUCCESS_FINISH

Succeeded and provider did everything to be done. Finish processing (do nothing more in current flow). The provider should have:

• Updated entity (through SecurityRequest.responseEntity()
• Updated headers (through SecurityResponse.SecurityResponseBuilder.responseHeader(String, String)
• Updated status code (through SecurityResponse.SecurityResponseBuilder.statusCode(int)

FAILURE

public static final SecurityResponse.SecurityStatus FAILURE

Indicates that the message processing by the security module was NOT successful. Example: authorization failure

FAILURE_FINISH

public static final SecurityResponse.SecurityStatus FAILURE_FINISH

Failed and provider did everything to be done. Finish processing (do nothing more in current flow).

ABSTAIN

public static final SecurityResponse.SecurityStatus ABSTAIN

Cannot process, not an error.

Method Detail

values

public static SecurityResponse.SecurityStatus[] 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 (SecurityResponse.SecurityStatus c : SecurityResponse.SecurityStatus.values())
    System.out.println(c);

Returns:

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

valueOf

public static SecurityResponse.SecurityStatus 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

isSuccess

public boolean isSuccess()