com.businessobjects.sdk.biar
Interface ILiveToLivePipe

All Superinterfaces:

ICancelable

public interface ILiveToLivePipe
extends ICancelable

This class represents a live-to-live transfer. The transfer consists of an export and a mated, concurrently-running, in-progress import that form the two ends of the pipe.

A IExporter retrieved from ILiveToLivePipe.getExporter() can be used to place info objects into the pipe, where they are transfered to the destination system. The transfer completes sometime after export is finished (by calling IExporter.finish()). To test for completion, make use of the java.lang.concurrent.Future returned by ILiveToLivePipe.getResult(). It is unsafe to make use of the destination IObjectManager except when this Future completes.

A live-to-live pipe consumes various resources and should be disposed of using ILiveToLivePipe.dispose() when it will no longer be used. Disposing of a transfer in progress will abort the transfer. It is safe to dispose of a pipe after the transfer is complete.

See Also:

IObjectManager, IObjectManager.liveImport(IEnterpriseSession, IExportOptions, IImportOptions)}, BIARFactory.createLiveToLivePipe(IEnterpriseSession, IEnterpriseSession, IExportOptions, IImportOptions)

Method Summary

void	dispose() Disposes of the pipe, releasing all resources.
IExporter	getExporter() Gets the IExporter used to export objects from the source system.
java.util.concurrent.Future	getResult() Get a java.lang.concurrent.Future representing the calculated result of the live-to-live transfer.

Methods inherited from interface com.businessobjects.sdk.biar.ICancelable

cancel

Method Detail

getExporter

IExporter getExporter()

Gets the IExporter used to export objects from the source system. Repeated calls return the same exporter.

Returns:

the IExporter for exporting from the source system.

getResult

java.util.concurrent.Future getResult()

Get a java.lang.concurrent.Future representing the calculated result of the live-to-live transfer. The result value is an IObjectManager containing the transfered objects.

Returns:

the future result of the transfer.

dispose

void dispose()
             throws BIARException

Disposes of the pipe, releasing all resources. Any in-progress transfer is aborted.

Throws:

BIARException - if the operation fails.