uk.co.visalia.brightpearl.apiclient.config

Enum ExpiredAuthTokenStrategy

java.lang.Object

java.lang.Enum<ExpiredAuthTokenStrategy>

uk.co.visalia.brightpearl.apiclient.config.ExpiredAuthTokenStrategy

All Implemented Interfaces:

Serializable, Comparable<ExpiredAuthTokenStrategy>

public enum ExpiredAuthTokenStrategy
extends Enum<ExpiredAuthTokenStrategy>

A setting for the BrightpearlLegacyApiSession, this determines whether the session should attempt to reauthenticate with configured credentials when a 401 Unauthorized response is received from the Brightpearl API, which indicates the auth token has expired.

Enum Constant Summary

Enum Constants

Enum Constant and Description
FAIL Throw BrightpearlAuthException when 401 responses are received.
REAUTHENTICATE Attempt reauthentication when a 401 response is received and credentials are configured.

Method Summary

Methods

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

REAUTHENTICATE

public static final ExpiredAuthTokenStrategy REAUTHENTICATE

Attempt reauthentication when a 401 response is received and credentials are configured.

FAIL

public static final ExpiredAuthTokenStrategy FAIL

Throw BrightpearlAuthException when 401 responses are received.

Method Detail

values

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

Returns:

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

valueOf

public static ExpiredAuthTokenStrategy 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