Skip navigation links

oracle.odi.impexp
Interface IImportService

All Known Implementing Classes:

ImportServiceImpl

public interface IImportService

This interface provides all the import methods.

Three types of imports are available:

• import individual objects
• import objects sets
• import solutions

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:

• Execution environment: ODI agents definition and such...
• Logical topology: Technologies, Logical Agents, Logical Schemas, Actions Groups, Actions, Datatypes...
• Master: Objects, Methods, Profiles, Users, Languages, Versions, Solutions, Open Tools, Password rules & polices, Entities, Links, Fields, Lookups...
• Security: Objects, Methods, Users, Profiles, Instances of Objects, Hosts, Password policies
• Topology: Entity IDs, Local Repositories, Connections, Hosts, Logical Agents, Agents, Generic Actions, Technologies, Datatypes...
• Work repository: All ODI design repository objects...

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:

• synonym insert : objects will be inserted. If the object already exist in the repository, the import will fail.
• synonym update : Objects will be updated if they already exist in the repository. Some objects can be deleted in this type of import.
• synonym insert-update : Objects will be inserted. If the object already exists in the repository, they will be updated. Some objects can be deleted in this type of import.
• duplication : new objects (id) will be created.

Since:

11.1.1.3.0

See Also:

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	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	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

IMPORT_MODE_SYNONYM_INSERT

static final 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.

See Also:

Constant Field Values

IMPORT_MODE_SYNONYM_INSERT_UPDATE

static final 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.

See Also:

Constant Field Values

IMPORT_MODE_SYNONYM_UPDATE

static final int IMPORT_MODE_SYNONYM_UPDATE

Import in synonym mode update : updates the object if it exists.

See Also:

Constant Field Values

IMPORT_MODE_DUPLICATION

static final int IMPORT_MODE_DUPLICATION

Import in duplication mode : inserts a duplicated object.

See Also:

Constant Field Values

Method Detail

importObjectFromXml

void importObjectFromXml(int pImportMode,
                         java.lang.String pFileName,
                         boolean pDeclareMissingRepository)
                         throws OdiImportException,
                                java.io.IOException

This method imports an object from an OracleDI export file (XML).

This method will execute in the surrounding transaction and all pending persisted changes will be flushed before import.

Parameters:

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.

Throws:

java.io.IOException - if the file doesn't exist

OdiImportException - if the import fails.

org.springframework.transaction.IllegalTransactionStateException - if no surrounding transaction exists.

importObjectFromXml

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.

Parameters:

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 imported

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.

Throws:

OdiImportNotSupportedException - if the IImportRoot doesn't support this import.

java.io.IOException - if the file doesn't exist

OdiImportException - if the import fails.

java.lang.IllegalArgumentException - when importing a KM and the duplication mode is not IMPORT_MODE_DUPLICATION

org.springframework.transaction.IllegalTransactionStateException - if no surrounding transaction exists.

importWorkRepositoryFromFolder

void importWorkRepositoryFromFolder(int pImportMode,
                                    java.lang.String pFolderPath,
                                    boolean pDeclareMissingRepository)
                                    throws OdiImportException

This method imports a previously exported work repository from a given folder.

This method will execute in the surrounding transaction and all pending persisted changes will be flushed before import.

Parameters:

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.

Throws:

OdiImportException - if the import failed

org.springframework.transaction.IllegalTransactionStateException - if no surrounding transaction exists.

importWorkRepositoryFromZipFile

void importWorkRepositoryFromZipFile(int pImportMode,
                                     java.lang.String pZipFilePath,
                                     boolean pDeclareMissingRepository)
                                     throws OdiImportException

This method imports a previously exported work repository from a given zip file.

This method will execute in the surrounding transaction and all pending persisted changes will be flushed before import.

Parameters:

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.

Throws:

OdiImportException - if the import failed

org.springframework.transaction.IllegalTransactionStateException - if no surrounding transaction exists.

importSecurityFromFolder

void importSecurityFromFolder(int pImportMode,
                              java.lang.String pFolderPath,
                              boolean pDeclareMissingRepository)
                              throws OdiImportException

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

This method will execute in the surrounding transaction and all pending persisted changes will be flushed before import.

Parameters:

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.

Throws:

OdiImportException - if the import fails.

org.springframework.transaction.IllegalTransactionStateException - if no surrounding transaction exists.

importSecurityFromZipFile

void importSecurityFromZipFile(int pImportMode,
                               java.lang.String pZipFilePath,
                               boolean pDeclareMissingRepository)
                               throws OdiImportException

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

This method will execute in the surrounding transaction and all pending persisted changes will be flushed before import.

Parameters:

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.

Throws:

OdiImportException - if the import fails.

org.springframework.transaction.IllegalTransactionStateException - if no surrounding transaction exists.

importTopologyFromFolder

void importTopologyFromFolder(int pImportMode,
                              java.lang.String pFolderPath,
                              boolean pDeclareMissingRepository)
                              throws OdiImportException

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

This method will execute in the surrounding transaction and all pending persisted changes will be flushed before import.

Parameters:

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.

Throws:

OdiImportException - if the import fails.

org.springframework.transaction.IllegalTransactionStateException - if no surrounding transaction exists.

importTopologyFromZipFile

void importTopologyFromZipFile(int pImportMode,
                               java.lang.String pZipFilePath,
                               boolean pDeclareMissingRepository)
                               throws OdiImportException

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

This method will execute in the surrounding transaction and all pending persisted changes will be flushed before import.

Parameters:

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.

Throws:

OdiImportException - if the import fails.

org.springframework.transaction.IllegalTransactionStateException - if no surrounding transaction exists.

importMasterFromFolder

void importMasterFromFolder(int pImportMode,
                            java.lang.String pFolderPath,
                            boolean pDeclareMissingRepository)
                            throws OdiImportException

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

This method will execute in the surrounding transaction and all pending persisted changes will be flushed before import.

Parameters:

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.

Throws:

OdiImportException - if the import fails.

org.springframework.transaction.IllegalTransactionStateException - if no surrounding transaction exists.

importMasterFromZipFile

void importMasterFromZipFile(int pImportMode,
                             java.lang.String pZipFilePath,
                             boolean pDeclareMissingRepository)
                             throws OdiImportException

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

This method will execute in the surrounding transaction and all pending persisted changes will be flushed before import.

Parameters:

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.

Throws:

OdiImportException - if the import fails.

org.springframework.transaction.IllegalTransactionStateException - if no surrounding transaction exists.

importExecutionEnvironmentFromFolder

void importExecutionEnvironmentFromFolder(int pImportMode,
                                          java.lang.String pFolderPath,
                                          boolean pDeclareMissingRepository)
                                          throws OdiImportException

Imports a previously exported execution environment objects set from a given folder.
Execution Environment objects include : Technologies, Connections, Contexts, Agents, Generic Actions

This method will execute in the surrounding transaction and all pending persisted changes will be flushed before import.

Parameters:

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.

Throws:

OdiImportException - if the import fails.

org.springframework.transaction.IllegalTransactionStateException - if no surrounding transaction exists.

importExecutionEnvironmentFromZipFile

void importExecutionEnvironmentFromZipFile(int pImportMode,
                                           java.lang.String pZipFilePath,
                                           boolean pDeclareMissingRepository)
                                           throws OdiImportException

Imports a previously exported execution environment objects set from a given zip file.
Execution Environment objects include : Technologies, Connections, Contexts, Agents, Generic Actions

This method will execute in the surrounding transaction and all pending persisted changes will be flushed before import.

Parameters:

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.

Throws:

OdiImportException - if the import fails.

org.springframework.transaction.IllegalTransactionStateException - if no surrounding transaction exists.

importLogicalTopologyFromFolder

void importLogicalTopologyFromFolder(int pImportMode,
                                     java.lang.String pFolderPath,
                                     boolean pDeclareMissingRepository)
                                     throws OdiImportException

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

This method will execute in the surrounding transaction and all pending persisted changes will be flushed before import.

Parameters:

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.

Throws:

OdiImportException - if the import fails.

importLogicalTopologyFromZipFile

void importLogicalTopologyFromZipFile(int pImportMode,
                                      java.lang.String pZipFilePath,
                                      boolean pDeclareMissingRepository)
                                      throws OdiImportException

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

This method will execute in the surrounding transaction and all pending persisted changes will be flushed before import.

Parameters:

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.

Throws:

OdiImportException - if the import fails.

org.springframework.transaction.IllegalTransactionStateException - if no surrounding transaction exists.

importSolution

void importSolution(int pImportMode,
                    java.lang.String pZipFile,
                    boolean pDeclareMissingRepository)
                    throws OdiImportException

Imports a solution and all its component objects from a zip file.

This method will execute in the surrounding transaction and all pending persisted changes will be flushed before import.

Parameters:

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.

Throws:

OdiImportException - if the import fails.

org.springframework.transaction.IllegalTransactionStateException - if no surrounding transaction exists.

importReplaceProcedure

void importReplaceProcedure(OdiProcedure pOdiProcedure,
                            java.lang.String pXmlFilePath,
                            boolean pDeclareMissingRepository)
                            throws OdiImportException

Replace an existing procedure with a procedure previously exported procedure in a XML file.

Parameters:

pOdiProcedure - the odiProcedure to replace

pXmlFilePath - 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.

Throws:

OdiImportException - if the import fails

importReplaceScenario

void importReplaceScenario(OdiScenario pOdiScenario,
                           java.lang.String pXmlFilePath,
                           boolean pDeclareMissingRepository)
                           throws OdiImportException

Replace an existing scenario with a procedure previously exported procedure in a XML file.

Parameters:

pOdiScenario - the odiScenario to replace

pXmlFilePath - 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.

Throws:

OdiImportException - if the import fails

reimportTopologyReferenceData

void reimportTopologyReferenceData()
                                   throws OdiImportException

Re-import the default Topology data (ODI Technologies, DataTypes, DataType Conversions and Languages) definitions delivered with the release. The modification made on these objects in the repository will be lost. Topology objects that were created manually will not be modified.

Throws:

OdiImportException - if the import fails

Skip navigation links