eu.planets_project.services.migrate
Interface MigrateAsync

All Superinterfaces:

PlanetsService

@MTOM
@StreamingAttachment(parseEagerly=true,
                     memoryThreshold=10485760L)
public interface MigrateAsync
extends PlanetsService

This is intended to become the generic migration interface for complex migration services. ******************* NOT IN SERVICE AT PRESENT ************************** It should: - Support service description to facilitate discovery. - Allow multiple input formats and output formats to be dealt with be the same service. - Allow parameters to be discovered and submitted to control the migration. - Allow digital objects composed of more than one file/bitstream. - Allow Files/bitstreams passed by value OR by reference. - Provide methods for asynchronous invocation.

Author:

Andy Jackson

Nested Class Summary

static class

MigrateAsync.AsyncStatus Enum to track the asynch process status

Field Summary

static String	NAME The interface name
static QName	QNAME The qualified name

Method Summary

MigrateResult	getMigrateAsyncResult(String ticket)
MigrateAsync.AsyncStatus	pollStatus(String ticket)
String	startMigrate(DigitalObject digitalObject, URI inputFormat, URI outputFormat, URL writeLocation, List<Parameter> parameters)

Methods inherited from interface eu.planets_project.services.PlanetsService

describe

Field Detail

NAME

static final String NAME

The interface name

See Also:

Constant Field Values

QNAME

static final QName QNAME

The qualified name

Method Detail

startMigrate

String startMigrate(DigitalObject digitalObject,
                    URI inputFormat,
                    URI outputFormat,
                    URL writeLocation,
                    List<Parameter> parameters)

Parameters:

digitalObject - The digital object to migrate

inputFormat - Format URI for the digital object path (migrate from)

outputFormat - Format URI for the desired ouput (migrate to)

writeLocation - a location (URL) to write the result to

parameters - extra parameters to control particular tools

Returns:

A new digital object, the result of migrating the given digital object

pollStatus

MigrateAsync.AsyncStatus pollStatus(String ticket)

Parameters:

ticket - The ticket

Returns:

the current status enum

getMigrateAsyncResult

MigrateResult getMigrateAsyncResult(String ticket)

Parameters:

ticket - The ticket

Returns:

the completed job MigrateResult