org.dataone.service.cn.replication

Class MNReplicationTask

java.lang.Object

org.dataone.service.cn.replication.MNReplicationTask

All Implemented Interfaces:

Serializable, Callable<String>

public class MNReplicationTask
extends Object
implements Serializable, Callable<String>

A single replication task to be queued and executed by the Replication Service. The task is built from information found in the Replication Policy of an object's system metadata and from information about a target node's capabilities.

Author:

cjones

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static org.apache.log4j.Logger	log

Constructor Summary

Constructors

Constructor and Description
MNReplicationTask() Constructor - create an empty replication task instance
MNReplicationTask(String taskid, org.dataone.service.types.v1.Identifier pid, org.dataone.service.types.v1.NodeReference originatingNode, org.dataone.service.types.v1.NodeReference targetNode) Constructor - create a replication task instance

Method Summary

Modifier and Type	Method and Description
String	call() Implement the Callable interface, providing code that initiates replication.
String	getEventid() Get the event identifier
org.dataone.service.types.v1.NodeReference	getOriginatingNode() Get the originating node
String	getOriginatingNodeSubject() For the given Replication task, return the Subject listed in the target node.
org.dataone.service.types.v1.Identifier	getPid() Get the object identifier to be replicated
int	getRetryCount() Get the number of retries for this particular replication task;
org.dataone.service.types.v1.NodeReference	getTargetNode() Get the target node
String	getTargetNodeSubject() For the given Replication task, return the Subject listed in the target node.
String	getTaskid() Get the task identifier for this task
void	run() Implements the Runnable interface, but the task is actually called via the Callable interface.
void	setEventid(String eventid) Set the event identifier
void	setOriginatingNode(org.dataone.service.types.v1.NodeReference originatingNode) Set the originating node
void	setOriginatingNodeSubject(String subject) Set the target node subject identifying the node
void	setRetryCount(int retryCount) Set the number of retries for this particular replication task
void	setTargetNode(org.dataone.service.types.v1.NodeReference targetNode) Set the target node
void	setTargetNodeSubject(String subject) Set the target node subject identifying the node
void	setTaskid(String taskid) Set the task identifier for this task

Methods inherited from class java.lang.Object

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

Field Detail

log

public static org.apache.log4j.Logger log

Constructor Detail

MNReplicationTask

public MNReplicationTask()

Constructor - create an empty replication task instance

MNReplicationTask

public MNReplicationTask(String taskid,
                         org.dataone.service.types.v1.Identifier pid,
                         org.dataone.service.types.v1.NodeReference originatingNode,
                         org.dataone.service.types.v1.NodeReference targetNode)

Constructor - create a replication task instance

Parameters:

taskid -

pid -

targetNode -

Method Detail

getTaskid

public String getTaskid()

Get the task identifier for this task

Returns:

the taskid

setTaskid

public void setTaskid(String taskid)

Set the task identifier for this task

Parameters:

taskid - the taskid to set

getPid

public org.dataone.service.types.v1.Identifier getPid()

Get the object identifier to be replicated

Returns:

the pid

getEventid

public String getEventid()

Get the event identifier

Returns:

the eventid

setEventid

public void setEventid(String eventid)

Set the event identifier

Parameters:

eventid - the eventid to set

getTargetNode

public org.dataone.service.types.v1.NodeReference getTargetNode()

Get the target node

Returns:

the targetNode

setTargetNode

public void setTargetNode(org.dataone.service.types.v1.NodeReference targetNode)

Set the target node

Parameters:

targetNode - the targetNode to set

getOriginatingNode

public org.dataone.service.types.v1.NodeReference getOriginatingNode()

Get the originating node

Returns:

the originatingNode

setOriginatingNode

public void setOriginatingNode(org.dataone.service.types.v1.NodeReference originatingNode)

Set the originating node

Parameters:

originatingNode - the originatingNode to set

getTargetNodeSubject

public String getTargetNodeSubject()

For the given Replication task, return the Subject listed in the target node. Usually used in authorizing a replication event.

Returns:

subject - the subject listed in the target Node object as a string

setTargetNodeSubject

public void setTargetNodeSubject(String subject)

Set the target node subject identifying the node

Parameters:

subject - the targetNode subject

getOriginatingNodeSubject

public String getOriginatingNodeSubject()

For the given Replication task, return the Subject listed in the target node. Usually used in authorizing a replication event.

Returns:

subject - the subject listed in the target Node object as a string

setOriginatingNodeSubject

public void setOriginatingNodeSubject(String subject)

Set the target node subject identifying the node

Parameters:

subject - the targetNode subject

call

public String call()

Implement the Callable interface, providing code that initiates replication.

Specified by:

call in interface Callable<String>

Returns:

pid - the identifier of the replicated object upon success

run

public void run()

Implements the Runnable interface, but the task is actually called via the Callable interface. This is needed as a placeholder to handle rejected tasks via the RejectedReplicationTaskHandler class.

setRetryCount

public void setRetryCount(int retryCount)

Set the number of retries for this particular replication task

Parameters:

retryCount -

getRetryCount

public int getRetryCount()

Get the number of retries for this particular replication task;

Returns:

retryCount the number of retries for this replication task