org.dataone.service.types.v1

Enum ReplicationStatus

java.lang.Object

java.lang.Enum<ReplicationStatus>

org.dataone.service.types.v1.ReplicationStatus

All Implemented Interfaces:

Serializable, Comparable<ReplicationStatus>

public enum ReplicationStatus
extends Enum<ReplicationStatus>
implements Serializable

An enumerated string value indicating the current state of a replica of an object. When an object identified needs to be replicated, it is added to the replication task queue and is marked as queued*; a CN will pick up that task and request that it be replicated to a MN and marks that it as *requested*; when a MN finishes replicating the object, it informs the CN that it is finished and it is marked as completed*. If an MN is unable to complete replication, the replication status is marked as *failed*.Periodically a CN checks each replica to be sure it is both available and valid (matching checksum with original), and if it is either inaccessible or invalid then it marks it as *invalidated*, which indicates that the object replication needs to be invoked again.The replication process is described in Use Case 09 (:doc:`/design/UseCases/09_uc`). Schema fragment(s) for this class:

 <xs:simpleType xmlns:ns="http://ns.dataone.org/service/types/v1" xmlns:xs="http://www.w3.org/2001/XMLSchema" name="ReplicationStatus">
   <xs:restriction base="xs:string">
     <xs:enumeration value="queued"/>
     <xs:enumeration value="requested"/>
     <xs:enumeration value="completed"/>
     <xs:enumeration value="failed"/>
     <xs:enumeration value="invalidated"/>
   </xs:restriction>
 </xs:simpleType>
 

Enum Constant Summary

Enum Constants

Enum Constant and Description
COMPLETED
FAILED
INVALIDATED
QUEUED
REQUESTED

Method Summary

Methods

Modifier and Type	Method and Description
static ReplicationStatus	convert(String value)
static ReplicationStatus	valueOf(String name) Returns the enum constant of this type with the specified name.
static ReplicationStatus[]	values() Returns an array containing the constants of this enum type, in the order they are declared.
String	xmlValue()

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

QUEUED

public static final ReplicationStatus QUEUED

REQUESTED

public static final ReplicationStatus REQUESTED

COMPLETED

public static final ReplicationStatus COMPLETED

FAILED

public static final ReplicationStatus FAILED

INVALIDATED

public static final ReplicationStatus INVALIDATED

Method Detail

values

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

Returns:

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

valueOf

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

xmlValue

public String xmlValue()

convert

public static ReplicationStatus convert(String value)