oracle.odi.core.service.vcs

Class VersionManagementService

java.lang.Object

oracle.odi.core.service.vcs.VersionManagementService

public class VersionManagementService
extends java.lang.Object

Service class Provides methods to executes Version Control System operations

Since:

12.2.1.2.1.

Method Summary

Modifier and Type	Method and Description
static void	cloneRemoteRepository(OdiInstance pOdiInstance, OdiVcsRepositoryConnectionInfo pVcsConnectionInfo, java.lang.String pLocalGitPath) API to clone remote repository.
static void	configure(OdiInstance pOdiInstance, OdiVcsRepositoryConnectionInfo pVcsConnectionInfo, java.lang.String pSettingFolderPath, java.lang.String pVcsRepoName, java.lang.String pBranchName, java.lang.String pProjectName, boolean pAutoVersioning, boolean pReConfigure, char[] pVcsKey) Configures the ODI repository with the respective Version Control system repository.
static void	createFullTag(OdiInstance pOdiInstance, OdiVcsRepositoryConnectionInfo pVcsConnectionInfo, java.lang.String pTagName, java.lang.String pCommitMessage, boolean pOnlyVersionedObjects, boolean pRegenerateAndVersionScenario) Creates new tag from configured branch.
static void	createPartialTag(OdiInstance pOdiInstance, OdiVcsRepositoryConnectionInfo pVcsConnectionInfo, java.lang.String pTagName, java.util.List pOdiObjects, java.lang.String pCommitMessage, boolean pOnlyVersionedObjects, boolean pIncludeSecurityObjects, boolean pRegenerateAndVersionScenario) Creates partial tag from configured branch.
static void	populateOdiRepositoryFromBranch(OdiInstance pOdiInstance, OdiVcsRepositoryConnectionInfo pVcsConnectionInfo, boolean pDeleteWorkRepoObjects) Populate ODI repository from configured branch or trunk,
static void	populateOdiRepositoryFromTag(OdiInstance pOdiInstance, OdiVcsRepositoryConnectionInfo pVcsConnectionInfo, java.lang.String pTagName, boolean pDeleteWorkRepoObjects) Populate ODI repository from Tag,
static void	setVersioningApplication(OdiInstance pOdiInstance, OdiVcsRepositoryConnectionInfo pVcsConnectionInfo) Saves Version management application to ODI repository, Need to reinitialize OdiInstance reflect the same.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

createFullTag

public static void createFullTag(OdiInstance pOdiInstance,
                                 OdiVcsRepositoryConnectionInfo pVcsConnectionInfo,
                                 java.lang.String pTagName,
                                 java.lang.String pCommitMessage,
                                 boolean pOnlyVersionedObjects,
                                 boolean pRegenerateAndVersionScenario)
                          throws VersionManagementServiceException

Creates new tag from configured branch. If the specified tag already exists, then create full tag operations fails If the user who is trying to create tag is a non Version Control System admin, then create full tag operation fails. If the specified tag name is null or empty, then it fails

Parameters:

pOdiInstance - - ODI Instance

pVcsConnectionInfo - - Connection Parameters to make connection with the Version Control System. @See OdiVcsRepositoryConnectionInfo for creating Connection Info Object

pTagName - - Version Control System Full tag name

pCommitMessage - - Commit message

pOnlyVersionedObjects - - boolean to indicate if tag has to be with already versioned objects only. true will exclude all unversioned objects while creating the tag, false will add unversioned objects to Version Control System before creating the tag.

pRegenerateAndVersionScenario - - boolean to indicate if scenarios need to be regenerate and versioned. true will regenerate and version scenario if scenario generator is being versioned.

Throws:

VersionManagementServiceException

configure

public static void configure(OdiInstance pOdiInstance,
                             OdiVcsRepositoryConnectionInfo pVcsConnectionInfo,
                             java.lang.String pSettingFolderPath,
                             java.lang.String pVcsRepoName,
                             java.lang.String pBranchName,
                             java.lang.String pProjectName,
                             boolean pAutoVersioning,
                             boolean pReConfigure,
                             char[] pVcsKey)
                      throws VersionManagementServiceException

Configures the ODI repository with the respective Version Control system repository. Need to re initialize OdiInstance to reflect the configuration invoke VersionManagementService.setVersioningApplication before making this call.

Parameters:

pOdiInstance - - ODI Instance

pVcsConnectionInfo - - Connection Parameters to make connection with the Version Control System. @See OdiVcsRepositoryConnectionInfo for creating Connection Info Object

pSettingFolderPath - - Path for the Local Work/Merge directory, applicable only if version control application is SVN.

pVcsRepoName - - Name of the Version Control Systems's repository to be configured with ODI repository

pBranchName - The branch-name in the Version Control Systems's repository.

pProjectName - name of the SVN project name, applicable only if version control application is SVN.

[AutoVersioning - Boolean flag to indicate, whether auto-versioning should be enabled. If this flag is enabled, then, whenever an ODI object is saved a new version will be created.

pReConfigure - Boolean flag to indicate, whether need to re attach Version control repository which is configured to another ODI Repository. true - in case want to re attach Version control repository which is configured to another ODI Repository. false - in case don't want to configure Version Control system attached to another ODI repository.

pVcsKey - vcs key for handling the cipher data.

Throws:

VersionManagementServiceException

setVersioningApplication

public static void setVersioningApplication(OdiInstance pOdiInstance,
                                            OdiVcsRepositoryConnectionInfo pVcsConnectionInfo)
                                     throws VersionManagementServiceException

Saves Version management application to ODI repository, Need to reinitialize OdiInstance reflect the same.

Parameters:

pOdiInstance - - ODI Instance

pVcsConnectionInfo - - Connection Parameters to make connection with the Version Control System. @See OdiVcsRepositoryConnectionInfo for creating Connection Info Object. pass null value to reset ODI repository to legacy version control system.

Throws:

VersionManagementServiceException

populateOdiRepositoryFromBranch

public static void populateOdiRepositoryFromBranch(OdiInstance pOdiInstance,
                                                   OdiVcsRepositoryConnectionInfo pVcsConnectionInfo,
                                                   boolean pDeleteWorkRepoObjects)
                                            throws VersionManagementServiceException

Populate ODI repository from configured branch or trunk,

Parameters:

pOdiInstance - - ODI Instance

pVcsConnectionInfo - - Connection Parameters to make connection with the Version Control System. @See OdiVcsRepositoryConnectionInfo for creating Connection Info Object

pDeleteWorkRepoObjects - - deleteWorkRepositoryObjects boolean to indicate if work repository objects needs to be deleted. true - ODI will remove existing work repository objects and populate. false - ODI will keep existing repository objects and restore. This flag doesn't have any significance when ODI work repository is empty

Throws:

VersionManagementServiceException

populateOdiRepositoryFromTag

public static void populateOdiRepositoryFromTag(OdiInstance pOdiInstance,
                                                OdiVcsRepositoryConnectionInfo pVcsConnectionInfo,
                                                java.lang.String pTagName,
                                                boolean pDeleteWorkRepoObjects)
                                         throws VersionManagementServiceException

Populate ODI repository from Tag,

Parameters:

pOdiInstance - - ODI Instance

pVcsConnectionInfo - - Connection Parameters to make connection with the Version Control System. @See OdiVcsRepositoryConnectionInfo for creating Connection Info Object

pTagName - - Tag name in version control system. ODI can populate the repository only if the tag is created from current branch

pDeleteWorkRepoObjects - - deleteWorkRepositoryObjects boolean to indicate if work repository objects needs to be deleted. true - ODI will remove existing work repository objects and restore. false - ODI will keep existing repository objects and populate. This flag doesn't have any significance when ODI work repository is empty

Throws:

VersionManagementServiceException

cloneRemoteRepository

public static void cloneRemoteRepository(OdiInstance pOdiInstance,
                                         OdiVcsRepositoryConnectionInfo pVcsConnectionInfo,
                                         java.lang.String pLocalGitPath)
                                  throws VersionManagementServiceException

API to clone remote repository. Applicable only if Version management application is Git

Parameters:

pOdiInstance - - ODI Instance

pVcsConnectionInfo - - Connection Parameters to make connection with the Version Control System. @See OdiVcsRepositoryConnectionInfo for creating Connection Info Object

pLocalGitPath - - Path of the local git repository

Throws:

VersionManagementServiceException

createPartialTag

public static void createPartialTag(OdiInstance pOdiInstance,
                                    OdiVcsRepositoryConnectionInfo pVcsConnectionInfo,
                                    java.lang.String pTagName,
                                    java.util.List pOdiObjects,
                                    java.lang.String pCommitMessage,
                                    boolean pOnlyVersionedObjects,
                                    boolean pIncludeSecurityObjects,
                                    boolean pRegenerateAndVersionScenario)
                             throws VersionManagementServiceException

Creates partial tag from configured branch. If the specified tag already exists, then create partial tag operations fails If the user who is trying to create tag is a non Version Control System admin, then create full tag operation will fails. If the specified tag name is null or empty, then it fails

Parameters:

pOdiInstance - - ODI Instance

pVcsConnectionInfo - - Connection Parameters to make connection with the Version Control System. @See OdiVcsRepositoryConnectionInfo for creating Connection Info Object

pTagName - - Version Control System Partial tag name

pOdiObjects - - List of ODI entities for which the tag is to be created.

pCommitMessage - - Commit message

pOnlyVersionedObjects - - boolean to indicate if tag has to be with already versioned objects only. true will exclude all Non-Versioned objects while creating the tag, false will add Non-Versioned objects to Version Control System before creating the tag.

pIncludeSecurityObjects - Boolean flag to convey if all security objects (users & profiles) to be included in the newly created tag.

pRegenerateAndVersionScenario - - boolean to indicate if scenarios need to be regenerate and versioned. true will regenerate and version scenario if scenario generator is being versioned.

Throws:

VersionManagementServiceException