Package org.kuali.rice.ksb.api.registry

Enum Class ServiceEndpointStatus

java.lang.Object

java.lang.Enum<ServiceEndpointStatus>

org.kuali.rice.ksb.api.registry.ServiceEndpointStatus

All Implemented Interfaces:

Serializable, Comparable<ServiceEndpointStatus>, Constable, Coded

public enum ServiceEndpointStatus
extends Enum<ServiceEndpointStatus>
implements Coded

Defines the possible statuses for a service endpoint in the KSB registry.

Author:

Kuali Rice Team (rice.collab@kuali.org)

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
DISABLED	Indicates the service has been disabled because the registry has detected that it, or it's host instance is defective or not processing requests properly.
OFFLINE	Indicates the service has been taken offline, most likely as the result of the instance hosting the service being taken offline (i.e. for maintenance or otherwise)
ONLINE	Indicates the service is online and available to receieve requests.

Method Summary

Modifier and Type	Method	Description
static ServiceEndpointStatus	fromCode(String code)	Returns the endpoint status for the given status code.
String	getCode()
static ServiceEndpointStatus	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ServiceEndpointStatus[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

ONLINE

public static final ServiceEndpointStatus ONLINE

Indicates the service is online and available to receieve requests.

OFFLINE

public static final ServiceEndpointStatus OFFLINE

Indicates the service has been taken offline, most likely as the result of the instance hosting the service being taken offline (i.e. for maintenance or otherwise)

DISABLED

public static final ServiceEndpointStatus DISABLED

Indicates the service has been disabled because the registry has detected that it, or it's host instance is defective or not processing requests properly.

Method Details

values

public static ServiceEndpointStatus[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static ServiceEndpointStatus valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

getCode

public String getCode()

Specified by:

getCode in interface Coded

fromCode

public static ServiceEndpointStatus fromCode(String code)

Returns the endpoint status for the given status code. This method will return null if the given code value is null.

Parameters:

code - the code for which to locate the ServiceEndpointStatus

Returns:

the ServiceEndpointStatus which has the given code, or null if the given code value was null

Throws:

IllegalArgumentException - if an endpoint status does not match the given code