org.duracloud.snapshot.service

Interface SnapshotManager

public interface SnapshotManager

Author:

Daniel Bernstein Date: Jul 30, 2014

Method Summary

Methods

Modifier and Type	Method and Description
Snapshot	addAlternateSnapshotIds(Snapshot snapshot, List<String> alternateIds) Adds a list of snapshot alternate Id's to a snapshot.
void	addContentItem(Snapshot snapshot, String contentId, Map<String,String> props)
void	deleteSnapshot(String snapshotId)
void	finalizeSnapshots() This method runs through any snapshots with a status of CLEANING_UP and checks if the corresponding space is empty.
Snapshot	transferError(String snapshotId, String errorDetails) Notifies the bridge that the snapshot transfer action failed to complete due to an error condition.
Snapshot	transferToDpnNodeComplete(String snapshotId) Notifies the bridge that the snapshot's transfer to DPN node is complete.
Snapshot	updateHistory(Snapshot snapshot, String history) Updates a snapshot's DPN history

Method Detail

addContentItem

void addContentItem(Snapshot snapshot,
                  String contentId,
                  Map<String,String> props)
                    throws SnapshotException

Parameters:

snapshot -

contentId -

props -

Throws:

SnapshotException

addAlternateSnapshotIds

Snapshot addAlternateSnapshotIds(Snapshot snapshot,
                               List<String> alternateIds)
                                 throws AlternateIdAlreadyExistsException

Adds a list of snapshot alternate Id's to a snapshot. To map DPN Bag Id's to Duracloud Snapshot Id's

Parameters:

snapshot -

alternateIds -

Returns:

Throws:

AlternateIdAlreadyExistsException

transferToDpnNodeComplete

Snapshot transferToDpnNodeComplete(String snapshotId)
                                   throws SnapshotException

Notifies the bridge that the snapshot's transfer to DPN node is complete. This call is initiated via the bridge REST API by the entity retrieving the snapshot from bridge storage.

Parameters:

snapshotId -

Throws:

SnapshotException

transferError

Snapshot transferError(String snapshotId,
                     String errorDetails)
                       throws SnapshotException

Notifies the bridge that the snapshot transfer action failed to complete due to an error condition. This call is initiated via the bridge REST API by the entity retrieving the snapshot from bridge storage.

Parameters:

snapshotId -

errorDetails -

Returns:

Throws:

SnapshotException

finalizeSnapshots

void finalizeSnapshots()

This method runs through any snapshots with a status of CLEANING_UP and checks if the corresponding space is empty. If so, the state is updated to complete and notification is sent out to the user.

updateHistory

Snapshot updateHistory(Snapshot snapshot,
                     String history)

Updates a snapshot's DPN history

Parameters:

snapshot -

history -

Returns:

the altered snapshot

deleteSnapshot

void deleteSnapshot(String snapshotId)