oracle.adfinternal.share.sandbox

Class DefaultSandboxSupport

java.lang.Object

oracle.adf.share.sandbox.SandboxSupport

oracle.adfinternal.share.sandbox.DefaultSandboxSupport

public class DefaultSandboxSupport
extends SandboxSupport

Default implementation of oracle.adf.share.sandbox.SandboxSupport.

Constructor Summary

Constructors

Constructor and Description
DefaultSandboxSupport() Constructs an instance of DefaultSandboxSupport.

Method Summary

Modifier and Type	Method and Description
boolean	addAdministrator(Sandbox sandbox, java.lang.String userName) Adds a user to the list of administrators of a sandbox.
void	addRepository(Sandbox sandbox, SandboxedRepository repos) Adds a repository in its latest certified state to a sandbox.
boolean	canSynchronizedPublish(Sandbox sandbox) Returns true if all locks needed for synchronizedPublish are available at the time of the invocation.
MetadataRevision	certifyRepositoryMainline(java.util.Set<java.lang.String> reposIdSet, java.lang.String transactionNote) Certifies the state of the mainlines of the specified repositories at the time of invocation.
void	checkNewSandboxName(java.lang.String name) Checks if a String can be used to name a new sandbox.
boolean	completeSandboxPendingUpdates(Sandbox sandbox) Completes all pending updates.
void	completeSandboxPendingUpdates(java.lang.String sandboxId, SandboxBackgroundTask.Proxy<java.lang.Boolean> proxy) Completes all pending updates in a background thread.
boolean	containsRepositoryErrorLogs(Sandbox sandbox) Returns true if an error occurred to any repository during the last sandbox operation.
void	destroy(Sandbox sandbox) Destroys a sandbox and deletes all information pertaining to the sandbox.
void	destroy(Sandbox sandbox, boolean retainInfo) Destroys a sandbox and optionally retains the sandbox information such as operation logs.
void	destroy(java.lang.String sandboxId, boolean retainInfo, SandboxBackgroundTask.Proxy<java.lang.Object> proxy) Destroys a sandbox in a background thread.
boolean	enableFeature(Sandbox sandbox, java.lang.String featureClassName) Enables a feature in the sandbox.
java.util.Map<java.lang.String,java.lang.Throwable>	enableFeatures(Sandbox sandbox, java.util.List<java.lang.String> featureIdList) Enables a list of features.
void	enableFeatures(java.lang.String sandboxId, java.util.List<java.lang.String> featureIdList, SandboxBackgroundTask.Proxy<java.util.Map<java.lang.String,java.lang.Throwable>> proxy) Enables a list of features in a background thread.
Sandbox	findSandbox(java.lang.String nameOrId) Finds a sandbox by its name or ID.
java.util.List<java.lang.String>	getEnabledFeatureIdList(Sandbox sandbox) Gets the IDs of the features enabled in a sandbox.
java.util.List<SandboxedFeature>	getEnabledFeatures(Sandbox sandbox) Returns the list of features enabled in a sandbox.
int	getNumberOfOpenSandboxes(boolean includeArchives) Returns the number of sandboxes that are currently open.
java.util.List<SandboxedRepository>	getRepositories(Sandbox sandbox) Returns the list of repositories that have been branched for a sandbox.
java.util.Map<java.lang.String,ChangeHint>	getRepositoryChangeHints(Sandbox sandbox) Returns the hints taken by the current operation.
RepositoryErrorLog	getRepositoryErrorLog(Sandbox sandbox, java.lang.String reposId) Returns the error log from the last repository operation if any.
java.util.List<java.lang.String>	getRepositoryIdList(Sandbox sandbox) Returns the IDs of the repositories that have been branched for a sandbox.
ChangeSet	getRepositoryLastChanges(Sandbox sandbox, java.lang.String reposId) Returns the changes obtained last time from a repository branch.
Sandbox	getSandbox(java.lang.String id) Returns the information of an existing sandbox.
SandboxArchive	getSandboxArchive(Sandbox sandbox) Returns the SandboxArchive object if the given sandbox is from an archive.
SandboxInfoCache	getSandboxInfoCache(java.lang.String id) Returns the information of an existing sandbox and caches some of the information upon the first access.
java.util.Map<java.lang.String,SandboxUpdateErrorInfo>	getSandboxLastUpdateErrors(Sandbox sandbox) Gets the errors from the last failed update.
java.lang.String	getSandboxNameOrId(java.lang.String sandboxId) Returns the name or a URI representation of the ID of a sandbox if the sandbox exists.
SandboxLog	getSandboxOperationLog(Sandbox sandbox) Returns the log from the current or last sandbox operation.
java.lang.Long	getSandboxOperationLogId(java.lang.String sandboxId, SandboxState.Condition condition) Returns the ID of an open log for a sandbox.
int	getSandboxOperationProgress(Sandbox sandbox) Returns an integer from 0 (inclusive) to 100 (inclusive) to indicate the progress of the current sandbox operation.
int	getSandboxOperationProgress(Sandbox sandbox, java.lang.String featureId) Returns an integer from 0 (inclusive) to 100 (inclusive) to indicate the progress of the current sandbox operation by feature.
java.util.List<SandboxUpdate>	getSandboxPendingUpdates(Sandbox sandbox) Gets the list of pending updates if any.
java.util.Date	getSandboxPendingUpdatesDueDate(Sandbox sandbox) Returns the nearest due date of the pending updates.
boolean	isLockedBySandboxArchive() Returns true if the mainline of any repository is locked by a sandbox archive at the time of invcation.
boolean	isSandboxOperationProcessRunning(Sandbox sandbox) Returns true if a process that performs an operation of the sandbox is running at the time of the invocation.
boolean	isSandboxPendingUpdates(Sandbox sandbox) Returns true if there is any pending update for this sandbox.
java.util.List<java.lang.String>	listAdministrators(Sandbox sandbox) Returns the list of administrators of a sandbox.
java.util.List<java.lang.String>	listOpenSandboxes(boolean includeArchives) Returns the IDs of the sandboxes that are open at the time of invocation.
java.util.List<java.lang.String>	listSandboxes(java.lang.String name, boolean exactMatch) Returns the IDs of the sandboxes whose names contain or match the specified name.
java.util.List<SandboxLogRef>	listSandboxLogs(Sandbox sandbox, java.lang.Class<? extends SandboxLog> type) Returns a list of sandbox logs from the latest to the oldest.
protected void	logEvent(Sandbox sandbox, RepositoryEvent e) Logs a repository event.
void	markSandboxesForUpdate(SandboxUpdatePatchInfo patchInfo) Marks all open sandboxes for update.
void	markSandboxForUpdate(SandboxUpdatePatchInfo patchInfo, Sandbox sandbox) Marks a sandbox for update.
java.util.Set<java.lang.String>	newRepositoryBaselines(java.lang.String note) Requests that all available repositories in the system establish new baselines for the current state of the repositories.
Sandbox	newSandbox(SandboxArchive archive) Creates a new sandbox from an archive as its initial contents.
Sandbox	newSandbox(java.lang.String name) Creates a new sandbox.
void	newSandbox(java.lang.String name, SandboxBackgroundTask.Proxy<Sandbox> proxy) Creates a new sandbox in a background thread.
protected SandboxInfoCache	newSandboxInfoCache(java.lang.String sandboxId) Constructs a new SandboxInfoCache instance.
protected Sandbox	newSandboxInstance(java.lang.String sandboxId) Constructs a new Sandbox instance.
RepositoryExceptions	prepareForRefresh(Sandbox sandbox) Explicitly invokes SandboxedRepository.prepareForRefresh to start the refresh process.
java.util.Map<SandboxedRepository,ChangeSet>	publish(Sandbox sandbox) Merges changes in a sandbox back into the repositories.
void	publish(java.lang.String sandboxId, SandboxBackgroundTask.Proxy<java.util.Map<SandboxedRepository,ChangeSet>> proxy) Publishes a sandbox in a background thread.
java.util.Map<SandboxedRepository,ChangeSet>	refresh(Sandbox sandbox) Merges changes made in participating repositories into a sandbox.
java.util.Map<SandboxedRepository,ChangeSet>	refresh(Sandbox sandbox, ChangeHint.Provider hintProvider) Merges changes made in participating repositories into a sandbox.
void	refresh(java.lang.String sandboxId, ChangeHint.Provider hintProvider, SandboxBackgroundTask.Proxy<java.util.Map<SandboxedRepository,ChangeSet>> proxy) Refreshes a sandbox in a background thread.
void	refresh(java.lang.String sandboxId, SandboxBackgroundTask.Proxy<java.util.Map<SandboxedRepository,ChangeSet>> proxy) Refreshes a sandbox in a background thread.
boolean	removeAdministrator(Sandbox sandbox, java.lang.String userName) Removes a user from the list of administrators of a sandbox.
void	setDescription(Sandbox sandbox, java.lang.String desc) Updates the description of a sandbox.
void	setName(Sandbox sandbox, java.lang.String name) Updates the name of a sandbox.
void	setPrivate(Sandbox sandbox, boolean p) Marks a sandbox private or not.
void	setPublishable(Sandbox sandbox, boolean p) Marks a sandbox publishable or not.
void	setSandboxConstraints(Sandbox sandbox, SandboxConstraints constraints) Sets constraints for a sandbox.
void	setSandboxConstraintsSummary(Sandbox sandbox, java.lang.String constraintsSummary) Sets the summary of constraints for a sandbox.
void	setSandboxOperationChangeHint(Sandbox sandbox, ChangeHint changeHint) Gives a change hint to all repositories involved in the current operation.
java.util.Map<SandboxedRepository,ChangeSet>	synchronizedPublish(Sandbox sandbox, boolean refreshBefore) Publishes a sandbox only when all mainline exclusive locks of the branched repositories are available; in other words, a ConcurrentSandboxOperationException is thrown when another synchronizedPublish call is in progress, or when a mainline exclusive lock of any branched repository has been acquired by an archive.
void	synchronizedPublish(java.lang.String sandboxId, SandboxBackgroundTask.Proxy<java.util.Map<SandboxedRepository,ChangeSet>> proxy) Publishes a sandbox in a background thread when all mainline exclusive locks of the branched repositories are available This method does not wait for the operation to complete.
void	timeoutSandboxOperationProcesses() Marks sandboxes that are being processed for a duration that is longer than the default time allowed.
boolean	tryLock(SandboxArchive archive) Tries to acquire the lock for processing a sandbox archive.
void	unlock(SandboxArchive archive) Releases the lock acquired for processing a sandbox archive.
void	unpublish(Sandbox sandbox) Unpublishes a sandbox if it's eligible.
IneligibleForUnpublishException	unpublishCheck(Sandbox sandbox) Checks if a sandbox is eligible for unpublish at this moment.

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

certifyRepositoryMainline, getInstance, getNumberOfOpenSandboxes, getRepositoryErrorLogs, hasUncommittedChanges, isCompatible, isVisualBuilder, isVisualBuilder, isVisualBuilderEnabled, listOpenSandboxes, listSandbox

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultSandboxSupport

public DefaultSandboxSupport()

Constructs an instance of DefaultSandboxSupport.

Method Detail

checkNewSandboxName

public void checkNewSandboxName(java.lang.String name)

Description copied from class: SandboxSupport

Checks if a String can be used to name a new sandbox.

Overrides:

checkNewSandboxName in class SandboxSupport

Parameters:

name - the name to be checked

See Also:

SandboxSupport.newSandbox(String)

newSandbox

public Sandbox newSandbox(java.lang.String name)
                   throws SandboxException

Description copied from class: SandboxSupport

Creates a new sandbox.

Specified by:

newSandbox in class SandboxSupport

Parameters:

name - the name of the sandbox

Returns:

the new sandbox

Throws:

SandboxException - if an error occurs while creating a sandbox

newSandbox

public void newSandbox(java.lang.String name,
                       SandboxBackgroundTask.Proxy<Sandbox> proxy)

Description copied from class: SandboxSupport

Creates a new sandbox in a background thread. This method does not wait for the operation to complete.

Overrides:

newSandbox in class SandboxSupport

Parameters:

name - the name of the sandbox

proxy - the proxy object that handles the background task

newSandboxInstance

protected Sandbox newSandboxInstance(java.lang.String sandboxId)

Constructs a new Sandbox instance.

Parameters:

sandboxId - the ID of the sandbox

Returns:

the new sandbox instance

newSandboxInfoCache

protected SandboxInfoCache newSandboxInfoCache(java.lang.String sandboxId)

Constructs a new SandboxInfoCache instance.

Parameters:

sandboxId - the ID of the sandbox

Returns:

the new instance

getSandboxArchive

public SandboxArchive getSandboxArchive(Sandbox sandbox)

Description copied from class: SandboxSupport

Returns the SandboxArchive object if the given sandbox is from an archive.

Specified by:

getSandboxArchive in class SandboxSupport

Parameters:

sandbox - the sandbox the SandboxArchive object is associated with

Returns:

the SandboxArchive object if the given sandbox is from an archive; null otherwise

newSandbox

public Sandbox newSandbox(SandboxArchive archive)
                   throws SandboxException

Description copied from class: SandboxSupport

Creates a new sandbox from an archive as its initial contents. The name of the sandbox will be the name of the archive.

Specified by:

newSandbox in class SandboxSupport

Parameters:

archive - the archive that contains the initial contents

Returns:

the new sandbox

Throws:

SandboxException - if an error occurs while creating a sandbox

setName

public void setName(Sandbox sandbox,
                    java.lang.String name)

Description copied from class: SandboxSupport

Updates the name of a sandbox.

Specified by:

setName in class SandboxSupport

Parameters:

sandbox - the sandbox to update

name - the new name

setDescription

public void setDescription(Sandbox sandbox,
                           java.lang.String desc)

Description copied from class: SandboxSupport

Updates the description of a sandbox.

Specified by:

setDescription in class SandboxSupport

Parameters:

sandbox - the sandbox

desc - the description

setPrivate

public void setPrivate(Sandbox sandbox,
                       boolean p)

Description copied from class: SandboxSupport

Marks a sandbox private or not. A private sandbox is a sandbox that can only be accessed by its owner.

Specified by:

setPrivate in class SandboxSupport

Parameters:

sandbox - the sandbox to be set private or shared

p - true if the given sandbox is to be set to private

setPublishable

public void setPublishable(Sandbox sandbox,
                           boolean p)

Description copied from class: SandboxSupport

Marks a sandbox publishable or not. A publishable sandbox is a sandbox that can be published.

Specified by:

setPublishable in class SandboxSupport

Parameters:

sandbox - the sandbox to be set publishable or not

p - true if the given sandbox is to be set to publishable

listSandboxes

public java.util.List<java.lang.String> listSandboxes(java.lang.String name,
                                                      boolean exactMatch)

Description copied from class: SandboxSupport

Returns the IDs of the sandboxes whose names contain or match the specified name. The list is sorted by the creation dates of the sandboxes from the newest to the oldest.

Specified by:

listSandboxes in class SandboxSupport

Parameters:

name - the name of the sandbox

exactMatch - true if the names of the returned sandboxes must match the specified name exactly

Returns:

the IDs of the sandboxes whose names match or contain the specified name in descending order of their creation dates

getSandbox

public Sandbox getSandbox(java.lang.String id)

Description copied from class: SandboxSupport

Returns the information of an existing sandbox.

Specified by:

getSandbox in class SandboxSupport

Parameters:

id - the ID of the sandbox

Returns:

the sandbox information; null if there is no such sandbox

findSandbox

public Sandbox findSandbox(java.lang.String nameOrId)

Description copied from class: SandboxSupport

Finds a sandbox by its name or ID. The search starts by matching the argument to the name of a sandbox; if no match, the search continues by treating the argument as the ID of the sandbox to be found. If multiple sandboxes have the same name that matches the argument, the most recently created sandbox is returned.

Overrides:

findSandbox in class SandboxSupport

Parameters:

nameOrId - the name or ID

Returns:

the sandbox whose name or ID matches the argument; null if no match

See Also:

SandboxSupport.getSandboxNameOrId(java.lang.String)

getSandboxNameOrId

public java.lang.String getSandboxNameOrId(java.lang.String sandboxId)

Description copied from class: SandboxSupport

Returns the name or a URI representation of the ID of a sandbox if the sandbox exists. This is a convenience method that checks the existence of a sandbox and return its name when the sandbox exists. When the sandbox exists, the returned value is never null. If the sandbox exists but the name of the sandbox is null, the URI representation of the sandbox ID as specified by MetadataRevisionNoteURI.SandboxId is returned.

Overrides:

getSandboxNameOrId in class SandboxSupport

Parameters:

sandboxId - the ID of the sandbox to be checked

Returns:

a non-null String if a sandbox exists for the given ID; null if no sandbox can be found for the given ID

See Also:

SandboxSupport.findSandbox(java.lang.String)

getSandboxInfoCache

public SandboxInfoCache getSandboxInfoCache(java.lang.String id)

Description copied from class: SandboxSupport

Returns the information of an existing sandbox and caches some of the information upon the first access.

Overrides:

getSandboxInfoCache in class SandboxSupport

Parameters:

id - the ID of the sandbox

Returns:

the sandbox information which is partially cached upon the first access

addRepository

public void addRepository(Sandbox sandbox,
                          SandboxedRepository repos)
                   throws SandboxException

Description copied from class: SandboxSupport

Adds a repository in its latest certified state to a sandbox.

Specified by:

addRepository in class SandboxSupport

Parameters:

sandbox - the sandbox

repos - the participating repository

Throws:

SandboxException - if an error occurs while adding the repository

getRepositories

public java.util.List<SandboxedRepository> getRepositories(Sandbox sandbox)

Description copied from class: SandboxSupport

Returns the list of repositories that have been branched for a sandbox.

Specified by:

getRepositories in class SandboxSupport

Parameters:

sandbox - the sandbox

Returns:

the list of all branched repositories in the sandbox

getRepositoryIdList

public java.util.List<java.lang.String> getRepositoryIdList(Sandbox sandbox)

Description copied from class: SandboxSupport

Returns the IDs of the repositories that have been branched for a sandbox.

Overrides:

getRepositoryIdList in class SandboxSupport

Parameters:

sandbox - the sandbox where the repositories are branched for

Returns:

the IDs of the repositories that have been branched for the sandbox; an empty list if no repository is branched for the sandbox

getEnabledFeatures

public java.util.List<SandboxedFeature> getEnabledFeatures(Sandbox sandbox)

Description copied from class: SandboxSupport

Returns the list of features enabled in a sandbox.

Specified by:

getEnabledFeatures in class SandboxSupport

Parameters:

sandbox - the sandbox

Returns:

the list of all featured enabled in the sandbox

getEnabledFeatureIdList

public java.util.List<java.lang.String> getEnabledFeatureIdList(Sandbox sandbox)

Description copied from class: SandboxSupport

Gets the IDs of the features enabled in a sandbox.

Overrides:

getEnabledFeatureIdList in class SandboxSupport

Parameters:

sandbox - the sandbox where the features are enabled

Returns:

the IDs of the features enabled in the sandbox; an empty list if no feature is enabled

logEvent

protected void logEvent(Sandbox sandbox,
                        RepositoryEvent e)

Description copied from class: SandboxSupport

Logs a repository event.

Overrides:

logEvent in class SandboxSupport

Parameters:

sandbox - the sandbox

e - the repository event

getSandboxOperationProgress

public int getSandboxOperationProgress(Sandbox sandbox)

Description copied from class: SandboxSupport

Returns an integer from 0 (inclusive) to 100 (inclusive) to indicate the progress of the current sandbox operation.

Overrides:

getSandboxOperationProgress in class SandboxSupport

Parameters:

sandbox - the sandbox on which the operation is in progress

Returns:

an integer from 0 (inclusive) to 100 (inclusive) where 100 means completion of the operation; -1 if there is no operation in progress or if progress reporting is not supported

getSandboxOperationProgress

public int getSandboxOperationProgress(Sandbox sandbox,
                                       java.lang.String featureId)

Description copied from class: SandboxSupport

Returns an integer from 0 (inclusive) to 100 (inclusive) to indicate the progress of the current sandbox operation by feature. To improve performance, this method may not check if the specified feature is enabled in the sandbox or not. The returned value is undefined if the specified feature is not enabled in the specified sandbox.

Overrides:

getSandboxOperationProgress in class SandboxSupport

Parameters:

sandbox - the sandbox on which the operation is in progress

featureId - the ID of the enabled feature

Returns:

an integer from 0 (inclusive) to 100 (inclusive) where 100 means completion of the operation; -1 if there is no operation in progress, the specified feature is not enabled, or if progress reporting is not supported

listSandboxLogs

public java.util.List<SandboxLogRef> listSandboxLogs(Sandbox sandbox,
                                                     java.lang.Class<? extends SandboxLog> type)

Description copied from class: SandboxSupport

Returns a list of sandbox logs from the latest to the oldest.

Overrides:

listSandboxLogs in class SandboxSupport

Parameters:

sandbox - the sandbox associated with the logs

type - the type of the logs; null if all types should be returned

Returns:

a list of logs associated with the given sandbox from the latest to the oldest; an empty list if no log of the given type is associated with the given sandbox

getSandboxOperationLogId

public java.lang.Long getSandboxOperationLogId(java.lang.String sandboxId,
                                               SandboxState.Condition condition)

Description copied from class: SandboxSupport

Returns the ID of an open log for a sandbox. In certain conditions such as sandbox refreshing, a log is created for processes involved to record the changes.

Specified by:

getSandboxOperationLogId in class SandboxSupport

Parameters:

sandboxId - the ID of the sandbox for which the log is created

condition - the condition when the log is available

Returns:

the ID of the open log for the specified sandbox in the specified condition; null if no log is available for the given sandbox in the given condition

getSandboxOperationLog

public SandboxLog getSandboxOperationLog(Sandbox sandbox)

Description copied from class: SandboxSupport

Returns the log from the current or last sandbox operation. If the operation is still in progress, the returned log reflects what has been logged so far. A log in progress will not be in the list returned by listSandboxLogs. If an operation is successful and a log is produced, this method continues to return the log from the successful operation until the next operation begins. During this time, the returned log is the same as the first log returned by listSandboxLogs.

Specified by:

getSandboxOperationLog in class SandboxSupport

Parameters:

sandbox - the sandbox where the operation was performed

Returns:

the log from the current or last sandbox operation; null if not available

See Also:

SandboxSupport.listSandboxLogs(oracle.adf.share.sandbox.Sandbox, java.lang.Class<? extends oracle.adf.share.sandbox.logging.SandboxLog>)

getRepositoryLastChanges

public ChangeSet getRepositoryLastChanges(Sandbox sandbox,
                                          java.lang.String reposId)

Description copied from class: SandboxSupport

Returns the changes obtained last time from a repository branch.

Overrides:

getRepositoryLastChanges in class SandboxSupport

Parameters:

sandbox - the sandbox that contains the repository branch

Returns:

the changes obtained last time from a repository branch; null if such information is unavailable

containsRepositoryErrorLogs

public boolean containsRepositoryErrorLogs(Sandbox sandbox)

Description copied from class: SandboxSupport

Returns true if an error occurred to any repository during the last sandbox operation.

Overrides:

containsRepositoryErrorLogs in class SandboxSupport

Parameters:

sandbox - the sandbox where the repositories are branched

Returns:

true if an error occurred to any branched repository during the last sandbox operation

getRepositoryErrorLog

public RepositoryErrorLog getRepositoryErrorLog(Sandbox sandbox,
                                                java.lang.String reposId)

Description copied from class: SandboxSupport

Returns the error log from the last repository operation if any.

Overrides:

getRepositoryErrorLog in class SandboxSupport

Parameters:

sandbox - the sandbox where the repository is branched

reposId - the ID of the repository

Returns:

the error log from the last repository operation; null if there is no error, or the error log is not available

isSandboxOperationProcessRunning

public boolean isSandboxOperationProcessRunning(Sandbox sandbox)

Description copied from class: SandboxSupport

Returns true if a process that performs an operation of the sandbox is running at the time of the invocation. If the returned value is true, a ConcurrentSandboxOperationException may be thrown when initiating another sandbox operation. Note that the returned value false does not necessarily mean no operation is going on. Some operation such as "refresh" requires a series of processes to complete. There may be no process running but the operation as a whole is still in progress.

Overrides:

isSandboxOperationProcessRunning in class SandboxSupport

Parameters:

sandbox - the sandbox that may be being processed

Returns:

true if a process that performs an operation of the sandbox is running at the time of invocation

prepareForRefresh

public RepositoryExceptions prepareForRefresh(Sandbox sandbox)

Description copied from class: SandboxSupport

Explicitly invokes SandboxedRepository.prepareForRefresh to start the refresh process. The purpose of this method is to allow an administrator to put a sandbox in "refresh state" without starting the actual refresh process immediately. It is expected that a call to refresh will follow shortly if not immediately.

It is possible to call refresh without calling this method first; in that case, SandboxedRepository.prepareForRefresh will be invoked implicitly if it has not been called. From a repository's point of view, SandboxedRepository.prepareForRefresh is always executed before SandboxedRepository.refresh in all cases.

If SandboxedRepository.prepareForRefresh fails, the errors are returned; when that happens, invoking any refresh methods of this class will result in the same exception. Note that a call to a refresh method of this class is still required even though it's expected that refresh will fail. Only a refresh method can move the sandbox out of the refresh state.

Overrides:

prepareForRefresh in class SandboxSupport

Parameters:

sandbox - the sandbox that is about to be refreshed

Returns:

exceptions from repositories that fail the operation, or null if all repositories have succeeded

refresh

public java.util.Map<SandboxedRepository,ChangeSet> refresh(Sandbox sandbox)
                                                     throws SuspendedSandboxOperationException,
                                                            RepositoryExceptions

Description copied from class: SandboxSupport

Merges changes made in participating repositories into a sandbox. If there is any merge conflict, all merged changes are undone. If the changes to the sandbox cannot be undone, the sandbox will be set to state SandboxState.INACTIVE.

Specified by:

refresh in class SandboxSupport

Parameters:

sandbox - the sandbox

Returns:

the changes that have been merged; an empty map if the sandbox does contain any repositories

Throws:

SuspendedSandboxOperationException - if the refresh process is suspended because more information is needed

RepositoryExceptions - if merge conflicts are detected or any error occurs during the process

refresh

public java.util.Map<SandboxedRepository,ChangeSet> refresh(Sandbox sandbox,
                                                            ChangeHint.Provider hintProvider)
                                                     throws SuspendedSandboxOperationException,
                                                            RepositoryExceptions

Description copied from class: SandboxSupport

Merges changes made in participating repositories into a sandbox. If there is any merge conflict, all merged changes are undone. If the changes to the sandbox cannot be undone, the sandbox will be set to state SandboxState.INACTIVE.

Overrides:

refresh in class SandboxSupport

Parameters:

sandbox - the sandbox

hintProvider - the hint provider; null if the hint should come from the deprecated setSandboxOperationChangeHint. To provide null as hint, pass in new ChangeHint.Provider(), not null.

Returns:

the changes that have been merged; an empty map if the sandbox does contain any repositories

Throws:

SuspendedSandboxOperationException - if the refresh process is suspended because more information is needed

RepositoryExceptions - if merge conflicts are detected or any error occurs during the process

refresh

public void refresh(java.lang.String sandboxId,
                    SandboxBackgroundTask.Proxy<java.util.Map<SandboxedRepository,ChangeSet>> proxy)

Description copied from class: SandboxSupport

Refreshes a sandbox in a background thread. This method does not wait for the operation to complete.

Overrides:

refresh in class SandboxSupport

Parameters:

sandboxId - the ID of the sandbox to be refreshed

proxy - the proxy object that handles the background task

refresh

public void refresh(java.lang.String sandboxId,
                    ChangeHint.Provider hintProvider,
                    SandboxBackgroundTask.Proxy<java.util.Map<SandboxedRepository,ChangeSet>> proxy)

Description copied from class: SandboxSupport

Refreshes a sandbox in a background thread. This method does not wait for the operation to complete.

Overrides:

refresh in class SandboxSupport

Parameters:

sandboxId - the ID of the sandbox to be refreshed

hintProvider - the hint provider; null if the hint should come from the deprecated setSandboxOperationChangeHint. To provide null as hint, pass in new ChangeHint.Provider(), not null.

proxy - the proxy object that handles the background task

getNumberOfOpenSandboxes

public int getNumberOfOpenSandboxes(boolean includeArchives)

Description copied from class: SandboxSupport

Returns the number of sandboxes that are currently open.

Overrides:

getNumberOfOpenSandboxes in class SandboxSupport

Parameters:

includeArchives - true if the sandboxes created from archives should be included if open

Returns:

the number of sandboxes that are currently open

listOpenSandboxes

public java.util.List<java.lang.String> listOpenSandboxes(boolean includeArchives)

Description copied from class: SandboxSupport

Returns the IDs of the sandboxes that are open at the time of invocation. An open sandbox is a sandbox that allows more operations than destroy to be performed on it. In other words, a sandbox that is not open can only be destroyed.

Specified by:

listOpenSandboxes in class SandboxSupport

Parameters:

includeArchives - true if the returned list should include the sandboxes that are created from archives

Returns:

the IDs of the open sandboxes at the time of invocation; an empty list if no sandboxes are open

certifyRepositoryMainline

public MetadataRevision certifyRepositoryMainline(java.util.Set<java.lang.String> reposIdSet,
                                                  java.lang.String transactionNote)

Description copied from class: SandboxSupport

Certifies the state of the mainlines of the specified repositories at the time of invocation. A new baseline will be established for each given repository. A new metadata revision will be created and returned. The implementation of this method is similar to the "publish" operation of a sandbox except that no transaction is published by this method. This method is usually invoked immediately after metadata changes are published via external transactions.

Overrides:

certifyRepositoryMainline in class SandboxSupport

Parameters:

reposIdSet - the IDs of the repositories that have changed

transactionNote - a short note that describes the revision. The length of the note must not exceed 100 bytes.

Returns:

the new metadata revision as the result of certification

canSynchronizedPublish

public boolean canSynchronizedPublish(Sandbox sandbox)

Description copied from class: SandboxSupport

Returns true if all locks needed for synchronizedPublish are available at the time of the invocation. This information serves as a hint only. A ConcurrentSandboxOperationException may still be thrown when synchronizedPublish is invoked because the locks may be acquired by another sandbox between the invocation of this method and that of synchronizedPublish. If a client must block on synchronizedPublish, skip this check and call synchronizedPublish periodically until ConcurrentSandboxOperationException is not thrown.

Overrides:

canSynchronizedPublish in class SandboxSupport

Parameters:

sandbox - the sandbox to be published

Returns:

true if all locks needed for synchronizedPublish are available at the time of the invocation

synchronizedPublish

public java.util.Map<SandboxedRepository,ChangeSet> synchronizedPublish(Sandbox sandbox,
                                                                        boolean refreshBefore)
                                                                 throws RepositoryExceptions,
                                                                        ConcurrentSandboxOperationException

Description copied from class: SandboxSupport

Publishes a sandbox only when all mainline exclusive locks of the branched repositories are available; in other words, a ConcurrentSandboxOperationException is thrown when another synchronizedPublish call is in progress, or when a mainline exclusive lock of any branched repository has been acquired by an archive.

Overrides:

synchronizedPublish in class SandboxSupport

Parameters:

sandbox - the sandbox to be published

refreshBefore - true if refresh should be called first after acquiring the necessary locks. If a repository is pending resume after the first pass, the process will be resumed once with change hint ChangeHint.STOP_AT_CONFLICTS. If any repository is still pending resume after the second pass, a SuspendedSandboxOperation is thrown.

Returns:

the changes just published

Throws:

RepositoryExceptions - if any error occurs during the publish

ConcurrentSandboxOperationException - if refreshBefore is true and any repository is still pending resume after the first resume

synchronizedPublish

public void synchronizedPublish(java.lang.String sandboxId,
                                SandboxBackgroundTask.Proxy<java.util.Map<SandboxedRepository,ChangeSet>> proxy)

Description copied from class: SandboxSupport

Publishes a sandbox in a background thread when all mainline exclusive locks of the branched repositories are available This method does not wait for the operation to complete.

Overrides:

synchronizedPublish in class SandboxSupport

Parameters:

sandboxId - the ID of the sandbox to be published

proxy - the proxy object that handles the background task

publish

public java.util.Map<SandboxedRepository,ChangeSet> publish(Sandbox sandbox)
                                                     throws RepositoryExceptions

Description copied from class: SandboxSupport

Merges changes in a sandbox back into the repositories. If there is any merge conflict, all merged changes are undone. If the changes to a repository cannot be undone, the repository will be set to state SandboxState.INACTIVE.

Specified by:

publish in class SandboxSupport

Parameters:

sandbox - the sandbox

Returns:

the changes that have been committed; an empty map if the sandbox does contain any repositories

Throws:

RepositoryExceptions - if merge conflicts are detected or any error occurs during the process

publish

public void publish(java.lang.String sandboxId,
                    SandboxBackgroundTask.Proxy<java.util.Map<SandboxedRepository,ChangeSet>> proxy)

Description copied from class: SandboxSupport

Publishes a sandbox in a background thread. This method does not wait for the operation to complete.

Overrides:

publish in class SandboxSupport

Parameters:

sandboxId - the ID of the sandbox to be published

proxy - the proxy object that handles the background task

unpublishCheck

public IneligibleForUnpublishException unpublishCheck(Sandbox sandbox)

Description copied from class: SandboxSupport

Checks if a sandbox is eligible for unpublish at this moment. Note that being eligible now does not guarantee the sandbox is still eligible for unpublish when unpublish is called.

Overrides:

unpublishCheck in class SandboxSupport

Parameters:

sandbox - the sandbox to be checked

Returns:

null if the given sandbox is eligible for unpublish; otherwise an object is returned to indicate the reason

See Also:

SandboxSupport.unpublish(oracle.adf.share.sandbox.Sandbox)

unpublish

public void unpublish(Sandbox sandbox)
               throws IneligibleForUnpublishException

Description copied from class: SandboxSupport

Unpublishes a sandbox if it's eligible.

Overrides:

unpublish in class SandboxSupport

Parameters:

sandbox - the sandbox to be unpublished

Throws:

IneligibleForUnpublishException - if the given sandbox is ineligible for unpublish

See Also:

SandboxSupport.unpublishCheck(oracle.adf.share.sandbox.Sandbox)

newRepositoryBaselines

public java.util.Set<java.lang.String> newRepositoryBaselines(java.lang.String note)

Description copied from class: SandboxSupport

Requests that all available repositories in the system establish new baselines for the current state of the repositories. New baselines will not be established for those repositories that do not support creation of new certified labels without sandboxes. If any repository fails creating a new certified label, an exception is thrown immediately and no baselines will be established. Note that when an exception is thrown, some repositories may have already created their new certified labels successfully. Those labels will remain in the repositories.

Overrides:

newRepositoryBaselines in class SandboxSupport

Parameters:

note - a short identifier indicating what the new repository baseline are for

Returns:

the IDs of the repositories whose baselines have been successfully estabalished; an empty set if no repository supports creation of new certified labels without sandboxes

See Also:

SandboxedRepository.newCertifiedLabel(java.lang.String)

destroy

public void destroy(Sandbox sandbox)
             throws RepositoryExceptions

Description copied from class: SandboxSupport

Destroys a sandbox and deletes all information pertaining to the sandbox.

Specified by:

destroy in class SandboxSupport

Parameters:

sandbox - the sandbox to be destroyed

Throws:

RepositoryExceptions - if there is any error coming from the repositories

destroy

public void destroy(Sandbox sandbox,
                    boolean retainInfo)
             throws RepositoryExceptions

Description copied from class: SandboxSupport

Destroys a sandbox and optionally retains the sandbox information such as operation logs. If the sandbox information is retained, the state will be set to SandboxState.DESTROYED.

Overrides:

destroy in class SandboxSupport

Parameters:

sandbox - the sandbox to be destroyed

retainInfo - true if the sandbox information should be retained

Throws:

RepositoryExceptions

See Also:

SandboxSupport.destroy(Sandbox)

destroy

public void destroy(java.lang.String sandboxId,
                    boolean retainInfo,
                    SandboxBackgroundTask.Proxy<java.lang.Object> proxy)

Description copied from class: SandboxSupport

Destroys a sandbox in a background thread. This method does not wait for the operation to complete.

Overrides:

destroy in class SandboxSupport

Parameters:

sandboxId - the ID of the sandbox to be destroyed

retainInfo - true if the sandbox information should be retained

proxy - the proxy object that handles the background task

enableFeature

public boolean enableFeature(Sandbox sandbox,
                             java.lang.String featureClassName)
                      throws IncompatibleFeatureException,
                             SandboxException

Description copied from class: SandboxSupport

Enables a feature in the sandbox.

Specified by:

enableFeature in class SandboxSupport

Parameters:

sandbox - the sandbox

featureClassName - the ID of the sandboxed feature

Returns:

false if the feature was already enabled prior to this call

Throws:

IncompatibleFeatureException - if the feature is incompatible with the sandbox

SandboxException - if an error occurs while enabling the feature

enableFeatures

public java.util.Map<java.lang.String,java.lang.Throwable> enableFeatures(Sandbox sandbox,
                                                                          java.util.List<java.lang.String> featureIdList)
                                                                   throws IncompatibleFeatureException,
                                                                          SandboxException

Description copied from class: SandboxSupport

Enables a list of features. Subclasses may override this method to support concurrent processing to improve performance.

Overrides:

enableFeatures in class SandboxSupport

Parameters:

sandbox - the sandbox where the features are to be enabled

featureIdList - the IDs of the features to be enabled

Returns:

errors occurred during the process if any. The keys of the map are the feature IDs while the values are the errors. The caller must examine the returned map for any failures. Any empty map indicates all features are successfully enabled.

Throws:

IncompatibleFeatureException

SandboxException

enableFeatures

public void enableFeatures(java.lang.String sandboxId,
                           java.util.List<java.lang.String> featureIdList,
                           SandboxBackgroundTask.Proxy<java.util.Map<java.lang.String,java.lang.Throwable>> proxy)

Description copied from class: SandboxSupport

Enables a list of features in a background thread. This method does not wait for the operation to complete.

Overrides:

enableFeatures in class SandboxSupport

Parameters:

sandboxId - the ID of the sandbox

featureIdList - the list of the IDs of the features to be enabled

proxy - the proxy object that handles the background task

setSandboxConstraints

public void setSandboxConstraints(Sandbox sandbox,
                                  SandboxConstraints constraints)

Description copied from class: SandboxSupport

Sets constraints for a sandbox.

Overrides:

setSandboxConstraints in class SandboxSupport

Parameters:

sandbox - the sandbox with which the constraints are to be associated

constraints - the constraints for the sandbox

setSandboxConstraintsSummary

public void setSandboxConstraintsSummary(Sandbox sandbox,
                                         java.lang.String constraintsSummary)

Description copied from class: SandboxSupport

Sets the summary of constraints for a sandbox. The summary is for display only.

Overrides:

setSandboxConstraintsSummary in class SandboxSupport

Parameters:

sandbox - the sandbox with which the constraints are to be associated

constraintsSummary - the summary of constraints for the sandbox

setSandboxOperationChangeHint

public void setSandboxOperationChangeHint(Sandbox sandbox,
                                          ChangeHint changeHint)

Description copied from class: SandboxSupport

Gives a change hint to all repositories involved in the current operation.

Overrides:

setSandboxOperationChangeHint in class SandboxSupport

Parameters:

sandbox - the sandbox on which the current operation is in progress

changeHint - the change hint; null if the default hint should be given

See Also:

SandboxTransaction

getRepositoryChangeHints

public java.util.Map<java.lang.String,ChangeHint> getRepositoryChangeHints(Sandbox sandbox)

Description copied from class: SandboxSupport

Returns the hints taken by the current operation. If no operation is in progress, the hints may be for the last operation. Note that the returned hints may not be the same as the hints taken by the operation if any client has updated the hints using the deprecated setSandboxOperationChangeHint method.

Overrides:

getRepositoryChangeHints in class SandboxSupport

Parameters:

sandbox - the sandbox being operated

Returns:

the hints used by the current operation

tryLock

public boolean tryLock(SandboxArchive archive)

Description copied from class: SandboxSupport

Tries to acquire the lock for processing a sandbox archive. It is assumed that at most one sandbox archive can be processed at any given time. That means the lock is considered already acquired when this method is called again before unlock(SandboxArchive). The behavior of calling this method again with a different SandboxArchive object before releasing the lock for the first call is undefined.

Overrides:

tryLock in class SandboxSupport

Parameters:

archive - the sandbox archive to be processed

Returns:

true if the lock is acquired successfully; false if the involved repositories are currently locked by other sandboxes

See Also:

SandboxSupport.unlock(oracle.adf.share.sandbox.SandboxArchive)

unlock

public void unlock(SandboxArchive archive)

Description copied from class: SandboxSupport

Releases the lock acquired for processing a sandbox archive. It is assumed that at most one sandbox archive can be processed at any given time. This method releases the lock without consulting the given SandboxArchive object.

Overrides:

unlock in class SandboxSupport

Parameters:

archive - the sandbox archive that was just processed; or null if the information of the archive is no longer available

See Also:

SandboxSupport.tryLock(oracle.adf.share.sandbox.SandboxArchive)

isLockedBySandboxArchive

public boolean isLockedBySandboxArchive()

Description copied from class: SandboxSupport

Returns true if the mainline of any repository is locked by a sandbox archive at the time of invcation. When the processing of a sandbox archive is in progress, ConcurrentSandboxOperationException may be thrown by methods that require the same locks already acquired by the archive, such as enableFeature or synchronizedPublish. The client may simply skip all operations and wait until this method returns false again.

Overrides:

isLockedBySandboxArchive in class SandboxSupport

Returns:

true if the mainline of any repository is locked by a sandbox archive at the time of invocation

See Also:

SandboxSupport.tryLock(oracle.adf.share.sandbox.SandboxArchive), SandboxSupport.unlock(oracle.adf.share.sandbox.SandboxArchive)

addAdministrator

public boolean addAdministrator(Sandbox sandbox,
                                java.lang.String userName)

Description copied from class: SandboxSupport

Adds a user to the list of administrators of a sandbox.

Overrides:

addAdministrator in class SandboxSupport

Parameters:

sandbox - the sandbox administered

userName - the user to be added as an administrator

Returns:

true if the user is not an administrator prior to this call; false if the user was not added to the list because he is already an administrator of the sandbox

removeAdministrator

public boolean removeAdministrator(Sandbox sandbox,
                                   java.lang.String userName)

Description copied from class: SandboxSupport

Removes a user from the list of administrators of a sandbox.

Overrides:

removeAdministrator in class SandboxSupport

Parameters:

sandbox - the sandbox administered by the user

userName - the user to be removed from the list of administrators

Returns:

true if the user is an administrator prior to this call and is successfully removed from the list; false if the user is not on the list or cannot be removed because he is the owner of the sandbox

listAdministrators

public java.util.List<java.lang.String> listAdministrators(Sandbox sandbox)

Description copied from class: SandboxSupport

Returns the list of administrators of a sandbox.

Overrides:

listAdministrators in class SandboxSupport

Parameters:

sandbox - the sandbox

Returns:

names of the sandbox administrator

markSandboxesForUpdate

public void markSandboxesForUpdate(SandboxUpdatePatchInfo patchInfo)

Description copied from class: SandboxSupport

Marks all open sandboxes for update.

Overrides:

markSandboxesForUpdate in class SandboxSupport

Parameters:

patchInfo - the information of the patch that initiates the update

markSandboxForUpdate

public void markSandboxForUpdate(SandboxUpdatePatchInfo patchInfo,
                                 Sandbox sandbox)

Description copied from class: SandboxSupport

Marks a sandbox for update. If this sandbox is not open, this operation has no effect.

Overrides:

markSandboxForUpdate in class SandboxSupport

Parameters:

patchInfo - the information of the patch that initiates the update

sandbox - the sandbox to be marked

completeSandboxPendingUpdates

public void completeSandboxPendingUpdates(java.lang.String sandboxId,
                                          SandboxBackgroundTask.Proxy<java.lang.Boolean> proxy)

Description copied from class: SandboxSupport

Completes all pending updates in a background thread.

Overrides:

completeSandboxPendingUpdates in class SandboxSupport

Parameters:

sandboxId - the ID of the sandbox to be updated

proxy - the proxy object that handles the background task

completeSandboxPendingUpdates

public boolean completeSandboxPendingUpdates(Sandbox sandbox)
                                      throws SandboxUpdateException

Description copied from class: SandboxSupport

Completes all pending updates.

Overrides:

completeSandboxPendingUpdates in class SandboxSupport

Parameters:

sandbox - the sandbox to be updated

Returns:

true if this sandbox has been updated successfully and refresh is required

Throws:

SandboxUpdateException - if an error occurs while updating the sandbox

isSandboxPendingUpdates

public boolean isSandboxPendingUpdates(Sandbox sandbox)

Description copied from class: SandboxSupport

Returns true if there is any pending update for this sandbox.

Overrides:

isSandboxPendingUpdates in class SandboxSupport

Parameters:

sandbox - the sandbox to be checked

Returns:

true if there is any pending update for this sandbox

getSandboxPendingUpdatesDueDate

public java.util.Date getSandboxPendingUpdatesDueDate(Sandbox sandbox)

Description copied from class: SandboxSupport

Returns the nearest due date of the pending updates.

Overrides:

getSandboxPendingUpdatesDueDate in class SandboxSupport

Parameters:

sandbox - the sandbox to be checked

Returns:

the nearest due date of the pending updates, null if there is no pending updates. Certain dates before January 1, 1970, 00:00:00 GMT are designated as constants that represent special event points. For example, SandboxUpdate.DUE_NOW indicates that this sandbox must be updated immediately before they can be used again. SandboxUpdate.DUE_NEXT_REFRESH indicates the updates may be deferred until the next time this sandbox is refreshed.

See Also:

SandboxUpdate

getSandboxPendingUpdates

public java.util.List<SandboxUpdate> getSandboxPendingUpdates(Sandbox sandbox)

Description copied from class: SandboxSupport

Gets the list of pending updates if any.

Overrides:

getSandboxPendingUpdates in class SandboxSupport

Parameters:

sandbox - the sandbox to be checked

Returns:

the list of pending updates if any; an empty list if there is no pending updates

getSandboxLastUpdateErrors

public java.util.Map<java.lang.String,SandboxUpdateErrorInfo> getSandboxLastUpdateErrors(Sandbox sandbox)

Description copied from class: SandboxSupport

Gets the errors from the last failed update.

Overrides:

getSandboxLastUpdateErrors in class SandboxSupport

Parameters:

sandbox - the sandbox that was updated

Returns:

the errors from the SandboxUpdateSupport classes from the last failed update. The keys of the map are the full names of the SandboxUpdateSupport classes. An empty map is returned if there is no pending updates, or if the pending updates have not been started, or if the updates were successful.

timeoutSandboxOperationProcesses

public void timeoutSandboxOperationProcesses()

Description copied from class: SandboxSupport

Marks sandboxes that are being processed for a duration that is longer than the default time allowed. Once a sandbox is marked as timed out, the sandbox may be suspended for recovery; or in the simplest implementation, a repository error is logged to indicate that the operation has timed out and the sandbox is placed in a state where the same operation may be attempted again if possible. Note that this method does not and cannot terminate any sandbox operation process. The only thing it does is to mark a sandbox internally when it detects that the elapsed time of a process associated with the sandbox is longer than the default time allowed. Whether the process is still alive or not is unknown.

Overrides:

timeoutSandboxOperationProcesses in class SandboxSupport