oracle.ide.db.transfer

Interface TransferPolicy

public interface TransferPolicy

Interface for the classes which copy objects for transfer.

Given the source DBObjectProvider, target DBObjectProvider and array of source object descriptors it has to:

1. Find existing objects in target
2. Copy existing objects
3. Set up the copy for transfer.
   This step sets the ID's so that they can be reconciled with the existing objects.

Method Summary

Modifier and Type	Method and Description
boolean	canTransfer(TransferDescriptor transferDescriptor, SystemObject systemObject) Check that it is OK to transfer the object.
void	checkSourceAndTargetCompatability(TransferDescriptor td, boolean allowChange) Check that the databases in the transfer are compatible.
SystemObject[]	copyForTransfer(TransferDescriptor td, SystemObject[] existingObjects) Copy the objects for transfer.
Difference	filterDiff(TransferDescriptor td, Difference diff) Filter the differences to remove any which are not applicable to the transfer policy.
SystemObject[]	findExistingObjects(TransferDescriptor td) Find any existing objects in the transfer target.
ResultSet	getDifferences(TransferDescriptor td, SystemObject[] existingObjects, SystemObject[] copiedObjects) Get a ResultSet describing the differences between any existing objects and the objects which have been copied for transfer.
TransferController	getTransferController() Return the TransferController for the TransferPolicy.
void	initializeTransfer(TransferDescriptor td) Generic initialization that is called from prepare to transfer, allowing any policy to tweak the descriptor (and perform any required action like connection copy) before anything actually happens.

Method Detail

findExistingObjects

SystemObject[] findExistingObjects(TransferDescriptor td)
                            throws TransferFailedException

Find any existing objects in the transfer target.

Parameters:

td - the descriptor for the transfer

Returns:

an array of existing objects that matches up to the array of descriptors in the TransferDescriptor

Throws:

TransferFailedException - if there is a problem finding the existing objects that is unrecoverable

copyForTransfer

SystemObject[] copyForTransfer(TransferDescriptor td,
                               SystemObject[] existingObjects)
                        throws TransferFailedException

Copy the objects for transfer. The copy policy used will endeavour to set the copy IDs to match any existing IDs. The copy policy will build a Map of the original ids and the copy ids

Parameters:

td - the descriptor for the transfer

existingObjects - the objects that exist in the target as discovered by findExistingObjects

Returns:

an array of objects ready to be given to the transfer target.

Throws:

TransferFailedException - if the copy operation fails

getDifferences

ResultSet getDifferences(TransferDescriptor td,
                         SystemObject[] existingObjects,
                         SystemObject[] copiedObjects)

Get a ResultSet describing the differences between any existing objects and the objects which have been copied for transfer.

Parameters:

existingObjects - the objects already in the transfer target

copiedObjects - the objects that have been prepared to be transfered to the target

Returns:

a ResultSet containing the differences between the two sets of objects

filterDiff

Difference filterDiff(TransferDescriptor td,
                      Difference diff)

Filter the differences to remove any which are not applicable to the transfer policy.

Parameters:

td -

diff - a ResultSet containing the differences between the two sets of objects

Returns:

checkSourceAndTargetCompatability

void checkSourceAndTargetCompatability(TransferDescriptor td,
                                       boolean allowChange)
                                throws TransferFailedException

Check that the databases in the transfer are compatible. The implementation may make them compatible (for example an empty offline database). If the databases are not compatible, and the implementation cannot, or chooses not to make them compatible, a TransferFailedException is thrown.

Parameters:

td -

allowChange - - if false, no attempt is made to make the database compatible.

Throws:

TransferFailedException

canTransfer

boolean canTransfer(TransferDescriptor transferDescriptor,
                    SystemObject systemObject)
             throws TransferFailedException

Check that it is OK to transfer the object.

Parameters:

transferDescriptor -

systemObject - the object to transfer

Returns:

true if this object can be included in the transfer

Throws:

TransferFailedException

getTransferController

TransferController getTransferController()

Return the TransferController for the TransferPolicy.

initializeTransfer

void initializeTransfer(TransferDescriptor td)
                 throws TransferFailedException

Generic initialization that is called from prepare to transfer, allowing any policy to tweak the descriptor (and perform any required action like connection copy) before anything actually happens. It is also an opportunity check the connections are still good.

Throws:

TransferFailedException