oracle.adf.share.sandbox

Class SandboxRuntimeSupport

java.lang.Object

oracle.adf.share.sandbox.SandboxRuntimeSupport

Direct Known Subclasses:

DefaultSandboxRuntimeSupport

public abstract class SandboxRuntimeSupport
extends java.lang.Object

A class that defines operations related to sandbox runtime.

Constructor Summary

Constructors

Constructor and Description
SandboxRuntimeSupport()

Method Summary

Modifier and Type	Method and Description
SandboxStateInfo	checkSandboxState(java.lang.String sandboxId) Checks the state of a sandbox
abstract boolean	enterUserSandbox(Sandbox sandbox) Associates a sandbox with the current user.
abstract Sandbox	exitUserSandbox() Removes the sandbox associated with the current user.
static SandboxRuntimeSupport	getInstance() Gets the system default instance of this class.
abstract Sandbox	getUserSandbox() Gets the sandbox associated with the current user.

Methods inherited from class java.lang.Object

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

Constructor Detail

SandboxRuntimeSupport

public SandboxRuntimeSupport()

Method Detail

getInstance

public static SandboxRuntimeSupport getInstance()

Gets the system default instance of this class.

Returns:

the system default instance of this class

getUserSandbox

public abstract Sandbox getUserSandbox()

Gets the sandbox associated with the current user.

Returns:

the sandbox associated with the current user; null if there is no user session or no sandbox is associated with the current session

enterUserSandbox

public abstract boolean enterUserSandbox(Sandbox sandbox)

Associates a sandbox with the current user.

Parameters:

sandbox - the sandbox to be associated with the current user

Returns:

true if there is a user session and the sandbox is successfully associated with the user; false otherwise.

Throws:

java.lang.IllegalArgumentException - if the given sandbox is null

exitUserSandbox

public abstract Sandbox exitUserSandbox()

Removes the sandbox associated with the current user.

Returns:

the sandbox previously associated with the current user; null if there is no user session or no sandbox was associated with the current user

checkSandboxState

public SandboxStateInfo checkSandboxState(java.lang.String sandboxId)

Checks the state of a sandbox

Parameters:

sandboxId - the ID of the sandbox

Returns:

the state information of the sadnbox; null if the sandbox does not exist or if the given sandbox ID is null