Skip navigation links

oracle.odi.impexp
Interface IExportService

All Known Implementing Classes:

ExportServiceImpl

public interface IExportService

This interface provides all the export methods.

Three types of exports are available:

• export individual objects
• export objects sets
• export solutions

Exporting an individual object means specifying an object that is to be exported from ODI into an XML file. You can specify whether the children under a parent object should be exported recursively or not. An object to be exported must implement the IExportable interface.

Exporting a set of objects means that all the objects of an ODI module will be exported. 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 exported into folders or zip files.

Exporting solutions have a special behavior. Please read the ODI documentation for more information.

Please read the ODI documentation for complete information on export and import strategies and implications.

Since:

11.1.1.3.0

See Also:

IImportService

Method Summary

void	exportAllScenarii(IOdiScenarioSourceContainer pScenarioContainer, java.lang.String pFolderPath, boolean pExportScenariofPackages, boolean pExportScenarioOfInterfaces, boolean pExportScenarioOfProcedures, boolean pExportScenarioOfVariables, EncodingOptions pEncodingDetails, boolean pRecursiveExport, boolean pOverwrite) Export all the scenarios contained in this scenario source container.
void	exportExecutionEnvironmentInFolder(java.lang.String pFolderPath, EncodingOptions pEncodingDetails) Exports the execution environment objets into a given folder. Execution Environment objects include : Technologies, Connections, Contexts, Agents, Generical Actions.
void	exportExecutionEnvironmentInZipfile(java.lang.String pFolderPath, java.lang.String pZipFileName, boolean pOverwrite, EncodingOptions pEncodingDetails) Exports the execution environment objects into a given zip file. Execution Environment objects include : Technologies, Connections, Contexts, Agents, Generical Actions.
void	exportLogicalTopologyInFolder(java.lang.String pFolderPath, EncodingOptions pEncodingDetails) Exports the logical topology objets into a given folder. Logical Topology objects include : Technologies, Logical Agents, Logical Schemas, Actions Groups, Actions, Datatypes, Datatype conversions.
void	exportLogicalTopologyInZipfile(java.lang.String pFolderPath, java.lang.String pZipFileName, boolean pOverwrite, EncodingOptions pEncodingDetails) Exports the logical topology objects into a given zip file. Logical Topology objects include : Technologies, Logical Agents, Logical Schemas, Actions Groups, Actions, Datatypes, Datatype conversions.
void	exportMasterInFolder(java.lang.String pFolderPath, EncodingOptions pEncodingDetails, boolean pExportVersions, boolean pExportSolutions) Exports the master objets into a given folder. Master objects include : Objects, Methodes, Profiles, Users, Languages, Versions, Solutions, Open Tools, Password rules & polices, Entities, Links, Fields, Lookups.
void	exportMasterInZipfile(java.lang.String pFolderPath, java.lang.String pZipFileName, boolean pOverwrite, EncodingOptions pEncodingDetails, boolean pExportVersions, boolean pExportSolutions) Exports the master objects into a given zip file. Master objects include : Objects, Methodes, Profiles, Users, Languages, Versions, Solutions, Open Tools, Password rules & polices, Entities, Links, Fields, Lookups.
void	exportSecurityInFolder(java.lang.String pFolderPath, EncodingOptions pEncodingDetails) Exports the security objets into a given folder. Security objects include : Objects, Methods, Users, Profiles, Instances of Objects, Hosts, Password rules & policies.
void	exportSecurityInZipfile(java.lang.String pFolderPath, java.lang.String pZipFileName, boolean pOverwrite, EncodingOptions pEncodingDetails) Exports the security objects into a given zip file. Security objects include : Objects, Methods, Users, Profiles, Instances of Objects, Hosts, Password rules & policies.
void	exportTopologyInFolder(java.lang.String pFolderPath, EncodingOptions pEncodingDetails) Exports the topology objets into a given folder. Topology objects include : Entity IDs, Lacal Repositories, Connections, Hosts, Logical Agents, Agents, Generical Actions, Technologies, Datatypes, Datatypes conversions.
void	exportTopologyInZipfile(java.lang.String pFolderPath, java.lang.String pZipFileName, boolean pOverwrite, EncodingOptions pEncodingDetails) Exports the topology objects into a given zip file. Topology objects include : Entity IDs, Lacal Repositories, Connections, Hosts, Logical Agents, Agents, Generical Actions, Technologies, Datatypes, Datatypes conversions.
void	exportToXml(IExportable pExportable, java.lang.String pFolderPath, boolean pforceOverwrite, boolean pRecursiveExport, EncodingOptions pEncodingDetails) Exports the given object to a XML file.
void	exportWorkInFolder(java.lang.String pFolderPath, EncodingOptions pEncodingDetails) Export the work objects into a given folder.
void	exportWorkInZipfile(java.lang.String pFolderPath, java.lang.String pZipFileName, boolean pOverwrite, EncodingOptions pEncodingDetails) Export the work objects into a given zip file.

Method Detail

exportToXml

void exportToXml(IExportable pExportable,
                 java.lang.String pFolderPath,
                 boolean pforceOverwrite,
                 boolean pRecursiveExport,
                 EncodingOptions pEncodingDetails)
                 throws java.io.IOException

Exports the given object to a XML file.

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

Parameters:

pExportable - the object to export.

pFolderPath - the folder in which the object will be exported.

pforceOverwrite - if true, will overwrite an existing zip file in the same folder with the same name.

pRecursiveExport - will export all the object hierarchy.

pEncodingDetails - details about the Java and XML encoding.

Throws:

java.io.IOException - if pOverwrite is false and the file already exists.

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

exportAllScenarii

void exportAllScenarii(IOdiScenarioSourceContainer pScenarioContainer,
                       java.lang.String pFolderPath,
                       boolean pExportScenariofPackages,
                       boolean pExportScenarioOfInterfaces,
                       boolean pExportScenarioOfProcedures,
                       boolean pExportScenarioOfVariables,
                       EncodingOptions pEncodingDetails,
                       boolean pRecursiveExport,
                       boolean pOverwrite)

Export all the scenarios contained in this scenario source container.

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

Parameters:

pScenarioContainer - the object that contains the scenario source.

pFolderPath - the folder in which the scenarios will be exported.

pExportScenariofPackages - if true, the scenarios generated from packages will be exported.

pExportScenarioOfInterfaces - if true, the scenarios generated from interfaces will be exported.

pExportScenarioOfProcedures - if true, the scenarios generated from procedures will be exported.

pExportScenarioOfVariables - if true, the scenarios generated from variables will be exported.

pEncodingDetails - details about the Java and XML encoding.

pRecursiveExport - will export all the scenario within the scenario source container hierarchy.

pOverwrite - if true, will overwrite an existing zip file in the same folder with the same name.

Throws:

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

exportWorkInFolder

void exportWorkInFolder(java.lang.String pFolderPath,
                        EncodingOptions pEncodingDetails)

Export the work objects into a given folder.

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

If files with the same name already exist in the folder, they will be overwritten.

Parameters:

pFolderPath - the folder in which the objects will be exported.

pEncodingDetails - details about the Java and XML encoding.

Throws:

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

exportWorkInZipfile

void exportWorkInZipfile(java.lang.String pFolderPath,
                         java.lang.String pZipFileName,
                         boolean pOverwrite,
                         EncodingOptions pEncodingDetails)
                         throws java.io.IOException

Export the work objects into a given zip file.

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

Parameters:

pFolderPath - the folder in which the zip file will be created.

pZipFileName - the name of the zip file.

pOverwrite - pif true, will overwrite an existing zip file in the same folder with the same name.

pEncodingDetails - details about the Java and XML encoding.

Throws:

java.io.IOException - if pOverwrite is false and the file already exists.

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

exportSecurityInFolder

void exportSecurityInFolder(java.lang.String pFolderPath,
                            EncodingOptions pEncodingDetails)

Exports the security objets into 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 export.

If files with the same name already exist in the folder, they will be overwritten.

Parameters:

pFolderPath - the folder in which the objects will be exported.

pEncodingDetails - details about the Java and XML encoding.

Throws:

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

exportSecurityInZipfile

void exportSecurityInZipfile(java.lang.String pFolderPath,
                             java.lang.String pZipFileName,
                             boolean pOverwrite,
                             EncodingOptions pEncodingDetails)
                             throws java.io.IOException

Exports the security objects into 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 export.

Parameters:

pFolderPath - the folder in which the zip file will be created.

pZipFileName - the name of the zip file.

pOverwrite - if true, will overwrite an existing zip file in the same folder with the same name.

pEncodingDetails - details about the Java and XML encoding.

Throws:

java.io.IOException - if pOverwrite is false and the file already exists.

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

exportMasterInFolder

void exportMasterInFolder(java.lang.String pFolderPath,
                          EncodingOptions pEncodingDetails,
                          boolean pExportVersions,
                          boolean pExportSolutions)

Exports the master objets into a given folder.
Master objects include : Objects, Methodes, 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 export.

If files with the same name already exist in the folder, they will be overwritten.

Parameters:

pFolderPath - the folder in which the objects will be exported.

pEncodingDetails - details about the Java and XML encoding.

pExportVersions - if true, the versionned objects will be exported.

pExportSolutions - if true, the solutions of versionned objects will be exported.

Throws:

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

exportMasterInZipfile

void exportMasterInZipfile(java.lang.String pFolderPath,
                           java.lang.String pZipFileName,
                           boolean pOverwrite,
                           EncodingOptions pEncodingDetails,
                           boolean pExportVersions,
                           boolean pExportSolutions)
                           throws java.io.IOException

Exports the master objects into a given zip file.
Master objects include : Objects, Methodes, 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 export.

Parameters:

pFolderPath - the folder in which the zip file will be created.

pZipFileName - the name of the zip file.

pOverwrite - if true, will overwrite an existing zip file in the same folder with the same name.

pEncodingDetails - details about the Java and XML encoding.

pExportVersions - if true, the versionned objects will be exported.

pExportSolutions - if true, the solutions of versionned objects will be exported.

Throws:

java.io.IOException - if pOverwrite is false and the file already exists.

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

exportTopologyInFolder

void exportTopologyInFolder(java.lang.String pFolderPath,
                            EncodingOptions pEncodingDetails)

Exports the topology objets into a given folder.
Topology objects include : Entity IDs, Lacal Repositories, Connections, Hosts, Logical Agents, Agents, Generical Actions, Technologies, Datatypes, Datatypes conversions.

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

If files with the same name already exist in the folder, they will be overwritten.

Parameters:

pFolderPath - the folder in which the objects will be exported.

pEncodingDetails - details about the Java and XML encoding.

Throws:

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

exportTopologyInZipfile

void exportTopologyInZipfile(java.lang.String pFolderPath,
                             java.lang.String pZipFileName,
                             boolean pOverwrite,
                             EncodingOptions pEncodingDetails)
                             throws java.io.IOException

Exports the topology objects into a given zip file.
Topology objects include : Entity IDs, Lacal Repositories, Connections, Hosts, Logical Agents, Agents, Generical Actions, Technologies, Datatypes, Datatypes conversions.

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

Parameters:

pFolderPath - the folder in which the zip file will be created.

pZipFileName - the name of the zip file.

pOverwrite - if true, will overwrite an existing zip file in the same folder with the same name.

pEncodingDetails - details about the Java and XML encoding.

Throws:

java.io.IOException - if pOverwrite is false and the file already exists.

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

exportLogicalTopologyInFolder

void exportLogicalTopologyInFolder(java.lang.String pFolderPath,
                                   EncodingOptions pEncodingDetails)

Exports the logical topology objets into 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 export.

If files with the same name already exist in the folder, they will be overwritten.

Parameters:

pFolderPath - the folder in which the objects will be exported.

pEncodingDetails - details about the Java and XML encoding.

Throws:

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

exportLogicalTopologyInZipfile

void exportLogicalTopologyInZipfile(java.lang.String pFolderPath,
                                    java.lang.String pZipFileName,
                                    boolean pOverwrite,
                                    EncodingOptions pEncodingDetails)
                                    throws java.io.IOException

Exports the logical topology objects into 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 export.

Parameters:

pFolderPath - the folder in which the zip file will be created.

pZipFileName - the name of the zip file.

pOverwrite - if true, will overwrite an existing zip file in the same folder with the same name.

pEncodingDetails - details about the Java and XML encoding.

Throws:

java.io.IOException - if pOverwrite is false and the file already exists.

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

exportExecutionEnvironmentInFolder

void exportExecutionEnvironmentInFolder(java.lang.String pFolderPath,
                                        EncodingOptions pEncodingDetails)

Exports the execution environment objets into a given folder.
Execution Environment objects include : Technologies, Connections, Contexts, Agents, Generical Actions.

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

If files with the same name already exist in the folder, they will be overwritten.

Parameters:

pFolderPath - the folder in which the objects will be exported.

pEncodingDetails - details about the Java and XML encoding.

Throws:

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

exportExecutionEnvironmentInZipfile

void exportExecutionEnvironmentInZipfile(java.lang.String pFolderPath,
                                         java.lang.String pZipFileName,
                                         boolean pOverwrite,
                                         EncodingOptions pEncodingDetails)
                                         throws java.io.IOException

Exports the execution environment objects into a given zip file.
Execution Environment objects include : Technologies, Connections, Contexts, Agents, Generical Actions.

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

Parameters:

pFolderPath - the folder in which the zip file will be created.

pZipFileName - the name of the zip file.

pOverwrite - if true, will overwrite an existing zip file in the same folder with the same name.

pEncodingDetails - details about the Java and XML encoding.

Throws:

java.io.IOException - if pOverwrite is false and the file already exists.

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

Skip navigation links