Skip navigation links

oracle.ide.db.transfer
Class TransferDescriptor

java.lang.Object
oracle.javatools.data.HashStructureAdapter
oracle.ide.db.transfer.TransferDescriptor

All Implemented Interfaces:

PropertyStorage

public final class TransferDescriptor

extends HashStructureAdapter

implements PropertyStorage

Bean to encapsulte various transfer options to be used as the model for a transfer. A TransferDescriptor can be saved and reused. When a transfer is in process using a given descriptor instance, the artifacts of that transfer (e.g. the copied objects, the reconcile choices etc) are stored in a TransferState accessible using getTransferState().

Field Summary

static java.lang.String

KEY

Fields inherited from class oracle.javatools.data.HashStructureAdapter

_hash

Fields inherited from interface oracle.javatools.data.PropertyStorage

DATA_KEY

Constructor Summary

TransferDescriptor()
Construct a new TransferDescriptor with default option values.

TransferDescriptor(HashStructure hash)

Method Summary

int	getDependencyDepth()
java.lang.String	getImportGenerateConn() Deprecated. no longer used.
java.lang.String	getImportGenerateKey() Deprecated. no longer used.
boolean	getIncludeAllDependencies()
boolean	getIncludeDependencies()
java.lang.String	getName()
DBObjectID[]	getObjectIDs() Deprecated.
DBObjectID[]	getObjectIDs(boolean ignorErrors) Gets the DBObjectIDs for the objects chosen for transfer from the source provider.
<T extends TransferTarget> T	getOrCreateTransferTarget(java.lang.Class<T> targetClass)
java.lang.Class	getPolicy()
HashStructure	getProperties()
Step[]	getReconcilePanels() Deprecated.
SchemaObjectDescriptor[]	getSchemaObjectDescriptors()
SchemaObject[]	getSchemaObjects() Deprecated. This method does not let you know that the database connection has been lost. If the caller does not care, use getSchemaObjects( true ) and ignor the exception instead. Otherwise, use getSchemaObjects( false ) and handle the exception
SchemaObject[]	getSchemaObjects(boolean ignorErrors) Deprecated. use getSystemObjects(boolean)
SchemaObject[]	getSchemaObjectsAndDependencies() Deprecated. use getSchemaObjectsAndDependencies( boolean ignorErrors ) instead.
SchemaObject[]	getSchemaObjectsAndDependencies(boolean ignorErrors) Deprecated. use getSystemObjectsAndDependencies(boolean)
Step[]	getScriptPanels() Deprecated.
java.lang.Object	getSource() Get the source of the objects to transfer.
java.lang.String	getSourceApplicationName() Deprecated. - the app/proj are not needed to perform the transfer, just the offlinedb url.
java.lang.String	getSourceConnectionStore() Deprecated. - the store should be encoded into the identifier
java.lang.String	getSourceProjectName() Deprecated. - the app/proj are not needed to perform the transfer, just the offlinedb url.
DBObjectProvider	getSourceProvider()
java.lang.String	getSourceProviderType()
SystemObject[]	getSystemObjects() Deprecated. this method does not let the caller know if the database connection is lost.
SystemObject[]	getSystemObjects(boolean ignorErrors) convenience method to return the source objects.
SystemObject[]	getSystemObjectsAndDependencies() Deprecated. Use getSystemObjectsAndDependencies( true ) if you dont want to get a DBException. Or better, getSystemObjectsAndDependencies( false ) if the caller will handle the exception. A DBException will be throw if the database connection is lost.
SystemObject[]	getSystemObjectsAndDependencies(boolean ignorErrors) Convenience method to return the source objects and dependencies.
java.lang.Object	getTarget()
java.lang.String	getTargetConnectionStore() Deprecated. - the store should be encoded into the identifier
DBObjectProvider	getTargetProvider()
java.lang.String	getTargetProviderType()
java.lang.String	getTargetSchemaName()
java.lang.String	getTargetTableSpace()
TransferManager	getTransferManager() Deprecated. the TransferManager is a singleton - use TransferManager.getInstance()
TransferState	getTransferState() Gets the current state of the transfer for this descriptor if a transfer is in process, or null if this descriptor has not started to be transferred yet.
<T extends TransferTarget> T	getTransferTarget(java.lang.Class<T> targetClass)
TransferTarget[]	getTransferTargets()
TransferState	initialiseTransferState() This (re)initializes the TransferState object for this descriptor.
boolean	isCascadeDelete()
boolean	isDowngradeOK() Has the user accepted that this tranfer is a downgrade.
boolean	isManualReconcile()
boolean	isPlusSqlScript()
boolean	isReconcile()
boolean	isReplace()
<T extends TransferTarget> T	removeTransferTarget(java.lang.Class<T> targetClass)
void	setCascadeDelete(boolean cascadeDelete)
void	setDependencyDepth(int dependencyDepth)
void	setDowngradeOK(boolean downgradeOK) Note that the user has accepted the the transfer is a downgrade.
void	setImportGenerateConn(java.lang.String importGenerateConn) Deprecated. no longer used.
void	setImportGenerateKey(java.lang.String importGenerateKey) Deprecated. no longer used.
void	setIncludeAllDependencies(boolean includeAllDependencies)
void	setIncludeDependencies(boolean includeDependencies)
void	setManualReconcile(boolean manualReconcile)
void	setObjectIDs(DBObjectID[] ids) Sets the objects chosen for transfer from the source provider using their DBObejctIDs.
void	setPlusSqlScrip(boolean plusSqlScrip)
void	setPolicy(java.lang.Class<? extends TransferPolicy> policy)
void	setReconcile(boolean reconcile)
void	setReconcilePanels(Step[] reconcilePanels) Deprecated.
void	setReplace(boolean replace)
void	setSchemaObjectDescriptors(SchemaObjectDescriptor[] sos)
void	setScriptPanels(Step[] scriptPanels) Deprecated.
void	setSource(java.lang.Object source) Set the source of the objects to transfer.
void	setSourceApplicationName(java.lang.String source) Deprecated. - the app/proj are not needed to perform the transfer, just the offlinedb url.
void	setSourceConnectionStore(java.lang.String source) Deprecated. the store should be encoded into the identifier
void	setSourceProjectName(java.lang.String source) Deprecated. - the app/proj are not needed to perform the transfer, just the offlinedb url.
void	setSourceProvider(DBObjectProvider pro)
void	setSourceProviderType(java.lang.String providerType)
void	setTarget(java.lang.Object obj)
void	setTargetConnectionStore(java.lang.String target) Deprecated. the conn store is encoded into the provider id
void	setTargetProvider(DBObjectProvider pro)
void	setTargetProviderType(java.lang.String providerType)
void	setTargetSchemaName(java.lang.String schemaName)
void	setTargetTableSpace(java.lang.String schemaName)

Methods inherited from class oracle.javatools.data.HashStructureAdapter

addStructureChangeListener, containsKey, copyTo, copyToImpl, equals, equalsImpl, findOrCreate, forcedCopyTo, getHashStructure, removeStructureChangeListener, useObjectEquals

Methods inherited from class java.lang.Object

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

Field Detail

KEY

public static final java.lang.String KEY

See Also:

Constant Field Values

Constructor Detail

TransferDescriptor

public TransferDescriptor()

Construct a new TransferDescriptor with default option values.

TransferDescriptor

public TransferDescriptor(HashStructure hash)

Method Detail

getName

public java.lang.String getName()

initialiseTransferState

public TransferState initialiseTransferState()

This (re)initializes the TransferState object for this descriptor. For normal transfer operations this method should not need to be called as the TransferManager will automatically initialize the state object when it is first needed. If any part of the state needs to be customized for a transfer (e.g. the existing objects) then the state can be manually initialized up front using this method.

getTransferState

public TransferState getTransferState()

Gets the current state of the transfer for this descriptor if a transfer is in process, or null if this descriptor has not started to be transferred yet.

getObjectIDs

public DBObjectID[] getObjectIDs(boolean ignorErrors)
                          throws TransferFailedException

Gets the DBObjectIDs for the objects chosen for transfer from the source provider. Errors in retrieving these ids can optionally be ignored.

Parameters:

ignorErrors - whether to ignore errors in retrieving the ids.

Returns:

the DBObjectIDs for the objects to be transferred.

Throws:

DBException - if the source provider, or the objects to transfer, cannot be retrieved.

TransferFailedException

setObjectIDs

public void setObjectIDs(DBObjectID[] ids)

Sets the objects chosen for transfer from the source provider using their DBObejctIDs.

isReplace

public boolean isReplace()

setReplace

public void setReplace(boolean replace)

isCascadeDelete

public boolean isCascadeDelete()

setCascadeDelete

public void setCascadeDelete(boolean cascadeDelete)

isReconcile

public boolean isReconcile()

setReconcile

public void setReconcile(boolean reconcile)

isManualReconcile

public boolean isManualReconcile()

setManualReconcile

public void setManualReconcile(boolean manualReconcile)

getTargetSchemaName

public java.lang.String getTargetSchemaName()

setTargetSchemaName

public void setTargetSchemaName(java.lang.String schemaName)

getTargetTableSpace

public java.lang.String getTargetTableSpace()

setTargetTableSpace

public void setTargetTableSpace(java.lang.String schemaName)

setTarget

public void setTarget(java.lang.Object obj)

getTarget

public java.lang.Object getTarget()

setTargetProviderType

public void setTargetProviderType(java.lang.String providerType)

getTargetProviderType

public java.lang.String getTargetProviderType()

getTargetProvider

public DBObjectProvider getTargetProvider()
                                   throws TransferFailedException

Throws:

TransferFailedException

setTargetProvider

public void setTargetProvider(DBObjectProvider pro)

setSchemaObjectDescriptors

public void setSchemaObjectDescriptors(SchemaObjectDescriptor[] sos)

getSchemaObjectDescriptors

public SchemaObjectDescriptor[] getSchemaObjectDescriptors()

getIncludeDependencies

public boolean getIncludeDependencies()

setIncludeDependencies

public void setIncludeDependencies(boolean includeDependencies)

getIncludeAllDependencies

public boolean getIncludeAllDependencies()

setIncludeAllDependencies

public void setIncludeAllDependencies(boolean includeAllDependencies)

getDependencyDepth

public int getDependencyDepth()

setDependencyDepth

public void setDependencyDepth(int dependencyDepth)

isPlusSqlScript

public boolean isPlusSqlScript()

setPlusSqlScrip

public void setPlusSqlScrip(boolean plusSqlScrip)

isDowngradeOK

public boolean isDowngradeOK()

Has the user accepted that this tranfer is a downgrade. That is to an earlier version of the database.

setDowngradeOK

public void setDowngradeOK(boolean downgradeOK)

Note that the user has accepted the the transfer is a downgrade.

setSource

public void setSource(java.lang.Object source)

Set the source of the objects to transfer. This is either the Database connection string
or
the Offline database URL

getSource

public java.lang.Object getSource()

Get the source of the objects to transfer. This is either the Database connection string
or
the Offline database URL

See Also:

DBObjectProvider.getProviderIdentifier()

setSourceProviderType

public void setSourceProviderType(java.lang.String providerType)

getSourceProviderType

public java.lang.String getSourceProviderType()

setSourceProvider

public void setSourceProvider(DBObjectProvider pro)

getSourceProvider

public DBObjectProvider getSourceProvider()
                                   throws TransferFailedException

Throws:

TransferFailedException

setPolicy

public void setPolicy(java.lang.Class<? extends TransferPolicy> policy)

getPolicy

public java.lang.Class getPolicy()

getTransferTargets

public TransferTarget[] getTransferTargets()

getTransferTarget

public <T extends TransferTarget> T getTransferTarget(java.lang.Class<T> targetClass)

getOrCreateTransferTarget

public <T extends TransferTarget> T getOrCreateTransferTarget(java.lang.Class<T> targetClass)

removeTransferTarget

public <T extends TransferTarget> T removeTransferTarget(java.lang.Class<T> targetClass)

getSystemObjects

public SystemObject[] getSystemObjects(boolean ignorErrors)
                                throws TransferFailedException

convenience method to return the source objects.

Parameters:

ignorErrors - If true, DBExceptions are ignored.

Throws:

TransferFailedException

getSystemObjectsAndDependencies

public SystemObject[] getSystemObjectsAndDependencies(boolean ignorErrors)
                                               throws TransferFailedException

Convenience method to return the source objects and dependencies. The dependency depth is limited by the descriptor.

Parameters:

ignorErrors - - if true, this method will swallow DBExceptions

Throws:

TransferFailedException

getProperties

public HashStructure getProperties()

Specified by:

getProperties in interface PropertyStorage

Returns:

The HashStructure wrapped by this PropertyStorage.

setReconcilePanels

@Deprecated
public void setReconcilePanels(Step[] reconcilePanels)

Deprecated.

getReconcilePanels

@Deprecated
public Step[] getReconcilePanels()

Deprecated.

setScriptPanels

@Deprecated
public void setScriptPanels(Step[] scriptPanels)

Deprecated.

getScriptPanels

@Deprecated
public Step[] getScriptPanels()

Deprecated.

getTransferManager

@Deprecated
public TransferManager getTransferManager()

Deprecated. the TransferManager is a singleton - use TransferManager.getInstance()

getSchemaObjectsAndDependencies

@Deprecated
public SchemaObject[] getSchemaObjectsAndDependencies()

Deprecated. use getSchemaObjectsAndDependencies( boolean ignorErrors ) instead.

getObjectIDs

@Deprecated
public DBObjectID[] getObjectIDs()

Deprecated.

Returns:

getSchemaObjects

@Deprecated
public SchemaObject[] getSchemaObjects()

Deprecated. This method does not let you know that the database connection has been lost. If the caller does not care, use getSchemaObjects( true ) and ignor the exception instead. Otherwise, use getSchemaObjects( false ) and handle the exception

getSystemObjects

@Deprecated
public SystemObject[] getSystemObjects()

Deprecated. this method does not let the caller know if the database connection is lost.

getSystemObjectsAndDependencies

@Deprecated
public SystemObject[] getSystemObjectsAndDependencies()

Deprecated. Use getSystemObjectsAndDependencies( true ) if you dont want to get a DBException. Or better, getSystemObjectsAndDependencies( false ) if the caller will handle the exception. A DBException will be throw if the database connection is lost.

getSchemaObjects

@Deprecated
public SchemaObject[] getSchemaObjects(boolean ignorErrors)
                                throws TransferFailedException

Deprecated. use getSystemObjects(boolean)

Throws:

TransferFailedException

getSchemaObjectsAndDependencies

@Deprecated
public SchemaObject[] getSchemaObjectsAndDependencies(boolean ignorErrors)
                                               throws TransferFailedException

Deprecated. use getSystemObjectsAndDependencies(boolean)

Throws:

TransferFailedException

setImportGenerateKey

@Deprecated
public void setImportGenerateKey(java.lang.String importGenerateKey)

Deprecated. no longer used.

getImportGenerateKey

@Deprecated
public java.lang.String getImportGenerateKey()

Deprecated. no longer used.

setImportGenerateConn

@Deprecated
public void setImportGenerateConn(java.lang.String importGenerateConn)

Deprecated. no longer used.

getImportGenerateConn

@Deprecated
public java.lang.String getImportGenerateConn()

Deprecated. no longer used.

setTargetConnectionStore

@Deprecated
public void setTargetConnectionStore(java.lang.String target)

Deprecated. the conn store is encoded into the provider id

getTargetConnectionStore

@Deprecated
public java.lang.String getTargetConnectionStore()

Deprecated. - the store should be encoded into the identifier

setSourceApplicationName

@Deprecated
public void setSourceApplicationName(java.lang.String source)

Deprecated. - the app/proj are not needed to perform the transfer, just the offlinedb url.

getSourceApplicationName

@Deprecated
public java.lang.String getSourceApplicationName()

Deprecated. - the app/proj are not needed to perform the transfer, just the offlinedb url.

setSourceProjectName

@Deprecated
public void setSourceProjectName(java.lang.String source)

Deprecated. - the app/proj are not needed to perform the transfer, just the offlinedb url.

getSourceProjectName

@Deprecated
public java.lang.String getSourceProjectName()

Deprecated. - the app/proj are not needed to perform the transfer, just the offlinedb url.

setSourceConnectionStore

@Deprecated
public void setSourceConnectionStore(java.lang.String source)

Deprecated. the store should be encoded into the identifier

getSourceConnectionStore

@Deprecated
public java.lang.String getSourceConnectionStore()

Deprecated. - the store should be encoded into the identifier

Skip navigation links