public class DefaultSandboxEnvironment extends SandboxEnvironment
SandboxEnvironment
.SandboxEnvironment.Parameter, SandboxEnvironment.ToolHints
MetadataEnvironment.DiagnosticRecord, MetadataEnvironment.DiagnosticRecorder, MetadataEnvironment.DiagnosticsCapable
MDS_DEFAULT_CUST_STORE_REPOSITORY
Modifier | Constructor and Description |
---|---|
protected |
DefaultSandboxEnvironment(java.lang.String id)
Constructs a sandbox environment.
|
Modifier and Type | Method and Description |
---|---|
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.
|
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. |
getCurrent, getCurrent, getMdsCurrent, getMdsDefaultCustStoreSandboxName, getRepositoryLabel, getRequestParameter, getSandboxId
protected DefaultSandboxEnvironment(java.lang.String id)
id
- the ID of the sandboxpublic java.lang.String getMetadataRevisionId()
SandboxEnvironment
getMetadataRevisionId
in class SandboxEnvironment
null
if this environment is based on mainline tippublic SandboxConstraints getSandboxConstraints()
SandboxEnvironment
getSandboxConstraints
in class SandboxEnvironment
null
if the sandbox
has no constraintspublic boolean isFeatureEnabled(java.lang.String featureId)
SandboxEnvironment
true
if the specified sandboxed feature is enabled in
this sandbox environmentisFeatureEnabled
in class SandboxEnvironment
featureId
- the ID of the sandboxed featuretrue
if the specified sandboxed feature is enabled in
this sandbox environmentpublic boolean isRepositoryBranched(java.lang.String repositoryId)
SandboxEnvironment
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
.isRepositoryBranched
in class SandboxEnvironment
repositoryId
- the ID of the repositorytrue
if the specified repository has been branched for
this sandbox environmentSandboxEnvironment.getRepositoryLabel(java.lang.String)
,
SandboxEnvironment.getRepositoryBranchId(java.lang.String)
public MetadataRepositoryBaseline getRepositoryBaseline(java.lang.String repositoryId)
MetadataEnvironment
getRepositoryBaseline
in interface MetadataEnvironment
getRepositoryBaseline
in class SandboxEnvironment
repositoryId
- the ID of the repositorynull
if such information is unavailablepublic java.lang.String getRepositoryBranchId(java.lang.String repositoryId)
SandboxEnvironment
getRepositoryBranchId
in class SandboxEnvironment
repositoryId
- the ID of the repositorynull
if the repository has not
been branchedpublic SandboxEnvironment.ToolHints getToolHints()
SandboxEnvironment
Implementation Note: The implementation should never return
null
. If this information is not available, return a default
configuration.
getToolHints
in class SandboxEnvironment
public boolean isRefreshing()
SandboxEnvironment
true
if the sandbox for this environment is being
refreshed.isRefreshing
in class SandboxEnvironment
true
if the sandbox for this environment is being
refreshedpublic boolean isPublishing()
SandboxEnvironment
true
if the sandbox for this environment is being
published.isPublishing
in class SandboxEnvironment
true
if the sandbox for this environment is being
publishedpublic boolean isRefreshRequired()
SandboxEnvironment
true
if the sandbox for this environment must be
refreshed before further use.isRefreshRequired
in class SandboxEnvironment
true
if the sandbox for this environment must be
refreshed before further use.public boolean isRequestForRefresh()
SandboxEnvironment
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".isRequestForRefresh
in class SandboxEnvironment