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

java.lang.Object
  java.lang.Enum<ServiceEndpointStatus>
      org.kuali.rice.ksb.api.registry.ServiceEndpointStatus

All Implemented Interfaces:

Serializable, Comparable<ServiceEndpointStatus>, 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)

Enum Constant Summary

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.

ONLINE
Indicates the service is online and available to receieve requests.

Method Summary

static ServiceEndpointStatus	fromCode(String code) Returns the endpoint status for the given status code.
String	getCode() The code value for this object.
static ServiceEndpointStatus	valueOf(String name) Returns the enum constant of this type with the specified name.
static ServiceEndpointStatus[]	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

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 Detail

values

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

Returns:

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

valueOf

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

getCode

public String getCode()

Description copied from interface: Coded

The code value for this object. In general a code value cannot be null or a blank string.

Specified by:

getCode in interface Coded

Returns:

the code value for this object.

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