oracle.adf.share.sandbox.util

Class SandboxPlayground

java.lang.Object

oracle.adf.share.sandbox.util.SandboxPlayground

public class SandboxPlayground
extends java.lang.Object

A test sandbox that allows developers of SandboxedRepository or SandboxedFeature subclasses to run through the life cycle of a sandbox and test the implementation.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	JDBC_URL The name of the Java system property that defines the JDBC URL of the database the framework uses.

Method Summary

Modifier and Type	Method and Description
void	addRepository(java.lang.String repositoryId) Adds a sandboxed repository.
static SandboxPlayground	create(java.lang.String name) Creates a new sandbox playground.
static SandboxPlayground	create(java.lang.String name, SandboxConstraints constraints) Creates a sandbox playground with a set of constraints on the sandbox.
boolean	destroy() Destroyes this sandbox playground.
void	enableFeature(java.lang.String featureId) Enables a sandboxed feature.
void	enterSandboxEnvironment() Sets the metadata environment of the current ADF context to be a sandbox environment for this sandbox playground.
static boolean	exists(java.lang.String name) Checks if a name is already taken.
java.io.PrintStream	getDiagnosticsPrintStream() Returns the print stream this object prints out diagnostics messages to.
java.lang.String	getOperationLog() Gets the log from the last operation.
java.lang.Throwable	getRepositoryError(java.lang.String repositoryId) Gets the error resulted from a repository.
java.util.Map<java.lang.String,java.lang.Throwable>	getRepositoryErrors() Returns errors from all repositories.
boolean	interactiveRefresh(ChangeHint changeHint) Refreshes the sandbox and sets the change hint if any of the repositories requests for it.
static java.util.List<java.lang.String>	listAvailableFeatures() Lists all available features discovered by the framework.
static java.util.List<java.lang.String>	listAvailableRepositories() Lists all available repositories discovered by the framework.
static SandboxPlayground	load(java.lang.String name) Loads an existing sandbox playground.
void	printRepositoryErrors() Prints the errors from repositories to the standard error stream.
boolean	publish() Publishes this sandbox playground.
boolean	refresh() Refreshes the sandbox.
void	setDiagnosticsPrintStream(java.io.PrintStream out) Sets the print stream for this object to print out diagnostics messages.

Methods inherited from class java.lang.Object

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

Field Detail

JDBC_URL

public static final java.lang.String JDBC_URL

The name of the Java system property that defines the JDBC URL of the database the framework uses. The name is oracle.adf.share.sandbox.util.SandboxPlayground.JDBC_URL. An example of the value: "jdbc:oracle:thin:user/pwd@host:3000:dbname"/

Method Detail

exists

public static boolean exists(java.lang.String name)

Checks if a name is already taken.

Parameters:

name - the name of the playground

Returns:

true if the playground with the specified name exists

Throws:

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

create

public static SandboxPlayground create(java.lang.String name)

Creates a new sandbox playground.

Parameters:

name - the name of the new sandbox playground

Returns:

the new sandbox playground

Throws:

java.lang.IllegalArgumentException - if the given name is null or if the name is already taken

create

public static SandboxPlayground create(java.lang.String name,
                                       SandboxConstraints constraints)

Creates a sandbox playground with a set of constraints on the sandbox.

Parameters:

name - the name of the sandbox playground

constraints - the sandbox constraints; null to remove the default constraints

Returns:

the new sandbox playground

Throws:

java.lang.IllegalArgumentException - if the given name is null or if the name is already taken

load

public static SandboxPlayground load(java.lang.String name)

Loads an existing sandbox playground.

Parameters:

name - the name of the existing sandbox playground

Returns:

the existing sandbox playground

Throws:

if - the specified name does not exist

listAvailableFeatures

public static java.util.List<java.lang.String> listAvailableFeatures()

Lists all available features discovered by the framework.

Returns:

the IDs of all available feature discovered by the framework

listAvailableRepositories

public static java.util.List<java.lang.String> listAvailableRepositories()

Lists all available repositories discovered by the framework.

Returns:

the IDs of all available repositories discovered by the framework

setDiagnosticsPrintStream

public void setDiagnosticsPrintStream(java.io.PrintStream out)

Sets the print stream for this object to print out diagnostics messages.

Parameters:

out - the print stream for printing out diagnostics messages; null if diagnostics messages need not be printed

getDiagnosticsPrintStream

public java.io.PrintStream getDiagnosticsPrintStream()

Returns the print stream this object prints out diagnostics messages to.

Returns:

the print stream this object prints out diagnostics messages to; null if diagnostics messages are not printed

enableFeature

public void enableFeature(java.lang.String featureId)

Enables a sandboxed feature.

Parameters:

featureId - the ID of the feature

Throws:

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

addRepository

public void addRepository(java.lang.String repositoryId)

Adds a sandboxed repository.

Parameters:

repositoryId - the ID of the repository

Throws:

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

refresh

public boolean refresh()

Refreshes the sandbox.

Returns:

true if the sandbox is refreshed successfully; false if there are errors from the repositories

See Also:

getRepositoryError(java.lang.String)

interactiveRefresh

public boolean interactiveRefresh(ChangeHint changeHint)

Refreshes the sandbox and sets the change hint if any of the repositories requests for it.

Parameters:

changeHint - the change hint

Returns:

true if the sandbox is refreshed successfully; false if there are errors from the repositories

See Also:

getRepositoryError(java.lang.String)

getRepositoryError

public java.lang.Throwable getRepositoryError(java.lang.String repositoryId)

Gets the error resulted from a repository.

Parameters:

repositoryId - the ID of the repository

Returns:

the error from the repository; null if there is no error from the repository or if there is no such repository

getRepositoryErrors

public java.util.Map<java.lang.String,java.lang.Throwable> getRepositoryErrors()

Returns errors from all repositories.

Returns:

errors from all repositories; an empty map if there is no error or no repository

printRepositoryErrors

public void printRepositoryErrors()

Prints the errors from repositories to the standard error stream.

getOperationLog

public java.lang.String getOperationLog()

Gets the log from the last operation.

Returns:

the log from the last operation; null if the log is empty

publish

public boolean publish()

Publishes this sandbox playground.

Returns:

true if this sandbox has been published successfully

destroy

public boolean destroy()

Destroyes this sandbox playground.

Returns:

true if this sandbox playground has been destroyed successfully

enterSandboxEnvironment

public void enterSandboxEnvironment()

Sets the metadata environment of the current ADF context to be a sandbox environment for this sandbox playground.