Skip navigation links

oracle.odi.setup
Interface IWorkRepositorySetup

All Known Implementing Classes:

WorkRepositorySetupImpl

public interface IWorkRepositorySetup

This interface defines methods to create and upgrade an ODI Work Repository.

Field Summary

static int	WORK_REPOSITORY_MAX_ID Work repository ID maximum value.
static int	WORK_REPOSITORY_PASSWORD_MAX_LENGTH The maximum length supported for a clear text password.

Method Summary

void	configureWorkRuntimeRepository(java.lang.String pWorkUrl, java.lang.String pWorkDriver, java.lang.String pWorkUsername, java.lang.String pWorkPassword, int pWorkRuntimeRepositoryId, java.lang.String pWorkRepositoryName, TechnologyName pWorkTechnology) Deprecated. with no replacement this method was only useful for RCU old integration usecase
boolean	createWorkDevRepository(java.lang.String pWorkUrl, java.lang.String pWorkDriver, java.lang.String pWorkUsername, java.lang.String pWorkPassword, int pWorkDevRepositoryId, java.lang.String pWorkRepositoryName, java.lang.String pWorkRepositoryPassword, TechnologyName pWorkTechnology, boolean pOverwrite) Deprecated. replaced by #createWorkRepository(WorkType, JdbcProperties, int, String, TechnologyName, boolean, String)
boolean	createWorkDevRepository(java.lang.String pWorkUrl, java.lang.String pWorkDriver, java.lang.String pWorkUsername, java.lang.String pWorkPassword, int pWorkDevRepositoryId, java.lang.String pWorkRepositoryName, TechnologyName pWorkTechnology, boolean pOverwrite) Deprecated. replaced by #createWorkRepository(WorkType, JdbcProperties, int, String, TechnologyName, boolean, String)
boolean	createWorkRepository(WorkRepository.WorkType pWorkType, JdbcProperties pWorkRepositoryJdbcProperties, int pWorkDevRepositoryId, java.lang.String pWorkRepositoryName, TechnologyName pWorkTechnology, boolean pOverwrite, char[] pWorkRepositoryPassword) Create an ODI Work repository into the database schema specified by the JdbcProperties parameters.
boolean	createWorkRuntimeRepository(java.lang.String pWorkUrl, java.lang.String pWorkDriver, java.lang.String pWorkUsername, java.lang.String pWorkPassword, int pWorkRuntimeRepositoryId, java.lang.String pWorkRepositoryName, java.lang.String pWorkRepositoryPassword, TechnologyName pWorkTechnology, boolean pOverwrite) Deprecated. replaced by #createWorkRepository(WorkType, JdbcProperties, int, String, TechnologyName, boolean, String)
boolean	createWorkRuntimeRepository(java.lang.String pWorkUrl, java.lang.String pWorkDriver, java.lang.String pWorkUsername, java.lang.String pWorkPassword, int pWorkRuntimeRepositoryId, java.lang.String pWorkRepositoryName, TechnologyName pWorkTechnology, boolean pOverwrite) Deprecated. replaced by #createWorkRepository(WorkType, JdbcProperties, int, String, TechnologyName, boolean, String)
boolean	isRepIdAndRepNameAvailable(int pWorkDevRepositoryId, java.lang.String pWorkRepositoryName) This method checks that the repository id and name are available.
void	upgradeWorkRepository(java.lang.String pWorkRepositoryName) Upgrade the work repository schema for the database specified by the given parameters.
void	upgradeWorkRepository(java.lang.String pWorkRepositoryName, JdbcProperties pWorkRepositoryNewJdbcProperties) Upgrade the work repository schema for the database specified by the given parameters.

Field Detail

WORK_REPOSITORY_PASSWORD_MAX_LENGTH

static final int WORK_REPOSITORY_PASSWORD_MAX_LENGTH

The maximum length supported for a clear text password.

See Also:

Constant Field Values

WORK_REPOSITORY_MAX_ID

static final int WORK_REPOSITORY_MAX_ID

Work repository ID maximum value.

See Also:

Constant Field Values

Method Detail

createWorkDevRepository

boolean createWorkDevRepository(java.lang.String pWorkUrl,
                                java.lang.String pWorkDriver,
                                java.lang.String pWorkUsername,
                                java.lang.String pWorkPassword,
                                int pWorkDevRepositoryId,
                                java.lang.String pWorkRepositoryName,
                                TechnologyName pWorkTechnology,
                                boolean pOverwrite)
                                throws RepositorySetupException

Deprecated. replaced by #createWorkRepository(WorkType, JdbcProperties, int, String, TechnologyName, boolean, String)

Create an ODI Work development repository into the database specified by the given parameters.

This method will create work repository schema for development with the specified ODI work repository name and without any password.

Parameters:

pWorkUrl - the url of the database where the work repository will be created

pWorkDriver - the JDBC driver name of the database

pWorkUsername - the username to connect to the database

pWorkPassword - the password to connect to the database

pWorkDevRepositoryId - the ID of the repository that will be created

pWorkRepositoryName - the logical name of the work repository

pWorkTechnology - the technology of the database

pOverwrite - true to override an existing repository, false otherwise. Note that overwrite of a repository having a different version might fail. In this case please cleanup your database schema manually.

Returns:

true if the repository has been created, and false in case a previous repository was found but invoker had asked to not overwrite any existing repository.

Throws:

RepositorySetupException - if failed to create that work repository

RepositoryScriptsNotFoundException - if failed to find the script files

createWorkDevRepository

boolean createWorkDevRepository(java.lang.String pWorkUrl,
                                java.lang.String pWorkDriver,
                                java.lang.String pWorkUsername,
                                java.lang.String pWorkPassword,
                                int pWorkDevRepositoryId,
                                java.lang.String pWorkRepositoryName,
                                java.lang.String pWorkRepositoryPassword,
                                TechnologyName pWorkTechnology,
                                boolean pOverwrite)
                                throws RepositorySetupException

Deprecated. replaced by #createWorkRepository(WorkType, JdbcProperties, int, String, TechnologyName, boolean, String)

Create an ODI Work development repository into the database specified by the given parameters.

This method will create work repository schema for development with the specified ODI work repository name and password.

Parameters:

pWorkUrl - the url of the database where the work repository will be created

pWorkDriver - the JDBC driver name of the database

pWorkUsername - the username to connect to the database

pWorkPassword - the password to connect to the database

pWorkDevRepositoryId - the ID of the repository that will be created

pWorkRepositoryName - the logical name of the work repository

pWorkRepositoryPassword - the password of the work repository

pWorkTechnology - the technology of the database

pOverwrite - true to override an existing repository, false otherwise. Note that overwrite of a repository having a different version might fail. In this case please cleanup your database schema manually.

Returns:

true if the repository has been created, and false in case a previous repository was found but invoker had asked to not overwrite any existing repository.

Throws:

RepositorySetupException - if failed to create that work repository

RepositoryScriptsNotFoundException - if failed to find the script files

createWorkRuntimeRepository

boolean createWorkRuntimeRepository(java.lang.String pWorkUrl,
                                    java.lang.String pWorkDriver,
                                    java.lang.String pWorkUsername,
                                    java.lang.String pWorkPassword,
                                    int pWorkRuntimeRepositoryId,
                                    java.lang.String pWorkRepositoryName,
                                    TechnologyName pWorkTechnology,
                                    boolean pOverwrite)
                                    throws RepositorySetupException

Deprecated. replaced by #createWorkRepository(WorkType, JdbcProperties, int, String, TechnologyName, boolean, String)

Create an ODI Work runtime repository into the database specified by the given parameters.

This method will create work repository schema for runtime with the specified ODI work repository name and without any password.

Parameters:

pWorkUrl - the url of the database where the work repository will be created

pWorkDriver - the JDBC driver name of the database

pWorkUsername - the username to connect to the database

pWorkPassword - the password to connect to the database

pWorkRuntimeRepositoryId - the ID of the repository that will be created

pWorkRepositoryName - the logical name of the work repository

pWorkTechnology - the technology of the database

pOverwrite - true to override an existing repository, false otherwise. Note that overwrite of a repository having a different version might fail. In this case please cleanup your database schema manually.

Returns:

true if the repository has been created, and false in case a previous repository was found but invoker had asked to not overwrite any existing repository.

Throws:

RepositorySetupException - if failed to create that work repository

RepositoryScriptsNotFoundException - if failed to find the script files

createWorkRuntimeRepository

boolean createWorkRuntimeRepository(java.lang.String pWorkUrl,
                                    java.lang.String pWorkDriver,
                                    java.lang.String pWorkUsername,
                                    java.lang.String pWorkPassword,
                                    int pWorkRuntimeRepositoryId,
                                    java.lang.String pWorkRepositoryName,
                                    java.lang.String pWorkRepositoryPassword,
                                    TechnologyName pWorkTechnology,
                                    boolean pOverwrite)
                                    throws RepositorySetupException

Deprecated. replaced by #createWorkRepository(WorkType, JdbcProperties, int, String, TechnologyName, boolean, String)

Create an ODI Work runtime repository into the database specified by the given parameters.

This method will create work repository schema for runtime with the specified ODI work repository name and password.

Parameters:

pWorkUrl - the url of the database where the work repository will be created

pWorkDriver - the JDBC driver name of the database

pWorkUsername - the username to connect to the database

pWorkPassword - the password to connect to the database

pWorkRuntimeRepositoryId - the ID of the repository that will be created

pWorkRepositoryName - the logical name of the work repository

pWorkRepositoryPassword - the password of the work repository

pWorkTechnology - the technology of the database

pOverwrite - true to override an existing repository, false otherwise. Note that overwrite of a repository having a different version might fail. In this case please cleanup your database schema manually.

Returns:

true if the repository has been created, and false in case a previous repository was found but invoker had asked to not overwrite any existing repository.

Throws:

RepositorySetupException - if failed to create that work repository

RepositoryScriptsNotFoundException - if failed to find the script files

upgradeWorkRepository

void upgradeWorkRepository(java.lang.String pWorkRepositoryName)
                           throws RepositorySetupException

Upgrade the work repository schema for the database specified by the given parameters.

In order to upgrade a work repository, caller of this method have to passe in an instance of ODI running only against an ODI Master repository.

Following the work repository type (development or runtime) that method will upgrade the repository schema accordingly.

Parameters:

pWorkRepositoryName - the name of the work repository to upgrade

Throws:

RepositorySetupException - if failed to upgrade the work repository

RepositoryScriptsNotFoundException - if failed to find the script files

upgradeWorkRepository

void upgradeWorkRepository(java.lang.String pWorkRepositoryName,
                           JdbcProperties pWorkRepositoryNewJdbcProperties)
                           throws RepositorySetupException

Upgrade the work repository schema for the database specified by the given parameters.

In order to upgrade a work repository, caller of this method have to passe in an instance of ODI running only against an ODI Master repository.

Following the work repository type (development or runtime) that method will upgrade the repository schema accordingly.

Parameters:

pWorkRepositoryName - the name of the work repository to upgrade

pWorkRepositoryNewJdbcProperties - The new location of the work repository (this can be usefull if it's different from the location defined in the master repository). If null the location currently in the master repostiory will be kept.

Throws:

RepositorySetupException - if failed to upgrade the work repository

RepositoryScriptsNotFoundException - if failed to find the script files

configureWorkRuntimeRepository

void configureWorkRuntimeRepository(java.lang.String pWorkUrl,
                                    java.lang.String pWorkDriver,
                                    java.lang.String pWorkUsername,
                                    java.lang.String pWorkPassword,
                                    int pWorkRuntimeRepositoryId,
                                    java.lang.String pWorkRepositoryName,
                                    TechnologyName pWorkTechnology)
                                    throws RepositorySetupException

Deprecated. with no replacement this method was only useful for RCU old integration usecase

Configure default content of a given ODI work runtime repository.

That method will also add work repository information into parent master repository.

Parameters:

pWorkUrl - the url of the database where the work repository will be created

pWorkDriver - the JDBC driver name of the database

pWorkUsername - the username to connect to the database

pWorkPassword - the password to connect to the database

pWorkRuntimeRepositoryId - the ID of the repository that will be created

pWorkRepositoryName - the logical name of the work repository

pWorkTechnology - the technology of the database

Throws:

RepositorySetupException - if failed to create that work repository

RepositoryScriptsNotFoundException - if failed to find the script files

isRepIdAndRepNameAvailable

boolean isRepIdAndRepNameAvailable(int pWorkDevRepositoryId,
                                   java.lang.String pWorkRepositoryName)
                                   throws RepositorySetupException

This method checks that the repository id and name are available.

Parameters:

pWorkDevRepositoryId - the ID of the repository

pWorkRepositoryName - the logical name of the work repository

Returns:

true if the specified work repository id and name are available, false if they are already used.

Throws:

RepositorySetupException

createWorkRepository

boolean createWorkRepository(WorkRepository.WorkType pWorkType,
                             JdbcProperties pWorkRepositoryJdbcProperties,
                             int pWorkDevRepositoryId,
                             java.lang.String pWorkRepositoryName,
                             TechnologyName pWorkTechnology,
                             boolean pOverwrite,
                             char[] pWorkRepositoryPassword)
                             throws RepositorySetupException

Create an ODI Work repository into the database schema specified by the JdbcProperties parameters.

This method will create work repository with the specified ODI work repository name and without any password.

Parameters:

pWorkType - the type of repository that will be created

pWorkRepositoryJdbcProperties - the jdbc properties of the database where the work repository will be created.

pWorkDevRepositoryId - the ID of the repository that will be created

pWorkRepositoryName - the logical name of the work repository

pWorkTechnology - the technology of the database

pOverwrite - true to override an existing repository, false otherwise. Note that overwrite of a repository having a different version might fail. In this case please cleanup your database schema manually.

pWorkRepositoryPassword - the work repository password that will be prompted if the created repository is attached later to another master. If null value is passed in no password check will be done at attachment.

Returns:

true if the repository has been created, and false in case a previous repository was found but invoker had asked to not overwrite any existing repository.

Throws:

RepositorySetupException - if failed to create that work repository

RepositoryScriptsNotFoundException - if failed to find the script files

Skip navigation links