org.dataone.service.types.v1

Class ReplicationPolicy

java.lang.Object

org.dataone.service.types.v1.ReplicationPolicy

All Implemented Interfaces:

Serializable

public class ReplicationPolicy
extends Object
implements Serializable

The *ReplicationPolicy* for an object defines if replication should be attempted for this object, and if so, how many replicas should be maintained. It also permits specification of preferred and blocked nodes as potential replication targets. Schema fragment(s) for this class:

 <xs:complexType xmlns:ns="http://ns.dataone.org/service/types/v1" xmlns:xs="http://www.w3.org/2001/XMLSchema" name="ReplicationPolicy">
   <xs:sequence>
     <xs:element type="ns:NodeReference" name="preferredMemberNode" minOccurs="0" maxOccurs="unbounded"/>
     <xs:element type="ns:NodeReference" name="blockedMemberNode" minOccurs="0" maxOccurs="unbounded"/>
   </xs:sequence>
   <xs:attribute type="xs:boolean" name="replicationAllowed"/>
   <xs:attribute type="xs:int" name="numberReplicas"/>
 </xs:complexType>
 

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected List<NodeReference>	blockedMemberNode
protected Integer	numberReplicas
protected List<NodeReference>	preferredMemberNode
protected Boolean	replicationAllowed

Constructor Summary

Constructors

Constructor and Description
ReplicationPolicy()

Method Summary

Methods

Modifier and Type	Method and Description
void	addBlockedMemberNode(NodeReference item) Add a 'blockedMemberNode' element item.
void	addPreferredMemberNode(NodeReference item) Add a 'preferredMemberNode' element item.
void	clearBlockedMemberNodeList() Remove all 'blockedMemberNode' element items.
void	clearPreferredMemberNodeList() Remove all 'preferredMemberNode' element items.
NodeReference	getBlockedMemberNode(int index) Get 'blockedMemberNode' element item by position.
List<NodeReference>	getBlockedMemberNodeList() Get the list of 'blockedMemberNode' element items.
Integer	getNumberReplicas() Get the 'numberReplicas' attribute value.
NodeReference	getPreferredMemberNode(int index) Get 'preferredMemberNode' element item by position.
List<NodeReference>	getPreferredMemberNodeList() Get the list of 'preferredMemberNode' element items.
Boolean	getReplicationAllowed() Get the 'replicationAllowed' attribute value.
void	setBlockedMemberNodeList(List<NodeReference> list) Set the list of 'blockedMemberNode' element items.
void	setNumberReplicas(Integer numberReplicas) Set the 'numberReplicas' attribute value.
void	setPreferredMemberNodeList(List<NodeReference> list) Set the list of 'preferredMemberNode' element items.
void	setReplicationAllowed(Boolean replicationAllowed) Set the 'replicationAllowed' attribute value.
int	sizeBlockedMemberNodeList() Get the number of 'blockedMemberNode' element items.
int	sizePreferredMemberNodeList() Get the number of 'preferredMemberNode' element items.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

preferredMemberNode

protected List<NodeReference> preferredMemberNode

blockedMemberNode

protected List<NodeReference> blockedMemberNode

replicationAllowed

protected Boolean replicationAllowed

numberReplicas

protected Integer numberReplicas

Constructor Detail

ReplicationPolicy

public ReplicationPolicy()

Method Detail

getPreferredMemberNodeList

public List<NodeReference> getPreferredMemberNodeList()

Get the list of 'preferredMemberNode' element items. Preferred Nodes are utilized over other nodes as replication targets, up to the number of replicas requested. If preferred nodes are unavailable, or if insufficient nodes are listed as preferred to meet the requested number of replicas, then the Coordinating Nodes will pick additional replica nodes for the content.

Returns:

list

setPreferredMemberNodeList

public void setPreferredMemberNodeList(List<NodeReference> list)

Set the list of 'preferredMemberNode' element items. Preferred Nodes are utilized over other nodes as replication targets, up to the number of replicas requested. If preferred nodes are unavailable, or if insufficient nodes are listed as preferred to meet the requested number of replicas, then the Coordinating Nodes will pick additional replica nodes for the content.

Parameters:

list -

sizePreferredMemberNodeList

public int sizePreferredMemberNodeList()

Get the number of 'preferredMemberNode' element items.

Returns:

count

addPreferredMemberNode

public void addPreferredMemberNode(NodeReference item)

Add a 'preferredMemberNode' element item.

Parameters:

item -

getPreferredMemberNode

public NodeReference getPreferredMemberNode(int index)

Get 'preferredMemberNode' element item by position.

Parameters:

index -

Returns:

item

clearPreferredMemberNodeList

public void clearPreferredMemberNodeList()

Remove all 'preferredMemberNode' element items.

getBlockedMemberNodeList

public List<NodeReference> getBlockedMemberNodeList()

Get the list of 'blockedMemberNode' element items. The object MUST never be replicated to nodes listed as *blockedMemberNodes*. Where there is a conflict between a preferredMemberNode* and a *blockedMemberNode* entry, the blockedMemberNode* entry prevails.

Returns:

list

setBlockedMemberNodeList

public void setBlockedMemberNodeList(List<NodeReference> list)

Set the list of 'blockedMemberNode' element items. The object MUST never be replicated to nodes listed as *blockedMemberNodes*. Where there is a conflict between a preferredMemberNode* and a *blockedMemberNode* entry, the blockedMemberNode* entry prevails.

Parameters:

list -

sizeBlockedMemberNodeList

public int sizeBlockedMemberNodeList()

Get the number of 'blockedMemberNode' element items.

Returns:

count

addBlockedMemberNode

public void addBlockedMemberNode(NodeReference item)

Add a 'blockedMemberNode' element item.

Parameters:

item -

getBlockedMemberNode

public NodeReference getBlockedMemberNode(int index)

Get 'blockedMemberNode' element item by position.

Parameters:

index -

Returns:

item

clearBlockedMemberNodeList

public void clearBlockedMemberNodeList()

Remove all 'blockedMemberNode' element items.

getReplicationAllowed

public Boolean getReplicationAllowed()

Get the 'replicationAllowed' attribute value. A boolean flag indicating if the object should be replicated (*true*, default) or not (*false*).

Returns:

value

setReplicationAllowed

public void setReplicationAllowed(Boolean replicationAllowed)

Set the 'replicationAllowed' attribute value. A boolean flag indicating if the object should be replicated (*true*, default) or not (*false*).

Parameters:

replicationAllowed -

getNumberReplicas

public Integer getNumberReplicas()

Get the 'numberReplicas' attribute value. An integer indicating the number of replicas targeted for this object. Defaults to 3.

Returns:

value

setNumberReplicas

public void setNumberReplicas(Integer numberReplicas)

Set the 'numberReplicas' attribute value. An integer indicating the number of replicas targeted for this object. Defaults to 3.

Parameters:

numberReplicas -