com.atlassian.asap.service.api

Enum TokenValidator.Policy

java.lang.Object

java.lang.Enum<TokenValidator.Policy>

com.atlassian.asap.service.api.TokenValidator.Policy

All Implemented Interfaces:

Serializable, Comparable<TokenValidator.Policy>

Enclosing interface:

TokenValidator

public static enum TokenValidator.Policy
extends Enum<TokenValidator.Policy>

Specifies the desired enforcement policy for ASAP authentication.

Enum Constant Summary

Enum Constants

Enum Constant and Description
IGNORE Specifies that attempts to perform ASAP authentication with this resource should be silently ignored.
OPTIONAL Specifies that ASAP authentication is optional, but will be enforced exactly as it would for the REQUIRE policy whenever a suitable Authorization header is present.
REJECT Specifies that attempts to perform ASAP authentication with this resource should be actively rejected.
REQUIRE Specifies that ASAP authentication is required.

Method Summary

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

REJECT

public static final TokenValidator.Policy REJECT

Specifies that attempts to perform ASAP authentication with this resource should be actively rejected.

This policy is intended to prohibit ASAP authentication when that ability might otherwise have been inherited from some other source, such as a superclass or package annotation.

Note that since this policy refuses all ASAP tokens regardless of their contents, tokens are not passed through their normal validity checks. Any token received is assumed to pass authentication and rejected as unauthorized, instead.

IGNORE

public static final TokenValidator.Policy IGNORE

Specifies that attempts to perform ASAP authentication with this resource should be silently ignored.

This annotation is intended to ignore ASAP authentication when that ability might otherwise have been inherited from some other source, such as a superclass or package annotation. The validator will always ABSTAIN from the decision and will not attempt to examine the Authorization header in any way.

OPTIONAL

public static final TokenValidator.Policy OPTIONAL

Specifies that ASAP authentication is optional, but will be enforced exactly as it would for the REQUIRE policy whenever a suitable Authorization header is present.

This permits alternative forms of authentication and/or anonymous request processing to be used. The resource is responsible for arranging whatever additional annotations and/or access filtering might be needed.

Note that the only difference between OPTIONAL and REQUIRED is how the complete absence of an ASAP token is handled, with this policy returning ABSTAIN instead of NOT_AUTHENTICATED for that specific case. In particular, a client cannot attempt ASAP authentication, fail at it, and then proceed anonymously. If an ASAP token is provided, then it must meet all the necessary requirements, or the request will be rejected.

REQUIRE

public static final TokenValidator.Policy REQUIRE

Specifies that ASAP authentication is required.

If no authentication token is provided or if it does not satisfy the restrictions specified by the annotation, then the request should be actively rejected.

Method Detail

values

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

Returns:

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

valueOf

public static TokenValidator.Policy 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