|
Oracle® Data Integrator Java API Reference 11g Release 1 (11.1.1.6.0) E17060-03 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IImportService
This interface provides all the import methods.
Three types of imports are available:
Importing an individual object means importing back an object that has previously been exported from ODI in a XML file. You can define under which parent object you want to import when duplicating an object. The parent object must implement the IImportRoot
interface.
Importing a set of objects means that all the objects of an ODI module have been exported and you want to import them back. Sets are as follows:
These sets can be imported from folders or zip files.
Importing solutions have a special behavior. Please read the ODI documentation for more information.
Each import function has three mode available:
IExportService
, IImportRoot
Field Summary | |
---|---|
static int |
IMPORT_MODE_DUPLICATION Import in duplication mode : inserts a duplicated object. |
static int |
IMPORT_MODE_SYNONYM_INSERT Import in synonym mode insert : inserts the object "as it is"; fails if the object already exists or if a parent object does not exist. |
static int |
IMPORT_MODE_SYNONYM_INSERT_UPDATE Import in synonym mode insert update : inserts the object "as it is" if the object does not exist; updates if the object already exists. |
static int |
IMPORT_MODE_SYNONYM_UPDATE Import in synonym mode update : updates the object if it exists. |
Method Summary | |
---|---|
void |
importExecutionEnvironmentFromFolder(int pImportMode, java.lang.String pFolderPath, boolean pDeclareMissingRepository) Imports a previously exported execution environment objects set from a given folder. Execution Environment objects include : Technologies, Connections, Contexts, Agents, Generic Actions |
void |
importExecutionEnvironmentFromZipFile(int pImportMode, java.lang.String pZipFilePath, boolean pDeclareMissingRepository) Imports a previously exported execution environment objects set from a given zip file. Execution Environment objects include : Technologies, Connections, Contexts, Agents, Generic Actions |
void |
importLogicalTopologyFromFolder(int pImportMode, java.lang.String pFolderPath, boolean pDeclareMissingRepository) Imports a previously exported Logical topology objects set from a given folder. Logical Topology objects include : Technologies, Logical Agents, Logical Schemas, Actions Groups, Actions, Datatypes, Datatype Conversions |
void |
importLogicalTopologyFromZipFile(int pImportMode, java.lang.String pZipFilePath, boolean pDeclareMissingRepository) Imports a previously exported logical topology objects set from a given zip file. Logical Topology objects include : Technologies, Logical Agents, Logical Schemas, Actions Groups, Actions, Datatypes, Datatype Conversions |
void |
importLogsFromFolder(java.lang.String pFolderPath) Imports the previously exported execution logs (load plan runs, sessions and related objects) from a given folder. |
void |
importLogsFromZipFile(java.lang.String pZipFilePath) Imports the previously exported execution logs (load plan runs, sessions and related objects) from a given zip file. |
void |
importMasterFromFolder(int pImportMode, java.lang.String pFolderPath, boolean pDeclareMissingRepository) Imports a previously exported master objects set from a given folder. Master objects include : Objects, Methods, Profiles, Users, Languages, Versions, Solutions, Open Tools, Password rules & polices, Entities, Links, Fields, Lookups |
void |
importMasterFromZipFile(int pImportMode, java.lang.String pZipFilePath, boolean pDeclareMissingRepository) Imports a previously exported master objects set from a given zip file. Master objects include : Objects, Methods, Profiles, Users, Languages, Versions, Solutions, Open Tools, Password rules & polices, Entities, Links, Fields, Lookups |
void |
importObjectFromXml(int pImportMode, java.lang.String pFileName, boolean pDeclareMissingRepository) This method imports an object from an OracleDI export file (XML). |
void |
importObjectFromXml(int pImportMode, java.lang.String pFileName, IImportRoot pObjectParent, boolean pDeclareMissingRepository) This method imports an object from an OracleDI export file (XML) under a parent object. |
void |
importReplaceProcedure(OdiProcedure pOdiProcedure, java.lang.String pXmlFilePath, boolean pDeclareMissingRepository) Replace an existing procedure with a procedure previously exported procedure in a XML file. |
void |
importReplaceScenario(OdiScenario pOdiScenario, java.lang.String pXmlFilePath, boolean pDeclareMissingRepository) Replace an existing scenario with a procedure previously exported procedure in a XML file. |
void |
importSecurityFromFolder(int pImportMode, java.lang.String pFolderPath, boolean pDeclareMissingRepository) Imports a previously exported security objects set from a given folder. Security objects include : Objects, Methods, Users, Profiles, Instances of Objects, Hosts, Password rules & policies |
void |
importSecurityFromZipFile(int pImportMode, java.lang.String pZipFilePath, boolean pDeclareMissingRepository) Imports a previously exported security objects set from a given zip file. Security objects include : Objects, Methods, Users, Profiles, Instances of Objects, Hosts, Password rules & policies |
void |
importSessionsFromFolder(java.lang.String pFolderPath) Deprecated. use importLogsFromFolder instead |
void |
importSessionsFromZipFile(java.lang.String pZipFilePath) Deprecated. use importLogsFromZipFile instead |
void |
importSolution(int pImportMode, java.lang.String pZipFile, boolean pDeclareMissingRepository) Imports a solution and all its component objects from a zip file. |
void |
importTopologyFromFolder(int pImportMode, java.lang.String pFolderPath, boolean pDeclareMissingRepository) Imports a previously exported topology objects set from a given folder. Topology objects include : Entity IDs, Local Repositories, Connections, Hosts, Logical Agents, Agents, Generic Actions, Technologies, Datatypes, Datatypes conversions |
void |
importTopologyFromZipFile(int pImportMode, java.lang.String pZipFilePath, boolean pDeclareMissingRepository) Imports a previously exported topology objects set from a given zip file. Topology objects include : Entity IDs, Local Repositories, Connections, Hosts, Logical Agents, Agents, Generic Actions, Technologies, Datatypes, Datatypes conversions |
void |
importWorkRepositoryFromFolder(int pImportMode, java.lang.String pFolderPath, boolean pDeclareMissingRepository) This method imports a previously exported work repository from a given folder. |
void |
importWorkRepositoryFromZipFile(int pImportMode, java.lang.String pZipFilePath, boolean pDeclareMissingRepository) This method imports a previously exported work repository from a given zip file. |
void |
reimportTopologyReferenceData() Re-import the default Topology data (ODI Technologies, DataTypes, DataType Conversions and Languages) definitions delivered with the release. |
Field Detail |
---|
static final int IMPORT_MODE_SYNONYM_INSERT
static final int IMPORT_MODE_SYNONYM_INSERT_UPDATE
static final int IMPORT_MODE_SYNONYM_UPDATE
static final int IMPORT_MODE_DUPLICATION
Method Detail |
---|
void importObjectFromXml(int pImportMode, java.lang.String pFileName, boolean pDeclareMissingRepository) throws OdiImportException, java.io.IOException
This method will execute in the surrounding transaction and all pending persisted changes will be flushed before import.
pFileName
- the OracleDI XML export file.pImportMode
- Insert, Insert-update, Update or Duplication mode.pDeclareMissingRepository
- In synonym import, if the original repository of the original object is missing, if true, it will be referenced ; if false, the import will fail.java.io.IOException
- if the file doesn't existOdiImportException
- if the import fails.IllegalTransactionStateException
- if no surrounding transaction exists.void importObjectFromXml(int pImportMode, java.lang.String pFileName, IImportRoot pObjectParent, boolean pDeclareMissingRepository) throws OdiImportNotSupportedException, OdiImportException, java.io.IOException
This method imports an object from an OracleDI export file (XML) under a parent object. The parent object must be persisted. The parent object will be refreshed. When importing a KM, the import mode must be IMPORT_MODE_DUPLICATION
, otherwise it will throw an IllegalArgumentException
This method will execute in the surrounding transaction and all pending persisted changes will be flushed before import.
pFileName
- the OracleDI XML export file.pImportMode
- Insert, Insert-update, Update or Duplication mode.pObjectParent
- the object under which the object in the XML file will be importedpDeclareMissingRepository
- In synonym import, if the original repository of the original object is missing, if true, it will be referenced ; if false, the import will fail.OdiImportNotSupportedException
- if the IImportRoot
doesn't support this import.java.io.IOException
- if the file doesn't existOdiImportException
- if the import fails.java.lang.IllegalArgumentException
- when importing a KM and the duplication mode is not IMPORT_MODE_DUPLICATION
IllegalTransactionStateException
- if no surrounding transaction exists.void importWorkRepositoryFromFolder(int pImportMode, java.lang.String pFolderPath, boolean pDeclareMissingRepository) throws OdiImportException
This method will execute in the surrounding transaction and all pending persisted changes will be flushed before import.
pImportMode
- Insert, Insert-update, Update or Duplication mode.pFolderPath
- the folder containing all the XML files you want to import.pDeclareMissingRepository
- In synonym import, if the original repository of the original object is missing, if true, it will be referenced ; if false, the import will fail.OdiImportException
- if the import failedIllegalTransactionStateException
- if no surrounding transaction exists.void importWorkRepositoryFromZipFile(int pImportMode, java.lang.String pZipFilePath, boolean pDeclareMissingRepository) throws OdiImportException
This method will execute in the surrounding transaction and all pending persisted changes will be flushed before import.
pImportMode
- Insert, Insert-update, Update or Duplication mode.pZipFilePath
- the Zip file containing all the XML files you want to import.pDeclareMissingRepository
- In synonym import, if the original repository of the original object is missing, if true, it will be referenced ; if false, the import will fail.OdiImportException
- if the import failedIllegalTransactionStateException
- if no surrounding transaction exists.void importSecurityFromFolder(int pImportMode, java.lang.String pFolderPath, boolean pDeclareMissingRepository) throws OdiImportException
This method will execute in the surrounding transaction and all pending persisted changes will be flushed before import.
pImportMode
- Insert, Insert-update, Update or Duplication modepFolderPath
- the folder containing all the XML files you want to import.pDeclareMissingRepository
- In synonym import, if the original repository of the original object is missing, if true, it will be referenced ; if false, the import will fail.OdiImportException
- if the import fails.IllegalTransactionStateException
- if no surrounding transaction exists.void importSecurityFromZipFile(int pImportMode, java.lang.String pZipFilePath, boolean pDeclareMissingRepository) throws OdiImportException
This method will execute in the surrounding transaction and all pending persisted changes will be flushed before import.
pImportMode
- Insert, Insert-update, Update or Duplication modepZipFilePath
- the Zip file containing all the XML files you want to import.pDeclareMissingRepository
- In synonym import, if the original repository of the original object is missing, if true, it will be referenced ; if false, the import will fail.OdiImportException
- if the import fails.IllegalTransactionStateException
- if no surrounding transaction exists.void importTopologyFromFolder(int pImportMode, java.lang.String pFolderPath, boolean pDeclareMissingRepository) throws OdiImportException
This method will execute in the surrounding transaction and all pending persisted changes will be flushed before import.
pImportMode
- Insert, Insert-update, Update or Duplication mode.pFolderPath
- the folder containing all the XML files you want to import.pDeclareMissingRepository
- In synonym import, if the original repository of the original object is missing, if true, it will be referenced ; if false, the import will fail.OdiImportException
- if the import fails.IllegalTransactionStateException
- if no surrounding transaction exists.void importTopologyFromZipFile(int pImportMode, java.lang.String pZipFilePath, boolean pDeclareMissingRepository) throws OdiImportException
This method will execute in the surrounding transaction and all pending persisted changes will be flushed before import.
pImportMode
- Insert, Insert-update, Update or Duplication mode.pZipFilePath
- the Zip file containing all the XML files you want to import.pDeclareMissingRepository
- In synonym import, if the original repository of the original object is missing, if true, it will be referenced ; if false, the import will fail.OdiImportException
- if the import fails.IllegalTransactionStateException
- if no surrounding transaction exists.void importMasterFromFolder(int pImportMode, java.lang.String pFolderPath, boolean pDeclareMissingRepository) throws OdiImportException
This method will execute in the surrounding transaction and all pending persisted changes will be flushed before import.
pImportMode
- Insert, Insert-update, Update or Duplication mode.pFolderPath
- the folder containing all the XML files you want to import.pDeclareMissingRepository
- In synonym import, if the original repository of the original object is missing, if true, it will be referenced ; if false, the import will fail.OdiImportException
- if the import fails.IllegalTransactionStateException
- if no surrounding transaction exists.void importMasterFromZipFile(int pImportMode, java.lang.String pZipFilePath, boolean pDeclareMissingRepository) throws OdiImportException
This method will execute in the surrounding transaction and all pending persisted changes will be flushed before import.
pImportMode
- Insert, Insert-update, Update or Duplication mode.pZipFilePath
- the Zip file containing all the XML files you want to import.pDeclareMissingRepository
- In synonym import, if the original repository of the original object is missing, if true, it will be referenced ; if false, the import will fail.OdiImportException
- if the import fails.IllegalTransactionStateException
- if no surrounding transaction exists.void importExecutionEnvironmentFromFolder(int pImportMode, java.lang.String pFolderPath, boolean pDeclareMissingRepository) throws OdiImportException
This method will execute in the surrounding transaction and all pending persisted changes will be flushed before import.
pImportMode
- Insert, Insert-update, Update or Duplication mode.pFolderPath
- the folder containing all the XML files you want to import.pDeclareMissingRepository
- In synonym import, if the original repository of the original object is missing, if true, it will be referenced ; if false, the import will fail.OdiImportException
- if the import fails.IllegalTransactionStateException
- if no surrounding transaction exists.void importExecutionEnvironmentFromZipFile(int pImportMode, java.lang.String pZipFilePath, boolean pDeclareMissingRepository) throws OdiImportException
This method will execute in the surrounding transaction and all pending persisted changes will be flushed before import.
pImportMode
- Insert, Insert-update, Update or Duplication mode.pZipFilePath
- the Zip file containing all the XML files you want to import.pDeclareMissingRepository
- In synonym import, if the original repository of the original object is missing, if true, it will be referenced ; if false, the import will fail.OdiImportException
- if the import fails.IllegalTransactionStateException
- if no surrounding transaction exists.void importLogicalTopologyFromFolder(int pImportMode, java.lang.String pFolderPath, boolean pDeclareMissingRepository) throws OdiImportException
This method will execute in the surrounding transaction and all pending persisted changes will be flushed before import.
pImportMode
- Insert, Insert-update, Update or Duplication mode.pFolderPath
- the folder containing all the XML files you want to import.pDeclareMissingRepository
- In synonym import, if the original repository of the original object is missing, if true, it will be referenced ; if false, the import will fail.OdiImportException
- if the import fails.void importLogicalTopologyFromZipFile(int pImportMode, java.lang.String pZipFilePath, boolean pDeclareMissingRepository) throws OdiImportException
This method will execute in the surrounding transaction and all pending persisted changes will be flushed before import.
pImportMode
- Insert, Insert-update, Update or Duplication mode.pZipFilePath
- the Zip file containing all the XML files you want to import.pDeclareMissingRepository
- In synonym import, if the original repository of the original object is missing, if true, it will be referenced ; if false, the import will fail.OdiImportException
- if the import fails.IllegalTransactionStateException
- if no surrounding transaction exists.void importSolution(int pImportMode, java.lang.String pZipFile, boolean pDeclareMissingRepository) throws OdiImportException
This method will execute in the surrounding transaction and all pending persisted changes will be flushed before import.
pImportMode
- Insert, Insert-update, Update or Duplication mode.pZipFile
- the Zip file containing the solution you want to import.pDeclareMissingRepository
- In synonym import, if the original repository of the original object is missing, if true, it will be referenced ; if false, the import will fail.OdiImportException
- if the import fails.IllegalTransactionStateException
- if no surrounding transaction exists.void importReplaceProcedure(OdiProcedure pOdiProcedure, java.lang.String pXmlFilePath, boolean pDeclareMissingRepository) throws OdiImportException
pOdiProcedure
- the odiProcedure to replacepXmlFilePath
- the previously exported procedure xml file path.pDeclareMissingRepository
- if the original repository of the original object is missing, if true, it will be referenced ; if false, the import will fail.OdiImportException
- if the import failsvoid importReplaceScenario(OdiScenario pOdiScenario, java.lang.String pXmlFilePath, boolean pDeclareMissingRepository) throws OdiImportException
pOdiScenario
- the odiScenario to replacepXmlFilePath
- the previously exported scenario xml file path.pDeclareMissingRepository
- if the original repository of the original object is missing, if true, it will be referenced ; if false, the import will fail.OdiImportException
- if the import failsvoid reimportTopologyReferenceData() throws OdiImportException
OdiImportException
- if the import failsvoid importSessionsFromFolder(java.lang.String pFolderPath) throws OdiImportException
pFolderPath
- folder containing logsOdiImportException
- if the import failsvoid importSessionsFromZipFile(java.lang.String pZipFilePath) throws OdiImportException
pZipFilePath
- zip file containing logsOdiImportException
- if the import failsvoid importLogsFromFolder(java.lang.String pFolderPath) throws OdiImportException
pFolderPath
- folder containing logsOdiImportException
- if the import failsvoid importLogsFromZipFile(java.lang.String pZipFilePath) throws OdiImportException
pZipFilePath
- zip file containing logsOdiImportException
- if the import fails
|
Oracle® Data Integrator Java API Reference 11g Release 1 (11.1.1.6.0) E17060-03 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |