oracle.rules.sdk2.repository
Class SandboxAccess

java.lang.Object
  oracle.rules.sdk2.repository.SandboxAccess

public abstract class SandboxAccess
extends java.lang.Object

Manage sandboxes and get access to metadata in a sandbox.

Method Summary

abstract void	abortSandbox() Abort the changes in the sandbox.
abstract RuleRepository	accessRepository() get a RuleRepository instance for accessing the sandbox.
abstract void	commitSandbox() Commit the changes in the sandbox so that they are visible outside the sandbox.
abstract java.lang.String	createSandbox(java.lang.String sandboxName) Create a new sandbox.
abstract boolean	isSandboxSupported() Check if this repository has a sandbox feature.
abstract java.util.List	listSandboxes() Get a list of the names of existing sandboxes.
static SandboxAccess	newInstance(RepositoryType type, RepositoryContext context) Create a SandboxAccess instance for the repository type and configuration specified.
abstract void	setSandboxName(java.lang.String sandboxName) Sets the name of the sandbox to use.

Methods inherited from class java.lang.Object

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

Method Detail

newInstance

public static SandboxAccess newInstance(RepositoryType type,
                                        RepositoryContext context)
                                 throws RepositoryException

Create a SandboxAccess instance for the repository type and configuration specified.

Parameters:

type - the repository type.

context - the repository initialization parameters.

Returns:

the SandboxAccess instance

Throws:

RepositoryException - if an error occurs during initialization

isSandboxSupported

public abstract boolean isSandboxSupported()

Check if this repository has a sandbox feature.

Returns:

true if sandboxes are supported.

listSandboxes

public abstract java.util.List listSandboxes()
                                      throws RepositoryException

Get a list of the names of existing sandboxes.

Returns:

the list of sandbox names

Throws:

RepositoryException - if an error occurs.

createSandbox

public abstract java.lang.String createSandbox(java.lang.String sandboxName)
                                        throws RepositoryException

Create a new sandbox. On successful creation, the specified sandbox name is set in this SandboxAccess instance.

Parameters:

sandboxName - the name of the new sandbox.

Returns:

the sandbox name

Throws:

RepositoryException - if an error occurs.

commitSandbox

public abstract void commitSandbox()
                            throws RepositoryException

Commit the changes in the sandbox so that they are visible outside the sandbox. On a successful commit, the sandbox is destroyed.

Throws:

RepositoryException - if an error occurs.

abortSandbox

public abstract void abortSandbox()
                           throws RepositoryException

Abort the changes in the sandbox. This destroys the sandbox.

Throws:

RepositoryException - if an error occurs.

accessRepository

public abstract RuleRepository accessRepository()
                                         throws RepositoryException

get a RuleRepository instance for accessing the sandbox.

Throws:

RepositoryException - if an error occurs.

setSandboxName

public abstract void setSandboxName(java.lang.String sandboxName)
                             throws RepositoryException

Sets the name of the sandbox to use.

Parameters:

sandboxName - the name of the new sandbox.

Throws:

RepositoryException - if an error occurs.