oracle.adf.share.sandbox

Class MdsRepository

java.lang.Object

oracle.adf.share.sandbox.SandboxedRepository

oracle.adf.share.sandbox.MdsRepository

Direct Known Subclasses:

MdsCommonRepository

public abstract class MdsRepository
extends SandboxedRepository

A SandboxedRepository implementation for an MDS store configured in the application.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MdsRepository.MdsConfiguration Configuration of an MDS repository.

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

SandboxedRepository.MainlineCertifier

Field Summary

Fields

Modifier and Type	Field and Description
protected ADFLogger	_logger
protected MdsRepository.MdsConfiguration	_mdsConfiguration
static java.lang.String	UNIFIED_SANDBOX_ID

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	MdsRepository(java.lang.String name, MdsRepository.MdsConfiguration mdsConfig) Constructs a SandboxedRepository object for an MDS repository.

Method Summary

Modifier and Type	Method and Description
java.lang.String	branch(Sandbox sandbox, java.lang.String sourceBaseLine) Branches the objects for a sandbox so that future modifications to the sandbox will not affect the original repository.
static MetadataRevision	certify(java.util.List<oracle.mds.naming.Namespace> namespaces, java.lang.String shortComment) Certifies MDS stores represented by their signature namespaces and returns a new metadata revision.
void	destroy(Sandbox sandbox) Destroys a sandbox.
ChangeSet	getChanges(Sandbox sandbox) Gets the changes made in a sandbox.
static java.lang.String	getCreationLabelForSandbox(java.lang.String sandboxName) Deprecated.
java.util.Date	getLastUpdateDate(Sandbox sandbox) Returns the date of the last update to this repository in a sandbox.
java.lang.String	getLastUpdatedBy(Sandbox sandbox) Returns the user who performed last update to this repository in a sandbox.
SandboxedRepository.MainlineCertifier	getMainlineCertifier() Returns the proxy that creates and returns a new certified label that represents the current state of the repository mainline.
static java.util.Map<java.lang.String,java.lang.String>	getMdsRepositoryToNamespaceMap() Returns the map from MdsRepository implementations in the system to their store locator namespaces.
oracle.mds.naming.Namespace	getMdsStoreLocator() Returns the namespace used to locate the MDS store used by this repository.
SandboxTransaction	getPendingTransaction(Sandbox sandbox, java.lang.String transactionId) Gets the pending transaction of a sandbox operation.
static java.lang.String	getPostMergeLabelForSandbox(java.lang.String sandboxName) Deprecated.
static java.lang.String	getPostMergeUndoLabelForSandbox(java.lang.String sandboxName) Deprecated.
static java.lang.String	getPreCertifiedLabelForSandbox(java.lang.String sandboxName) Deprecated.
static java.lang.String	getPreMergeLabelForSandbox(java.lang.String sandboxName) Deprecated.
static java.lang.String	getPreMergeUndoLabelForSandbox(java.lang.String sandboxName) Deprecated.
static java.lang.String	getRefreshLabelForSandbox(java.lang.String sandboxName) Deprecated.
static java.lang.String	getTimeSuffix()
void	mergeConflicts(Sandbox sandbox) Deprecated.
void	prepareForRefresh(Sandbox sandbox, java.lang.String targetBaseline) Invoked prior to refresh.
java.lang.String	prePublish(Sandbox sandbox) Invoked prior to publish(Sandbox) for the repository to prepare for the upcoming publishing operation.
UndoableChanges	publish(Sandbox sandbox) Merges changes in a sandbox into the repository mainline.
UndoableChanges	publish(Sandbox sandbox, SandboxArchive archive) Merges the contents in a sandbox from an archive into the repository mainline.
UndoableChanges	refresh(Sandbox sandbox, java.lang.String targetBaseline) Merges changes from a repository baseline into the sandbox.
boolean	usesCurrentThreadForRefresh() For Internal Use Only.
static void	validateMdsSandboxName(java.lang.String name) Validates the name of an MDS sandbox to be created

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

branch, equals, getAvailableProviders, getAvailableProviders, getBranchId, getId, getInstance, getInstance, getName, getState, hasChanges, hashCode, isRefreshNeeded, newCertifiedLabel, publishCompleted, refreshCompleted, setProgress, test, test, toString, warn

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

UNIFIED_SANDBOX_ID

public static final java.lang.String UNIFIED_SANDBOX_ID

See Also:

Constant Field Values

_logger

protected final ADFLogger _logger

_mdsConfiguration

protected final MdsRepository.MdsConfiguration _mdsConfiguration

Constructor Detail

MdsRepository

protected MdsRepository(java.lang.String name,
                        MdsRepository.MdsConfiguration mdsConfig)

Constructs a SandboxedRepository object for an MDS repository.

Parameters:

name - the name of the repository

mdsConfig - the MDS configuration

Throws:

java.lang.IllegalArgumentException - if the given MDS configuration is null

Method Detail

branch

public java.lang.String branch(Sandbox sandbox,
                               java.lang.String sourceBaseLine)
                        throws SandboxException

Description copied from class: SandboxedRepository

Branches the objects for a sandbox so that future modifications to the sandbox will not affect the original repository. If a branch already exists for the sandbox, no action is required.

Specified by:

branch in class SandboxedRepository

Parameters:

sandbox - the sandbox

sourceBaseLine - the baseline which the sandbox is based on. The baseline is usually the latest certified baseline

Returns:

the ID of the branch for the sandbox

Throws:

SandboxException - if an error occurs

See Also:

SandboxedRepository.refresh(oracle.adf.share.sandbox.Sandbox, String)

refresh

public UndoableChanges refresh(Sandbox sandbox,
                               java.lang.String targetBaseline)
                        throws MergeConflictsException,
                               SandboxException

Description copied from class: SandboxedRepository

Merges changes from a repository baseline into the sandbox.

Specified by:

refresh in class SandboxedRepository

Parameters:

sandbox - the sandbox

targetBaseline - the target baseline; null if the target baseline should be the tip of the mainline

Returns:

the changes made; null if there is no change

Throws:

MergeConflictsException - if any conflict occurs during the merge

SandboxException - if an error occurs

getPendingTransaction

public SandboxTransaction getPendingTransaction(Sandbox sandbox,
                                                java.lang.String transactionId)

Description copied from class: SandboxedRepository

Gets the pending transaction of a sandbox operation.

Overrides:

getPendingTransaction in class SandboxedRepository

Parameters:

sandbox - the sandbox that resulted in the pending transaction

transactionId - the transaction ID

Returns:

the pending transaction, or null if such transaction does not exist

mergeConflicts

@Deprecated
public void mergeConflicts(Sandbox sandbox)
                                throws SandboxException

Deprecated.

Throws:

SandboxException

getLastUpdateDate

public java.util.Date getLastUpdateDate(Sandbox sandbox)

Description copied from class: SandboxedRepository

Returns the date of the last update to this repository in a sandbox.

Overrides:

getLastUpdateDate in class SandboxedRepository

Parameters:

sandbox - the sandbox that contains this repository

Returns:

the date of the last update to this repository in the sandbox; null if such information is unavailable

getLastUpdatedBy

public java.lang.String getLastUpdatedBy(Sandbox sandbox)

Description copied from class: SandboxedRepository

Returns the user who performed last update to this repository in a sandbox.

Overrides:

getLastUpdatedBy in class SandboxedRepository

Parameters:

sandbox - the sandbox that contains this repository

Returns:

the user who performed last update to this repository in the sandbox; null if such information is unavailable

prepareForRefresh

public void prepareForRefresh(Sandbox sandbox,
                              java.lang.String targetBaseline)
                       throws SandboxException

Description copied from class: SandboxedRepository

Invoked prior to refresh.

Overrides:

prepareForRefresh in class SandboxedRepository

Parameters:

sandbox - the sandbox to be refreshed

targetBaseline - the target baseline; null if the target baseline whould be the tip of the mainline

Throws:

SandboxException - if an error occurs

publish

public UndoableChanges publish(Sandbox sandbox)
                        throws MergeConflictsException,
                               SandboxException

Description copied from class: SandboxedRepository

Merges changes in a sandbox into the repository mainline.

Specified by:

publish in class SandboxedRepository

Parameters:

sandbox - the sandbox

Returns:

the changes made; null if there is no change

Throws:

MergeConflictsException - if any conflict occurs during the merge

SandboxException - if an error occurs

publish

public UndoableChanges publish(Sandbox sandbox,
                               SandboxArchive archive)
                        throws MergeConflictsException,
                               SandboxException

Description copied from class: SandboxedRepository

Merges the contents in a sandbox from an archive into the repository mainline. By default this method delegates the call to publish(Sandbox).

Overrides:

publish in class SandboxedRepository

Parameters:

sandbox - the sandbox that contains the contents from the archive

archive - the archive that provides the contents of the sandbox

Returns:

the summary of the contents; null if there is no contents

Throws:

MergeConflictsException - if any conflict occurs during the merge

SandboxException - if an error occurs

getChanges

public ChangeSet getChanges(Sandbox sandbox)

Description copied from class: SandboxedRepository

Gets the changes made in a sandbox.

Specified by:

getChanges in class SandboxedRepository

Parameters:

sandbox - the sandbox

Returns:

the changes; null if no changes have been made or if the sandbox has been published

destroy

public void destroy(Sandbox sandbox)

Description copied from class: SandboxedRepository

Destroys a sandbox. Once a sandbox is destroyed, it cannot be recovered.

Specified by:

destroy in class SandboxedRepository

Parameters:

sandbox - the sandbox

prePublish

public java.lang.String prePublish(Sandbox sandbox)

Description copied from class: SandboxedRepository

Invoked prior to publish(Sandbox) for the repository to prepare for the upcoming publishing operation. A rollback label may be returned if the runtime should read from this label instead of the latest certified label during publishing.

Overrides:

prePublish in class SandboxedRepository

Parameters:

sandbox - the sandbox to be published

Returns:

the rollback label to read from during publishing; null if the runtime should continue to read from the latest certified label

getCreationLabelForSandbox

@Deprecated
public static java.lang.String getCreationLabelForSandbox(java.lang.String sandboxName)

Deprecated.

getRefreshLabelForSandbox

@Deprecated
public static java.lang.String getRefreshLabelForSandbox(java.lang.String sandboxName)

Deprecated.

getPreCertifiedLabelForSandbox

@Deprecated
public static java.lang.String getPreCertifiedLabelForSandbox(java.lang.String sandboxName)

Deprecated.

getPreMergeLabelForSandbox

@Deprecated
public static java.lang.String getPreMergeLabelForSandbox(java.lang.String sandboxName)

Deprecated.

getPostMergeLabelForSandbox

@Deprecated
public static java.lang.String getPostMergeLabelForSandbox(java.lang.String sandboxName)

Deprecated.

getPreMergeUndoLabelForSandbox

@Deprecated
public static java.lang.String getPreMergeUndoLabelForSandbox(java.lang.String sandboxName)

Deprecated.

getPostMergeUndoLabelForSandbox

@Deprecated
public static java.lang.String getPostMergeUndoLabelForSandbox(java.lang.String sandboxName)

Deprecated.

getTimeSuffix

public static java.lang.String getTimeSuffix()

getMainlineCertifier

public SandboxedRepository.MainlineCertifier getMainlineCertifier()

Description copied from class: SandboxedRepository

Returns the proxy that creates and returns a new certified label that represents the current state of the repository mainline.

Overrides:

getMainlineCertifier in class SandboxedRepository

Returns:

the proxy that creates and returns a new certified label that represents the current state of the repository mainline

getMdsStoreLocator

public final oracle.mds.naming.Namespace getMdsStoreLocator()

Returns the namespace used to locate the MDS store used by this repository.

Returns:

the namespace used to locate the MDS store used by this repository

usesCurrentThreadForRefresh

public boolean usesCurrentThreadForRefresh()

For Internal Use Only.

Returns:

true if the refresh operation must be run in the current thread

validateMdsSandboxName

public static void validateMdsSandboxName(java.lang.String name)

Validates the name of an MDS sandbox to be created

Parameters:

name - the name for the new sandbox

Throws:

IllegalCharSequenceException - if the name contains invalid character sequences

certify

public static MetadataRevision certify(java.util.List<oracle.mds.naming.Namespace> namespaces,
                                       java.lang.String shortComment)

Certifies MDS stores represented by their signature namespaces and returns a new metadata revision. If no corresponding MdsRepository implementation is found for an MDS store, the store is not certified.

Note that the certification process: label creation and revision creation will be done without using any extensions outside ADF, such as the SandboxSessionSupport implementation from Oracle Applications. The visibility of the repositories will depend on the caller's thread context class loader.

Parameters:

namespaces - the signature namespaces denoting the MDS stores to be certified

shortComment - a short comment that must not exceed 100 bytes in length

Returns:

the new metadata revision as a result of the certification or null if nothing is certified

getMdsRepositoryToNamespaceMap

public static java.util.Map<java.lang.String,java.lang.String> getMdsRepositoryToNamespaceMap()

Returns the map from MdsRepository implementations in the system to their store locator namespaces.

Returns:

the map where the keys are the IDs of repositories and the values are the namespaces that identify the MDS stores