oracle.adf.share.sandbox.util

Class SandboxEnvironmentShell

java.lang.Object

oracle.adf.share.MetadataEnvironmentShell

oracle.adf.share.sandbox.util.SandboxEnvironmentShell

public class SandboxEnvironmentShell
extends MetadataEnvironmentShell

An interface for performing operations in a specific sandbox environment. The execute methods in this class ensure that SandboxEnvironment.getCurrent() returns an object for the sandbox specified by the constructor during the execution of the Callable. Typically an instance of this class is used to perform a sandbox operation when the current thread is not associated with a sandbox but the operation expects SandboxEnvironment.getCurrent() to return an instance associated with the sandbox.

Nested Class Summary

Nested classes/interfaces inherited from class oracle.adf.share.MetadataEnvironmentShell

MetadataEnvironmentShell.ThreadResources, MetadataEnvironmentShell.Variable<T>, MetadataEnvironmentShell.Variables

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	_sandboxId The ID of the sandbox this environment shell is for.
static MetadataEnvironmentShell.Variable<java.lang.Boolean>	IS_REQUEST_FOR_REFRESH The variable that provides the returned value of SandboxEnvironment.isRequestForRefresh() in a SandboxEnvironmentThread.

Fields inherited from class oracle.adf.share.MetadataEnvironmentShell

CONTEXT_PARAMETER_MAP, ISOLATED, metadataRevisionId

Constructor Summary

Constructors

Constructor and Description
SandboxEnvironmentShell(java.lang.String sandboxId) Constructs a shell for a sandbox.
SandboxEnvironmentShell(java.lang.String sandboxId, MdsRepository mdsRepos) Constructs a shell for an MDS repository in a sandbox.
SandboxEnvironmentShell(java.lang.String sandboxId, MdsRepository mdsRepos, MetadataEnvironmentShell.Variables globalVariables) Constructs a shell for an MDS repository in a sandbox.

Method Summary

Modifier and Type	Method and Description
protected java.lang.String	getMdsRepositoryId() Returns the ID of the MDS repository if this shell is for an MDS repository.
protected oracle.mds.naming.Namespace	getMdsStoreLocator() Returns the namespace to identify the store used by the MDS repository if this shell is for an MDS repository.
java.lang.String	getSandboxId() Returns the ID of the sandbox this shell is for.
protected SandboxEnvironmentThread	newSandboxEnvironmentThread(MetadataEnvironmentShell.Variables variables, java.lang.ThreadGroup group, java.lang.Runnable target, java.lang.String name, long stackSize) Creates a thread for task execution.
protected MetadataEnvironmentThread	newThread(MetadataEnvironmentShell.Variables variables, java.lang.ThreadGroup group, java.lang.Runnable target, java.lang.String name, long stackSize) Creates a thread for task execution.
protected MetadataEnvironmentThread.Resources	newThreadResources() Returns resources acquired from the current thread.

Methods inherited from class oracle.adf.share.MetadataEnvironmentShell

call, call, current, execute, execute, execute, execute, getGlobalVariable, getMetadataRevisionId, getVariable, isGlobalVariableSet, isVariableSet

Methods inherited from class java.lang.Object

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

Field Detail

IS_REQUEST_FOR_REFRESH

public static final MetadataEnvironmentShell.Variable<java.lang.Boolean> IS_REQUEST_FOR_REFRESH

The variable that provides the returned value of SandboxEnvironment.isRequestForRefresh() in a SandboxEnvironmentThread.

_sandboxId

protected final java.lang.String _sandboxId

The ID of the sandbox this environment shell is for.

Constructor Detail

SandboxEnvironmentShell

public SandboxEnvironmentShell(java.lang.String sandboxId)

Constructs a shell for a sandbox.

Parameters:

sandboxId - the ID of the sandbox

Throws:

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

SandboxEnvironmentShell

public SandboxEnvironmentShell(java.lang.String sandboxId,
                               MdsRepository mdsRepos)

Constructs a shell for an MDS repository in a sandbox.

Parameters:

sandboxId - the ID of the sandbox

mdsRepos - the MDS repository

SandboxEnvironmentShell

public SandboxEnvironmentShell(java.lang.String sandboxId,
                               MdsRepository mdsRepos,
                               MetadataEnvironmentShell.Variables globalVariables)

Constructs a shell for an MDS repository in a sandbox.

Parameters:

sandboxId - the ID of the sandbox

mdsRepos - the MDS repository

globalVariables - the global variables; null if none

Method Detail

getSandboxId

public final java.lang.String getSandboxId()

Returns the ID of the sandbox this shell is for.

Returns:

the ID of the sandbox

newSandboxEnvironmentThread

protected SandboxEnvironmentThread newSandboxEnvironmentThread(MetadataEnvironmentShell.Variables variables,
                                                               java.lang.ThreadGroup group,
                                                               java.lang.Runnable target,
                                                               java.lang.String name,
                                                               long stackSize)

Creates a thread for task execution. Please see java.lang.Thread for more information about the parameters.

Parameters:

variables - the variables to be set in this thread, or null if no variables need to be set

group - the thread group

target - the object whose run is called

name - the name of the new thread

stackSize - the desired stack size for the new thread, or zero to indicate that this parameter is to be ignored

Returns:

the new thread for task execution

newThreadResources

protected MetadataEnvironmentThread.Resources newThreadResources()

Description copied from class: MetadataEnvironmentShell

Returns resources acquired from the current thread. The resources will be passed into a new thread for resource initialization and finalization in the new thread. Subclasses may override this method to return a variant of ThreadResources in order to propagate more information from the current thread to the new thread.

Returns:

the resources acquired from the current thread

getMdsRepositoryId

protected final java.lang.String getMdsRepositoryId()

Returns the ID of the MDS repository if this shell is for an MDS repository.

Returns:

the ID of the MDS repository if this shell is for an MDS repository; null otherwise

getMdsStoreLocator

protected final oracle.mds.naming.Namespace getMdsStoreLocator()

Returns the namespace to identify the store used by the MDS repository if this shell is for an MDS repository.

Returns:

the namespace to identify the store used by the MDS repository if this shell is for an MDS repository; null otherwise

newThread

protected final MetadataEnvironmentThread newThread(MetadataEnvironmentShell.Variables variables,
                                                    java.lang.ThreadGroup group,
                                                    java.lang.Runnable target,
                                                    java.lang.String name,
                                                    long stackSize)

Description copied from class: MetadataEnvironmentShell

Creates a thread for task execution. Please see java.lang.Thread for more information about the parameters.

Overrides:

newThread in class MetadataEnvironmentShell

Parameters:

variables - the variables to be set in this thread, or null if no variables need to be set

group - the thread group

target - the object whose run is called

name - the name of the new thread

stackSize - the desired stack size for the new thread, or zero to indicate that this parameter is to be ignored

Returns:

the new thread for task execution