TransmitAIP (DSpace Replication Task Suite 7.1 API)

java.lang.Object
- org.dspace.curate.AbstractCurationTask
- - org.dspace.ctask.replicate.TransmitAIP

All Implemented Interfaces:

org.dspace.curate.CurationTask

Direct Known Subclasses:

TransmitSingleAIP
```
@Suspendable(invoked=INTERACTIVE)
public class TransmitAIP
extends org.dspace.curate.AbstractCurationTask
```
TransmitAIP task creates an AIP suitable for replication, and forwards it to the replication system for transmission (upload).
The type of AIP produced is based on the 'packer.pkgtype' setting in 'replicate.cfg'. See the org.dspace.pack.PackerFactory for more info.
This task is "suspendable" when invoked from the UI. If a single AIP fails to be generated and transmitted to storage, we should inform the user ASAP. We wouldn't want them to assume everything was transferred successfully, if there were actually underlying errors.
Note that this task has a companion task called TransmitSingleAIP which ensures that no child/member objects are transmitted.

Author:

richardrodgers

See Also:

PackerFactory, TransmitSingleAIP

Field Summary
- Fields inherited from class org.dspace.curate.AbstractCurationTask
  communityService, configurationService, curator, handleService, itemService, taskId

Constructor Summary

Constructors
Constructor Description

TransmitAIP()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`init(org.dspace.curate.Curator curator, String taskId)`
`int`	`perform(org.dspace.content.DSpaceObject dso)`	Perform 'Transmit AIP' task

Methods inherited from class org.dspace.curate.AbstractCurationTask
dereference, distribute, perform, performItem, performObject, report, setResult, taskArrayProperty, taskBooleanProperty, taskIntProperty, taskLongProperty, taskProperty

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - TransmitAIP
```
public TransmitAIP()
```
- Method Detail
  - init
```
public void init(org.dspace.curate.Curator curator,
                 String taskId)
          throws IOException
```
    Specified by:
    
    init in interface org.dspace.curate.CurationTask
    
    Overrides:
    
    init in class org.dspace.curate.AbstractCurationTask
    
    Throws:
    
    IOException
  - perform
```
public int perform(org.dspace.content.DSpaceObject dso)
            throws IOException
```
    Perform 'Transmit AIP' task
    Actually generates the AIP and transmits it to the replica ObjectStore
    
    Specified by:
    
    perform in interface org.dspace.curate.CurationTask
    
    Specified by:
    
    perform in class org.dspace.curate.AbstractCurationTask
    
    Parameters:
    
    dso - DSpace Object to perform on
    
    Returns:
    
    integer which represents Curator return status
    
    Throws:
    
    IOException - if I/O error