org.dataone.service.types.v1

Class NodeReplicationPolicy

java.lang.Object

org.dataone.service.types.v1.NodeReplicationPolicy

All Implemented Interfaces:

Serializable

public class NodeReplicationPolicy
extends Object
implements Serializable

The overall replication policy for the node that expresses constraints on object size, total objects, source nodes, and object format types. A node may choose to restrict replication from only certain peer nodes, may have file size limits, total allocated size limits, or may want to focus on being a :term:`replication target` for domain-specific object formats. 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="NodeReplicationPolicy">
   <xs:sequence>
     <xs:element type="xs:long" name="maxObjectSize" minOccurs="0" maxOccurs="1"/>
     <xs:element type="xs:long" name="spaceAllocated" minOccurs="0" maxOccurs="1"/>
     <xs:element type="ns:NodeReference" name="allowedNode" minOccurs="0" maxOccurs="unbounded"/>
     <xs:element type="ns:ObjectFormatIdentifier" name="allowedObjectFormat" minOccurs="0" maxOccurs="unbounded"/>
   </xs:sequence>
 </xs:complexType>
 

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected List<NodeReference>	allowedNode
protected List<ObjectFormatIdentifier>	allowedObjectFormat
protected BigInteger	maxObjectSize
protected BigInteger	spaceAllocated

Constructor Summary

Constructors

Constructor and Description
NodeReplicationPolicy()

Method Summary

Methods

Modifier and Type	Method and Description
void	addAllowedNode(NodeReference item) Add a 'allowedNode' element item.
void	addAllowedObjectFormat(ObjectFormatIdentifier item) Add a 'allowedObjectFormat' element item.
void	clearAllowedNodeList() Remove all 'allowedNode' element items.
void	clearAllowedObjectFormatList() Remove all 'allowedObjectFormat' element items.
NodeReference	getAllowedNode(int index) Get 'allowedNode' element item by position.
List<NodeReference>	getAllowedNodeList() Get the list of 'allowedNode' element items.
ObjectFormatIdentifier	getAllowedObjectFormat(int index) Get 'allowedObjectFormat' element item by position.
List<ObjectFormatIdentifier>	getAllowedObjectFormatList() Get the list of 'allowedObjectFormat' element items.
BigInteger	getMaxObjectSize() Get the 'maxObjectSize' element value.
BigInteger	getSpaceAllocated() Get the 'spaceAllocated' element value.
void	setAllowedNodeList(List<NodeReference> list) Set the list of 'allowedNode' element items.
void	setAllowedObjectFormatList(List<ObjectFormatIdentifier> list) Set the list of 'allowedObjectFormat' element items.
void	setMaxObjectSize(BigInteger maxObjectSize) Set the 'maxObjectSize' element value.
void	setSpaceAllocated(BigInteger spaceAllocated) Set the 'spaceAllocated' element value.
int	sizeAllowedNodeList() Get the number of 'allowedNode' element items.
int	sizeAllowedObjectFormatList() Get the number of 'allowedObjectFormat' element items.

Methods inherited from class java.lang.Object

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

Field Detail

maxObjectSize

protected BigInteger maxObjectSize

spaceAllocated

protected BigInteger spaceAllocated

allowedNode

protected List<NodeReference> allowedNode

allowedObjectFormat

protected List<ObjectFormatIdentifier> allowedObjectFormat

Constructor Detail

NodeReplicationPolicy

public NodeReplicationPolicy()

Method Detail

getMaxObjectSize

public BigInteger getMaxObjectSize()

Get the 'maxObjectSize' element value. An optional statement of the maximum size in octets (8-bit bytes) of objects this node is willing to accept for replication.

Returns:

value

setMaxObjectSize

public void setMaxObjectSize(BigInteger maxObjectSize)

Set the 'maxObjectSize' element value. An optional statement of the maximum size in octets (8-bit bytes) of objects this node is willing to accept for replication.

Parameters:

maxObjectSize -

getSpaceAllocated

public BigInteger getSpaceAllocated()

Get the 'spaceAllocated' element value. An optional statement of the total space in bytes allocated for replication object storage on this node.

Returns:

value

setSpaceAllocated

public void setSpaceAllocated(BigInteger spaceAllocated)

Set the 'spaceAllocated' element value. An optional statement of the total space in bytes allocated for replication object storage on this node.

Parameters:

spaceAllocated -

getAllowedNodeList

public List<NodeReference> getAllowedNodeList()

Get the list of 'allowedNode' element items. An optional, repeatable statement of a peer source node from which this node is willing to replicate content, expressed as a :class:`Types.NodeReference`.

Returns:

list

setAllowedNodeList

public void setAllowedNodeList(List<NodeReference> list)

Set the list of 'allowedNode' element items. An optional, repeatable statement of a peer source node from which this node is willing to replicate content, expressed as a :class:`Types.NodeReference`.

Parameters:

list -

sizeAllowedNodeList

public int sizeAllowedNodeList()

Get the number of 'allowedNode' element items.

Returns:

count

addAllowedNode

public void addAllowedNode(NodeReference item)

Add a 'allowedNode' element item.

Parameters:

item -

getAllowedNode

public NodeReference getAllowedNode(int index)

Get 'allowedNode' element item by position.

Parameters:

index -

Returns:

item

clearAllowedNodeList

public void clearAllowedNodeList()

Remove all 'allowedNode' element items.

getAllowedObjectFormatList

public List<ObjectFormatIdentifier> getAllowedObjectFormatList()

Get the list of 'allowedObjectFormat' element items. An optional, repeatable statement of an object format that this node is willing to replicate, expressed as a :class:`Types.ObjectFormatIdentifier`.

Returns:

list

setAllowedObjectFormatList

public void setAllowedObjectFormatList(List<ObjectFormatIdentifier> list)

Set the list of 'allowedObjectFormat' element items. An optional, repeatable statement of an object format that this node is willing to replicate, expressed as a :class:`Types.ObjectFormatIdentifier`.

Parameters:

list -

sizeAllowedObjectFormatList

public int sizeAllowedObjectFormatList()

Get the number of 'allowedObjectFormat' element items.

Returns:

count

addAllowedObjectFormat

public void addAllowedObjectFormat(ObjectFormatIdentifier item)

Add a 'allowedObjectFormat' element item.

Parameters:

item -

getAllowedObjectFormat

public ObjectFormatIdentifier getAllowedObjectFormat(int index)

Get 'allowedObjectFormat' element item by position.

Parameters:

index -

Returns:

item

clearAllowedObjectFormatList

public void clearAllowedObjectFormatList()

Remove all 'allowedObjectFormat' element items.