public abstract class SandboxEnvironment extends java.lang.Object implements MetadataEnvironment
Modifier and Type | Class and Description |
---|---|
static class |
SandboxEnvironment.Parameter
Parameters that may override the behavior of SandboxEnvironment objects.
|
class |
SandboxEnvironment.ToolHints
The hints for sandbox-enabled tools.
|
MetadataEnvironment.DiagnosticRecord, MetadataEnvironment.DiagnosticRecorder, MetadataEnvironment.DiagnosticsCapable
MDS_DEFAULT_CUST_STORE_REPOSITORY
Modifier | Constructor and Description |
---|---|
protected |
SandboxEnvironment(java.lang.String sandboxId)
Constructs a sandbox environment.
|
Modifier and Type | Method and Description |
---|---|
static SandboxEnvironment |
getCurrent()
Gets the sandbox environment from the current ADF context.
|
static SandboxEnvironment |
getCurrent(java.lang.String repositoryId)
Returns the metadata environment from the current ADF context if the
metadata environment is a sandbox environment and the specified repository
is branched for the environment.
|
static SandboxEnvironment |
getMdsCurrent()
Returns the metadata environment from the current ADF context if the
metadata environment is a sandbox environment and the MDS default
customization store repository is branched for the sandbox.
|
java.lang.String |
getMdsDefaultCustStoreSandboxName()
Gets the name of the MDS sandbox for default customization store.
|
java.lang.String |
getMetadataRevisionId()
Returns the ID of the metadata revision this environment is based on.
|
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.
|
java.lang.String |
getRepositoryLabel(java.lang.String repositoryId)
Gets the certified label of a repository that the metadata should be read
from if the specified repository has not been branched, or the certified
label the repository branch is based on if the specified repository has
been branched.
|
static java.lang.String |
getRequestParameter(SandboxEnvironment.Parameter p)
Gets the value of a prameter from the current request.
|
SandboxConstraints |
getSandboxConstraints()
Returns the constraints of the sandbox.
|
java.lang.String |
getSandboxId()
Gets the ID of the unified 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. |
protected SandboxEnvironment(java.lang.String sandboxId)
sandboxId
- the ID of the sandboxjava.lang.IllegalArgumentException
- if the given sandbox ID is nullpublic static java.lang.String getRequestParameter(SandboxEnvironment.Parameter p)
p
- the parameternull
if the
parameter is not specified in the current request or if the
value is null or blankjava.lang.NullPointerException
- if the given parameter is nullpublic static SandboxEnvironment getCurrent()
null
if the metadata environment is not a sandbox
environmentpublic static SandboxEnvironment getMdsCurrent()
public static SandboxEnvironment getCurrent(java.lang.String repositoryId)
repositoryId
- the ID of the repositorynull
otherwisepublic java.lang.String getMetadataRevisionId()
null
if this environment is based on mainline tippublic final java.lang.String getSandboxId()
public SandboxConstraints getSandboxConstraints()
null
if the sandbox
has no constraintspublic boolean isFeatureEnabled(java.lang.String featureId)
true
if the specified sandboxed feature is enabled in
this sandbox environmentfeatureId
- the ID of the sandboxed featuretrue
if the specified sandboxed feature is enabled in
this sandbox environmentjava.lang.IllegalArgumentException
- if the given ID is nullpublic boolean isRepositoryBranched(java.lang.String repositoryId)
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
.repositoryId
- the ID of the repositorytrue
if the specified repository has been branched for
this sandbox environmentgetRepositoryLabel(java.lang.String)
,
getRepositoryBranchId(java.lang.String)
public java.lang.String getRepositoryLabel(java.lang.String repositoryId)
repositoryId
- the ID of the repositorypublic MetadataRepositoryBaseline getRepositoryBaseline(java.lang.String repositoryId)
MetadataEnvironment
getRepositoryBaseline
in interface MetadataEnvironment
repositoryId
- the ID of the repositorynull
if such information is unavailablepublic java.lang.String getRepositoryBranchId(java.lang.String repositoryId)
repositoryId
- the ID of the repositorynull
if the repository has not
been branchedpublic final java.lang.String getMdsDefaultCustStoreSandboxName()
null
if repository
MDS_DEFAULT_CUST_STORE_REPOSITORY
has not been
branched yet.public SandboxEnvironment.ToolHints getToolHints()
Implementation Note: The implementation should never return
null
. If this information is not available, return a default
configuration.
public boolean isRefreshing()
true
if the sandbox for this environment is being
refreshed.true
if the sandbox for this environment is being
refreshedpublic boolean isPublishing()
true
if the sandbox for this environment is being
published.true
if the sandbox for this environment is being
publishedpublic boolean isRefreshRequired()
true
if the sandbox for this environment must be
refreshed before further use.true
if the sandbox for this environment must be
refreshed before further use.public boolean isRequestForRefresh()
true
if the request indicated by the context object
is a request to perform sandbox refresh. The default implementation
checks if ADFContext.getCurrent().getEnvironment()
contains
a request parameter that matches the code of
Parameter.IS_REQUEST_FOR_REFRESH
, then returns
true
if the value is "t".java.lang.NullPointerException
- if the given context is null