org.springframework.boot.availability

Enum ReadinessState

java.lang.Object

java.lang.Enum<ReadinessState>

org.springframework.boot.availability.ReadinessState

All Implemented Interfaces:

Serializable, Comparable<ReadinessState>, AvailabilityState

public enum ReadinessState
extends Enum<ReadinessState>
implements AvailabilityState

"Readiness" state of the application.

An application is considered ready when it's live and willing to accept traffic. "Readiness" failure means that the application is not able to accept traffic and that the infrastructure should stop routing requests to it.

Since:

2.3.0

Author:

Brian Clozel

Enum Constant Summary

Enum Constants

Enum Constant and Description
ACCEPTING_TRAFFIC The application is ready to receive traffic.
REFUSING_TRAFFIC The application is not willing to receive traffic.

Method Summary

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

ACCEPTING_TRAFFIC

public static final ReadinessState ACCEPTING_TRAFFIC

The application is ready to receive traffic.

REFUSING_TRAFFIC

public static final ReadinessState REFUSING_TRAFFIC

The application is not willing to receive traffic.

Method Detail

values

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

Returns:

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

valueOf

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