org.gatein.wsrp.consumer.migration

Interface MigrationService

All Known Implementing Classes:

InMemoryMigrationService

public interface MigrationService

Provides support for import/export operations.

Version:

$Revision$

Author:

Chris Laprun

Method Summary

Methods

Modifier and Type	Method and Description
void	add(ExportInfo info) Adds the specified ExportInfo to the set of ExportInfos managed by this MigrationService.
List<ExportInfo>	getAvailableExportInfos() Retrieves a list of available ExportInfo, i.e.
ExportInfo	getExportInfo(long exportTime) Retrieves the ExportInfo associated with the specified export time.
ConsumerStructureProvider	getStructureProvider() Accesses the ConsumerStructureProvider this MigrationService uses.
boolean	isAvailableExportInfosEmpty() Whether there are any available ExportInfos.
ExportInfo	remove(ExportInfo info) Removes the specified ExportInfo from the ones managed by this MigrationService.
void	setStructureProvider(ConsumerStructureProvider structureProvider) Provides a way to wire in a ConsumerStructureProvider.

Method Detail

getStructureProvider

ConsumerStructureProvider getStructureProvider()

Accesses the ConsumerStructureProvider this MigrationService uses.

Returns:

the ConsumerStructureProvider this MigrationService uses.

setStructureProvider

void setStructureProvider(ConsumerStructureProvider structureProvider)

Provides a way to wire in a ConsumerStructureProvider.

Parameters:

structureProvider - the ConsumerStructureProvider this MigrationService should be using

getAvailableExportInfos

List<ExportInfo> getAvailableExportInfos()

Retrieves a list of available ExportInfo, i.e. information about the result of previously run export operations.

Returns:

a list of available ExportInfo

getExportInfo

ExportInfo getExportInfo(long exportTime)

Retrieves the ExportInfo associated with the specified export time.

Parameters:

exportTime - the export time of the ExportInfo we want to retrieve

Returns:

the ExportInfo associated with the specified export time or null if no such ExportInfo exists

add

void add(ExportInfo info)

Adds the specified ExportInfo to the set of ExportInfos managed by this MigrationService.

Parameters:

info - the ExportInfo to add

remove

ExportInfo remove(ExportInfo info)

Removes the specified ExportInfo from the ones managed by this MigrationService.

Parameters:

info - the ExportInfo to remove

Returns:

the ExportInfo that was removed or null if the given ExportInfo wasn't managed by this MigrationService

isAvailableExportInfosEmpty

boolean isAvailableExportInfosEmpty()

Whether there are any available ExportInfos.

Returns:

true if this MigrationService manages some ExportInfo, false otherwise