oracle.adf.share.sandbox

Class MdsCommonRepositoryExtension

java.lang.Object

oracle.adf.share.sandbox.MdsCommonRepositoryExtension

public abstract class MdsCommonRepositoryExtension
extends java.lang.Object

An extension to MdsCommonRepository for other repositories or products to participate in various sandbox operations such as "refresh" or "publish". To register an extension, follow the Java service provider pattern and register the subclasses in META-INF/services.

Field Summary

Fields

Modifier and Type	Field and Description
protected ADFLogger	_logger The default logger instance.

Constructor Summary

Constructors

Constructor and Description
MdsCommonRepositoryExtension() Constrcuts an extension object.

Method Summary

Modifier and Type	Method and Description
abstract void	exceptionThrown(java.lang.Throwable t) Invoked when an exception is thrown by any of the methods in this extension except this method.
java.util.Set<java.lang.String>	getExcludedDocumentPaths(Sandbox sandbox, java.lang.String mdsSandboxName) Returns the set of document paths that should be excluded during refresh or publish.
boolean	publishCompleted(Sandbox sandbox, java.lang.String mdsSandboxName) Invoked after the MDS branch of a unified sandbox is published successfully.
boolean	refreshCompleted(Sandbox sandbox, java.lang.String mdsSandboxName) Invoked after the MDS branch of a unified sandbox is refreshed successfully.

Methods inherited from class java.lang.Object

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

Field Detail

_logger

protected final ADFLogger _logger

The default logger instance.

Constructor Detail

MdsCommonRepositoryExtension

public MdsCommonRepositoryExtension()

Constrcuts an extension object.

Method Detail

getExcludedDocumentPaths

public java.util.Set<java.lang.String> getExcludedDocumentPaths(Sandbox sandbox,
                                                                java.lang.String mdsSandboxName)

Returns the set of document paths that should be excluded during refresh or publish.

Parameters:

sandbox - the unified sandbox that is being refreshed or published

mdsSandboxName - the name of the MDS sandbox

Returns:

the set of document paths that should be excluded during refresh or publish

refreshCompleted

public boolean refreshCompleted(Sandbox sandbox,
                                java.lang.String mdsSandboxName)

Invoked after the MDS branch of a unified sandbox is refreshed successfully.

Parameters:

sandbox - the unified sandbox being refreshed

mdsSandboxName - the name of the MDS sandbox

Returns:

true if this method has made changes to the sandbox

publishCompleted

public boolean publishCompleted(Sandbox sandbox,
                                java.lang.String mdsSandboxName)

Invoked after the MDS branch of a unified sandbox is published successfully.

Parameters:

sandbox - the unified sandbox being published

mdsSandboxName - the name of the MDS sandbox

Returns:

true if this method has made changes to mainline

exceptionThrown

public abstract void exceptionThrown(java.lang.Throwable t)

Invoked when an exception is thrown by any of the methods in this extension except this method.

Parameters:

t - the error thrown