org.springframework.cloud.aws.jdbc.retry

Enum InstanceStatus

java.lang.Object

java.lang.Enum<InstanceStatus>

org.springframework.cloud.aws.jdbc.retry.InstanceStatus

All Implemented Interfaces:

Serializable, Comparable<InstanceStatus>

public enum InstanceStatus
extends Enum<InstanceStatus>

Enumeration that holds all possible Amazon RDS database instance states. Used by client code to check if the database is available at all, and to verify if a retry is useful.

Since:

1.0

Author:

Agim Emruli

Enum Constant Summary

Enum Constants

Enum Constant and Description
AVAILABLE Database state that defines that the database is available.
CREATING Database state that is available during creation of the database.
DELETING Database state which defines that the database is deleting.
MODIFYING Database state which defines that the database instance is modifying.
REBOOTING Database state which defines that the database instance is rebooting.
UNKNOWN Unknown status, which assumes the database is not available and not retryable.

Method Summary

Modifier and Type	Method and Description
boolean	isAvailable() Operation that returns true if the database is available from the Amazon RDS perspective.
boolean	isRetryable() Operation that returns true if a second call will likely succeed.
static InstanceStatus	valueOf(String name) Returns the enum constant of this type with the specified name.
static InstanceStatus[]	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

CREATING

public static final InstanceStatus CREATING

Database state that is available during creation of the database. This is typically the case if the database is started at the same time like the application is bootstrapped. In this case a retry will succeed.

AVAILABLE

public static final InstanceStatus AVAILABLE

Database state that defines that the database is available. The database can be used at all, also a retry for a temporary problem (like a dead-lock) is likely to succeed if called twice.

REBOOTING

public static final InstanceStatus REBOOTING

Database state which defines that the database instance is rebooting. This can happen during a user initiated reboot. A second attempt is likely to succeed especially in the combination with a replicated Multi A/Z instance.

MODIFYING

public static final InstanceStatus MODIFYING

Database state which defines that the database instance is modifying. The database is still available and usable, but a modification is in progress. This can be the case if an read-replica instance is added to the database itself.

DELETING

public static final InstanceStatus DELETING

Database state which defines that the database is deleting. Thus it is assumed that is is deleted.

UNKNOWN

public static final InstanceStatus UNKNOWN

Unknown status, which assumes the database is not available and not retryable.

Method Detail

values

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

Returns:

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

valueOf

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

isRetryable

public boolean isRetryable()

Operation that returns true if a second call will likely succeed. This is typically the case if the database is down for temporary reasons like a reboot after a configuration change, or a multi a/z failover until the DNS record is updated. Clients should wait some time (e.g. up until 3 minutes) before retrying their last database operation.

Returns:

true if the operation is retryable, false otherwise

isAvailable

public boolean isAvailable()

Operation that returns true if the database is available from the Amazon RDS perspective. That does not necessarily mean that there is a connection possible to that database itself. Due to wrong/missing rule in the security credentials it might be possible that a database is available but not connectible through the JDBC protocol.

Returns:

true if the database is available, false otherwise