oracle.ide.db.transfer

Class TransferManager

java.lang.Object

oracle.ide.db.transfer.TransferManager

public final class TransferManager
extends java.lang.Object

Manage the transfer of database objects.

The source can be:

• An Offline Database
• A Database

The targets (there may be several) can be

• A Database
• An Offline Database
• A SQL script

Create a TransferDescriptor to describe the transfer. Then invoke #prepareAndTransfer(transferDescriptor)

The transfer descriptor describes:

• The source provider
• The target provider
• The database objects to transfer
• The transfer policy - this describes how to copy the transfered objects. This makes sure that any existing objects in the target are dealt with correctly.
• Transfer targets - classes which create the objects in the target.

Constructor Summary

Constructors

Constructor and Description
TransferManager() Deprecated. use getInstance()

Method Summary

Modifier and Type	Method and Description
TransferDescriptor	createDescriptor(DBObjectProvider source, DBObjectProvider target) Creates a TransferDescriptor that will transfer objects from the given source provider to the given target provider.
TransferDescriptor	createDescriptor(java.lang.String sourceProviderType, java.lang.String transferTargetID) Creates a TransferDescriptor that will transfer objects from the given source provider type to the given transfer target (identified by its transfer target id).
static TransferManager	getInstance() Gets the TransferManager that can be used to create, prepare and transfer descriptors.
void	prepare(TransferDescriptor td) Prepare to transfer objects.
SystemObject[]	prepareAndTransfer(TransferDescriptor td) Transfer the objects as described by the TransferDescriptor.
SystemObject[]	transfer(TransferDescriptor td) Do the transfers described by the TransferDescriptor.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TransferManager

@Deprecated
public TransferManager()

Deprecated. use getInstance()

Method Detail

getInstance

public static TransferManager getInstance()

Gets the TransferManager that can be used to create, prepare and transfer descriptors.

createDescriptor

public TransferDescriptor createDescriptor(DBObjectProvider source,
                                           DBObjectProvider target)

Creates a TransferDescriptor that will transfer objects from the given source provider to the given target provider.

Parameters:

source - the source provider

target - the target provider

createDescriptor

public TransferDescriptor createDescriptor(java.lang.String sourceProviderType,
                                           java.lang.String transferTargetID)

Creates a TransferDescriptor that will transfer objects from the given source provider type to the given transfer target (identified by its transfer target id).

Parameters:

sourceProviderType - the source provider type (e.g. "db" or "offlinedb".

transferTargetID - the id of the target for transfer.

prepare

public void prepare(TransferDescriptor td)
             throws TransferFailedException

Prepare to transfer objects. The transfer is described by the the transfer descriptor. 1. get source objects 2. instantiate and invoke the transfer policy We now have: .. source objects - no longer interesting .. transfer objects - all ready to transfer .. existing objects - handy for reconcile

Parameters:

td -

Throws:

TransferFailedException

transfer

public SystemObject[] transfer(TransferDescriptor td)
                        throws TransferFailedException

Do the transfers described by the TransferDescriptor. This method expects the preparatory work to have been done

Returns:

the transfered objects

Throws:

TransferCancelledException - if the transfer is cancelled

TransferFailedException - if the transfer fails

See Also:

prepare(oracle.ide.db.transfer.TransferDescriptor)

prepareAndTransfer

public SystemObject[] prepareAndTransfer(TransferDescriptor td)
                                  throws TransferFailedException

Transfer the objects as described by the TransferDescriptor. A transfer is divded into two stages, prepare and transfer, this method performs both stages (i.e. the whole operation) at once.

Parameters:

td - the descriptor for the transfer

Returns:

the objects in the target that have been succesfully transfered

Throws:

TransferFailedException - if the transfer failed

TransferCancelledException - if the transfer was cancelled