oracle.adfinternal.share.sandbox

Class DefaultSandboxEnvironment

java.lang.Object

oracle.adf.share.sandbox.SandboxEnvironment

oracle.adfinternal.share.sandbox.DefaultSandboxEnvironment

All Implemented Interfaces:

MetadataEnvironment

public class DefaultSandboxEnvironment
extends SandboxEnvironment

Default implementation of SandboxEnvironment.

Nested Class Summary

Nested classes/interfaces inherited from class oracle.adf.share.sandbox.SandboxEnvironment

SandboxEnvironment.ToolHints

Nested classes/interfaces inherited from interface oracle.adf.share.MetadataEnvironment

MetadataEnvironment.DiagnosticRecord, MetadataEnvironment.DiagnosticRecorder, MetadataEnvironment.DiagnosticsCapable

Field Summary

Fields inherited from interface oracle.adf.share.MetadataEnvironment

MDS_DEFAULT_CUST_STORE_REPOSITORY

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DefaultSandboxEnvironment(java.lang.String id) Constructs a sandbox environment.

Method Summary

Modifier and Type	Method and Description
MetadataRepositoryBaseline	getRepositoryBaseline(java.lang.String repositoryId) Returns the baseline of a repository in the current context.
java.lang.String	getRepositoryBranchId(java.lang.String repositoryId) Gets the ID of the repository branch.
SandboxConstraints	getSandboxConstraints() Returns the constraints of the sandbox.
SandboxEnvironment.ToolHints	getToolHints() Returns the hints for sandbox-enabled tools.
boolean	isFeatureEnabled(java.lang.String featureId) Returns true if the specified sandboxed feature is enabled in this sandbox environment
boolean	isPublishing() Returns true if the sandbox for this environment is being published.
boolean	isRefreshing() Returns true if the sandbox for this environment is being refreshed.
boolean	isRefreshRequired() Returns true if the sandbox for this environment must be refreshed before further use.
boolean	isRepositoryBranched(java.lang.String repositoryId) Returns true if the specified repository has been branched for this sandbox environment.
boolean	isRequestForRefresh() Returns true if the request indicated by the context object is a request to perform sandbox refresh.

Methods inherited from class oracle.adf.share.sandbox.SandboxEnvironment

getCurrent, getCurrent, getMdsCurrent, getMdsDefaultCustStoreSandboxName, getRepositoryLabel, getSandboxId

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultSandboxEnvironment

protected DefaultSandboxEnvironment(java.lang.String id)

Constructs a sandbox environment.

Parameters:

id - the ID of the sandbox

Method Detail

getSandboxConstraints

public SandboxConstraints getSandboxConstraints()

Description copied from class: SandboxEnvironment

Returns the constraints of the sandbox.

Overrides:

getSandboxConstraints in class SandboxEnvironment

Returns:

the constraints of the sandbox; null if the sandbox has no constraints

isFeatureEnabled

public boolean isFeatureEnabled(java.lang.String featureId)

Description copied from class: SandboxEnvironment

Returns true if the specified sandboxed feature is enabled in this sandbox environment

Overrides:

isFeatureEnabled in class SandboxEnvironment

Parameters:

featureId - the ID of the sandboxed feature

Returns:

true if the specified sandboxed feature is enabled in this sandbox environment

isRepositoryBranched

public boolean isRepositoryBranched(java.lang.String repositoryId)

Description copied from class: SandboxEnvironment

Returns true if the specified repository has been branched for this sandbox environment. If the specified repository has been branched, getRepositoryBranchId will return the ID of the branch where the repository-specific metadata should be read from and written to. If the specified repository has not been branched, the repository-specific metadata should be read from a certified label which is returned by getRepositoryLabel.

Overrides:

isRepositoryBranched in class SandboxEnvironment

Parameters:

repositoryId - the ID of the repository

Returns:

true if the specified repository has been branched for this sandbox environment

See Also:

SandboxEnvironment.getRepositoryLabel(java.lang.String), SandboxEnvironment.getRepositoryBranchId(java.lang.String)

getRepositoryBaseline

public MetadataRepositoryBaseline getRepositoryBaseline(java.lang.String repositoryId)

Description copied from interface: MetadataEnvironment

Returns the baseline of a repository in the current context.

Specified by:

getRepositoryBaseline in interface MetadataEnvironment

Overrides:

getRepositoryBaseline in class SandboxEnvironment

Parameters:

repositoryId - the ID of the repository

Returns:

the baseline of the repository in the current context; null if such information is unavailable

getRepositoryBranchId

public java.lang.String getRepositoryBranchId(java.lang.String repositoryId)

Description copied from class: SandboxEnvironment

Gets the ID of the repository branch.

Overrides:

getRepositoryBranchId in class SandboxEnvironment

Parameters:

repositoryId - the ID of the repository

Returns:

the ID of the repository branch if the specified repository has been branched, or null if the repository has not been branched

getToolHints

public SandboxEnvironment.ToolHints getToolHints()

Description copied from class: SandboxEnvironment

Returns the hints for sandbox-enabled tools.

Implementation Note: The implementation should never return null. If this information is not available, return a default configuration.

Overrides:

getToolHints in class SandboxEnvironment

Returns:

the hints for sandbox-enabled tools, never null

isRefreshing

public boolean isRefreshing()

Description copied from class: SandboxEnvironment

Returns true if the sandbox for this environment is being refreshed.

Overrides:

isRefreshing in class SandboxEnvironment

Returns:

true if the sandbox for this environment is being refreshed

isPublishing

public boolean isPublishing()

Description copied from class: SandboxEnvironment

Returns true if the sandbox for this environment is being published.

Overrides:

isPublishing in class SandboxEnvironment

Returns:

true if the sandbox for this environment is being published

isRefreshRequired

public boolean isRefreshRequired()

Description copied from class: SandboxEnvironment

Returns true if the sandbox for this environment must be refreshed before further use.

Overrides:

isRefreshRequired in class SandboxEnvironment

Returns:

true if the sandbox for this environment must be refreshed before further use.

isRequestForRefresh

public boolean isRequestForRefresh()

Description copied from class: SandboxEnvironment

Returns true if the request indicated by the context object is a request to perform sandbox refresh.

Overrides:

isRequestForRefresh in class SandboxEnvironment

Returns:

true if the request indicated by the context object is a request to perform sandbox refresh