com.delphix.delphix

Class DelphixEngine

java.lang.Object

com.delphix.delphix.DelphixEngine

public class DelphixEngine
extends java.lang.Object

Used for interacting with a Delphix Engine

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DelphixEngine.ContainerOperationType
static class	DelphixEngine.EnvironmentOperationType

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CONTENT_COMPATIBLE_REPOSITORIES
static java.lang.String	CONTENT_LATEST_POINT
static java.lang.String	CONTENT_LATEST_SNAPSHOT
static java.lang.String	CONTENT_REFRESH_HOOK
static java.lang.String	CONTENT_ROLLBACK_HOOK
static java.lang.String	CONTENT_SYNC_HOOK

Constructor Summary

Constructors

Constructor and Description
DelphixEngine(DelphixEngine engine)
DelphixEngine(java.lang.String engineAddress, java.lang.String engineUsername, java.lang.String enginePassword)

Method Summary

Modifier and Type	Method and Description
void	cancelJob(java.lang.String jobRef) Cancel a job running on the Delphix Engine
java.lang.String	createEnvironment(java.lang.String address, java.lang.String user, java.lang.String password, java.lang.String toolkit) Create and discover an environment
java.lang.String	deleteContainer(java.lang.String containerRef) Delete a container
java.lang.String	deleteEnvironment(java.lang.String environmentRef) Delete an environment
java.util.ArrayList<DelphixRepository>	getCompatibleRepositoriesContainer(java.lang.String environmentRef, java.lang.String containerRef, java.lang.String location) Get the compatible provision repositories from a semantic point on a container
java.util.ArrayList<DelphixRepository>	getCompatibleRepositoriesSnapshot(java.lang.String environmentRef, java.lang.String snapshotRef) Get the compatible provision repositories from a snapshot
DelphixContainer	getContainer(java.lang.String reference) Get a single container
java.lang.String	getEngineAddress()
java.lang.String	getEnginePassword()
java.lang.String	getEngineUsername()
JobStatus	getJobStatus(java.lang.String job) Get the status of a job running on the Delphix Engine
java.lang.String	getParentContainer(java.lang.String vdbRef) Get the parent of a virtual database on the Delphix Engine
DelphixRepository	getRepository(java.lang.String repositoryRef) Gets a repository
DelphixSnapshot	getSnapshot(java.lang.String reference)
java.util.ArrayList<DelphixClusterNode>	listClusterNodes() Get cluster nodes
java.util.LinkedHashMap<java.lang.String,DelphixContainer>	listContainers() List containers in the Delphix Engine
java.util.LinkedHashMap<java.lang.String,DelphixEnvironment>	listEnvironments() List environments in the Delphix Engine
java.util.ArrayList<DelphixGroup>	listGroups()
java.util.LinkedHashMap<java.lang.String,DelphixSnapshot>	listSnapshots() List snapshots in the Delphix Engine
java.util.LinkedHashMap<java.lang.String,DelphixSource>	listSources() List sources in the Delphix Engine
java.util.LinkedHashMap<java.lang.String,DelphixTimeflow>	listTimeflows() List timeflows in the Delphix Engine
void	login() Login to Delphix Engine Will throw a DelphixEngineException if the login fails due to bad username or password
java.lang.String	provisionVDB(java.lang.String containerRef, java.lang.String snapshotRef, java.lang.String containerName, java.lang.String repositoryRef, java.lang.String mountBase) Provision a VDB either a semantic point or a snapshot with the name of the new VDB being optional
java.lang.String	refreshContainer(java.lang.String vdbRef, java.lang.String location) Refresh a virtual database on the Delphix Engine using semantic location
java.lang.String	refreshEnvironment(java.lang.String environmentRef) Refresh and discover an environment
java.lang.String	rollbackContainer(java.lang.String vdbRef, java.lang.String location) Rollback a virtual database on the Delphix Engine using semantic location
java.lang.String	sync(java.lang.String sourceRef) Run a sync operation for a source on the Delphix Engine
void	updateHooks(DelphixEngine.ContainerOperationType targetOperation, java.lang.String containerRef, java.util.ArrayList<HookOperation> preOperations, java.util.ArrayList<HookOperation> postOperations) Update the pre and post hooks for a specific type of operation on a container

Methods inherited from class java.lang.Object

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

Field Detail

CONTENT_LATEST_POINT

public static final java.lang.String CONTENT_LATEST_POINT

See Also:

Constant Field Values

CONTENT_LATEST_SNAPSHOT

public static final java.lang.String CONTENT_LATEST_SNAPSHOT

See Also:

Constant Field Values

CONTENT_SYNC_HOOK

public static final java.lang.String CONTENT_SYNC_HOOK

See Also:

Constant Field Values

CONTENT_REFRESH_HOOK

public static final java.lang.String CONTENT_REFRESH_HOOK

See Also:

Constant Field Values

CONTENT_ROLLBACK_HOOK

public static final java.lang.String CONTENT_ROLLBACK_HOOK

See Also:

Constant Field Values

CONTENT_COMPATIBLE_REPOSITORIES

public static final java.lang.String CONTENT_COMPATIBLE_REPOSITORIES

See Also:

Constant Field Values

Constructor Detail

DelphixEngine

@DataBoundConstructor
public DelphixEngine(java.lang.String engineAddress,
                                           java.lang.String engineUsername,
                                           java.lang.String enginePassword)

DelphixEngine

public DelphixEngine(DelphixEngine engine)

Method Detail

login

public void login()
           throws java.io.IOException,
                  DelphixEngineException

Login to Delphix Engine Will throw a DelphixEngineException if the login fails due to bad username or password

Throws:

java.io.IOException

DelphixEngineException

getContainer

public DelphixContainer getContainer(java.lang.String reference)
                              throws org.apache.http.client.ClientProtocolException,
                                     java.io.IOException,
                                     DelphixEngineException

Get a single container

Throws:

org.apache.http.client.ClientProtocolException

java.io.IOException

DelphixEngineException

listContainers

public java.util.LinkedHashMap<java.lang.String,DelphixContainer> listContainers()
                                                                          throws org.apache.http.client.ClientProtocolException,
                                                                                 java.io.IOException,
                                                                                 DelphixEngineException

List containers in the Delphix Engine

Throws:

org.apache.http.client.ClientProtocolException

java.io.IOException

DelphixEngineException

listGroups

public java.util.ArrayList<DelphixGroup> listGroups()
                                             throws java.io.IOException,
                                                    DelphixEngineException

Throws:

java.io.IOException

DelphixEngineException

listSources

public java.util.LinkedHashMap<java.lang.String,DelphixSource> listSources()
                                                                    throws org.apache.http.client.ClientProtocolException,
                                                                           java.io.IOException,
                                                                           DelphixEngineException

List sources in the Delphix Engine

Throws:

org.apache.http.client.ClientProtocolException

java.io.IOException

DelphixEngineException

listTimeflows

public java.util.LinkedHashMap<java.lang.String,DelphixTimeflow> listTimeflows()
                                                                        throws org.apache.http.client.ClientProtocolException,
                                                                               java.io.IOException,
                                                                               DelphixEngineException

List timeflows in the Delphix Engine

Throws:

org.apache.http.client.ClientProtocolException

java.io.IOException

DelphixEngineException

listEnvironments

public java.util.LinkedHashMap<java.lang.String,DelphixEnvironment> listEnvironments()
                                                                              throws org.apache.http.client.ClientProtocolException,
                                                                                     java.io.IOException,
                                                                                     DelphixEngineException

List environments in the Delphix Engine

Throws:

org.apache.http.client.ClientProtocolException

java.io.IOException

DelphixEngineException

getSnapshot

public DelphixSnapshot getSnapshot(java.lang.String reference)
                            throws org.apache.http.client.ClientProtocolException,
                                   java.io.IOException,
                                   DelphixEngineException

Throws:

org.apache.http.client.ClientProtocolException

java.io.IOException

DelphixEngineException

listSnapshots

public java.util.LinkedHashMap<java.lang.String,DelphixSnapshot> listSnapshots()
                                                                        throws org.apache.http.client.ClientProtocolException,
                                                                               java.io.IOException,
                                                                               DelphixEngineException

List snapshots in the Delphix Engine

Throws:

org.apache.http.client.ClientProtocolException

java.io.IOException

DelphixEngineException

cancelJob

public void cancelJob(java.lang.String jobRef)
               throws org.apache.http.client.ClientProtocolException,
                      java.io.IOException,
                      DelphixEngineException

Cancel a job running on the Delphix Engine

Throws:

org.apache.http.client.ClientProtocolException

java.io.IOException

DelphixEngineException

getJobStatus

public JobStatus getJobStatus(java.lang.String job)
                       throws org.apache.http.client.ClientProtocolException,
                              java.io.IOException,
                              DelphixEngineException

Get the status of a job running on the Delphix Engine

Throws:

org.apache.http.client.ClientProtocolException

java.io.IOException

DelphixEngineException

refreshContainer

public java.lang.String refreshContainer(java.lang.String vdbRef,
                                         java.lang.String location)
                                  throws java.io.IOException,
                                         DelphixEngineException

Refresh a virtual database on the Delphix Engine using semantic location

Throws:

java.io.IOException

DelphixEngineException

rollbackContainer

public java.lang.String rollbackContainer(java.lang.String vdbRef,
                                          java.lang.String location)
                                   throws java.io.IOException,
                                          DelphixEngineException

Rollback a virtual database on the Delphix Engine using semantic location

Throws:

java.io.IOException

DelphixEngineException

getParentContainer

public java.lang.String getParentContainer(java.lang.String vdbRef)
                                    throws java.io.IOException,
                                           DelphixEngineException

Get the parent of a virtual database on the Delphix Engine

Throws:

java.io.IOException

DelphixEngineException

sync

public java.lang.String sync(java.lang.String sourceRef)
                      throws java.io.IOException,
                             DelphixEngineException

Run a sync operation for a source on the Delphix Engine

Throws:

java.io.IOException

DelphixEngineException

getRepository

public DelphixRepository getRepository(java.lang.String repositoryRef)
                                throws java.io.IOException,
                                       DelphixEngineException

Gets a repository

Throws:

java.io.IOException

DelphixEngineException

listClusterNodes

public java.util.ArrayList<DelphixClusterNode> listClusterNodes()
                                                         throws java.io.IOException,
                                                                DelphixEngineException

Get cluster nodes

Throws:

java.io.IOException

DelphixEngineException

getCompatibleRepositoriesSnapshot

public java.util.ArrayList<DelphixRepository> getCompatibleRepositoriesSnapshot(java.lang.String environmentRef,
                                                                                java.lang.String snapshotRef)
                                                                         throws org.apache.http.client.ClientProtocolException,
                                                                                java.io.IOException,
                                                                                DelphixEngineException

Get the compatible provision repositories from a snapshot

Throws:

org.apache.http.client.ClientProtocolException

java.io.IOException

DelphixEngineException

getCompatibleRepositoriesContainer

public java.util.ArrayList<DelphixRepository> getCompatibleRepositoriesContainer(java.lang.String environmentRef,
                                                                                 java.lang.String containerRef,
                                                                                 java.lang.String location)
                                                                          throws java.io.IOException,
                                                                                 DelphixEngineException

Get the compatible provision repositories from a semantic point on a container

Throws:

java.io.IOException

DelphixEngineException

provisionVDB

public java.lang.String provisionVDB(java.lang.String containerRef,
                                     java.lang.String snapshotRef,
                                     java.lang.String containerName,
                                     java.lang.String repositoryRef,
                                     java.lang.String mountBase)
                              throws java.io.IOException,
                                     DelphixEngineException

Provision a VDB either a semantic point or a snapshot with the name of the new VDB being optional

Throws:

java.io.IOException

DelphixEngineException

createEnvironment

public java.lang.String createEnvironment(java.lang.String address,
                                          java.lang.String user,
                                          java.lang.String password,
                                          java.lang.String toolkit)
                                   throws java.io.IOException,
                                          DelphixEngineException

Create and discover an environment

Throws:

java.io.IOException

DelphixEngineException

deleteContainer

public java.lang.String deleteContainer(java.lang.String containerRef)
                                 throws java.io.IOException,
                                        DelphixEngineException

Delete a container

Throws:

java.io.IOException

DelphixEngineException

refreshEnvironment

public java.lang.String refreshEnvironment(java.lang.String environmentRef)
                                    throws java.io.IOException,
                                           DelphixEngineException

Refresh and discover an environment

Throws:

java.io.IOException

DelphixEngineException

deleteEnvironment

public java.lang.String deleteEnvironment(java.lang.String environmentRef)
                                   throws java.io.IOException,
                                          DelphixEngineException

Delete an environment

Throws:

java.io.IOException

DelphixEngineException

updateHooks

public void updateHooks(DelphixEngine.ContainerOperationType targetOperation,
                        java.lang.String containerRef,
                        java.util.ArrayList<HookOperation> preOperations,
                        java.util.ArrayList<HookOperation> postOperations)
                 throws java.io.IOException,
                        DelphixEngineException

Update the pre and post hooks for a specific type of operation on a container

Throws:

java.io.IOException

DelphixEngineException

getEngineAddress

public java.lang.String getEngineAddress()

getEngineUsername

public java.lang.String getEngineUsername()

getEnginePassword

public java.lang.String getEnginePassword()