oracle.adfinternal.share.sandbox

Class SandboxUtil

java.lang.Object

oracle.adfinternal.share.sandbox.SandboxUtil

public class SandboxUtil
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DYNAMIC_LAYER_CLASS_NAME
static java.lang.String	DYNAMIC_LAYER_COUNT
static java.lang.String	DYNAMIC_LAYER_LABEL
static java.lang.String	DYNAMIC_LAYER_NAME
static java.lang.String	DYNAMIC_LAYER_VALUE
static java.lang.String	DYNAMIC_LAYER_VALUE_LABEL
static java.lang.String	SANDBOX_CONTEXT_LABEL Sandbox Customizatiaon Context (i.e tip layer) display label.
static java.lang.String	SANDBOX_CONTEXT_VALUE_LABEL Sandbox Customizatiaon Context Value (i.e tip value) display label.
static java.lang.String	SANDBOX_DEFAULT_MODE
static java.lang.String	SANDBOX_EDIT_MODE
static java.lang.String	SANDBOX_MODE
static java.lang.String	SANDBOX_PREVIEW_MODE
static java.lang.String	SANDBOX_TIP_LAYER_CLASS_NAME
static java.lang.String	SANDBOX_TIP_LAYER_LABEL
static java.lang.String	SANDBOX_TIP_LAYER_NAME
static java.lang.String	SANDBOX_TIP_LAYER_VALUE
static java.lang.String	SANDBOX_TIP_LAYER_VALUE_LABEL

Constructor Summary

Constructors

Constructor and Description
SandboxUtil()

Method Summary

Modifier and Type	Method and Description
static oracle.mds.naming.Namespace	getDefaultCustStoreMappedNs(oracle.mds.core.MDSInstance mdsInstance)
static oracle.mds.config.CustConfig	getMDSCustConfig()
static oracle.mds.sandbox.Sandbox	getMDSSandbox(java.lang.String mdsSandboxName)
static java.util.List<java.util.Map<java.lang.String,java.lang.String>>	getMDSSandboxDynamicLayerDetails(java.lang.String mdsSandboxName) Returns details of the dynamic layers associated with the given mds sandbox.
static java.util.Map<java.lang.String,java.lang.String>	getMDSSandboxDynamicLayerMap(java.lang.String mdsSandboxName) Returns the dynamicLayerClass/layerValue assocaited with the mds sandbox as key/value pair Useful for CustomizationClass implementation to fetch the layer value associated with the sandbox for a given layer.
static oracle.mds.sandbox.SandboxMetadata	getMDSSandboxMetadata(java.lang.String mdsSandboxName)
static java.lang.String	getMDSSandboxMetadataProperty(java.lang.String mdsSandboxName, java.lang.String propertyName)
static java.lang.String	getMDSSandboxName(Sandbox sandboxObj) Deprecated. Call sandboxObj.getRepositoryBranchId(MetadataEnvironment.MDS_DEFAULT_CUST_STORE_REPOSITORY)
static java.lang.String	getMDSSandboxName(java.lang.String sandboxId) Returns the branch ID of MetadataEnvironment.MDS_DEFAULT_CUST_STORE_REPOSITORY if such repository is branched.
static java.lang.String	getMDSSandboxTipLayerClassName(java.lang.String mdsSandboxName)
static java.lang.String	getMDSSandboxTipLayerValue(java.lang.String mdsSandboxName)
static java.lang.String	getMDSSandboxTipLayerValueLabel(java.lang.String mdsSandboxName)
static Sandbox	getSandbox(java.lang.String mdsSandboxName) Legacy method was using MDS Sandbox Id to get customization context associated with the sandbox as the context details are saved in mds sandbox metadata.
static java.util.List<java.lang.String>	getSandboxContextLayerAndValue(Sandbox sandboxObj)
static java.util.List<java.util.Map<java.lang.String,java.lang.String>>	getSandboxDynamicLayerDetails(Sandbox sandboxObj) Returns details of the dynamic layers associated with the given sandbox.
static java.util.Map<java.lang.String,java.lang.String>	getSandboxDynamicLayerMap(Sandbox sandboxObj) Returns the dynamicLayerClass/layerValue assocaited with the mds sandbox as key/value pair Useful for CustomizationClass implementation to fetch the layer value associated with the sandbox for a given layer.
static java.lang.String	getSandboxTipLayerClassName(Sandbox sandboxObj)
static java.lang.String	getSandboxTipLayerValue(Sandbox sandboxObj)
static boolean	isSandboxEditModeSupported(Sandbox sandboxObj) Deprecated. Use SandboxSessionSupport.getInstance().checkCurrentCustomizationContext(SandboxConstraints). Sandbox is in edit mode we will continue to be in edit mode only if the dynamic layers upto tip layer are available in the same order as selected during sandbox creation and they return the value selected for that layer during sandbox creation.
static boolean	isSandboxEditModeSupported(java.lang.String mdsSandboxName) Sandbox is in edit mode we will continue to be in edit mode only if the dynamic layers upto tip layer are available in the same order as selected during sandbox creation and they return the value selected for that layer during sandbox creation.
static boolean	isStringNullOrEmpty(java.lang.String str)
static java.util.List<SandboxInfo>	listUnifiedSandboxes(java.lang.String searchAttr, java.lang.String searchValue, java.util.List<java.lang.String> toolIds, java.lang.String viewType, SandboxedFeatures sfList, java.lang.String developmentMode) Deprecated.
static java.util.List<SandboxInfo>	listUnifiedSandboxes(java.lang.String searchAttr, java.lang.String searchValue, java.util.List<java.lang.String> toolIds, java.lang.String viewType, SandboxedFeatures sfList, java.lang.String developmentMode, java.lang.String currentUserName) Returns the sandboxes based on the search criteria (Search Attribute and Value) and Tool Id's.
static java.util.List<java.lang.String>	listUnifiedSandboxIds() Returns the list of Active Sandbox IDs.
static boolean	setMDSSandboxMetadataProperties(java.lang.String mdsSandboxName, java.util.Map<java.lang.String,java.lang.String> properties)
static boolean	setMDSSandboxMetadataProperty(java.lang.String mdsSandboxName, java.lang.String propertyName, java.lang.String propertyValue)
static boolean	setMDSSandboxTipLayerClassName(java.lang.String mdsSandboxName, java.lang.String custClassName)
static boolean	setMDSSandboxTipLayerValue(java.lang.String mdsSandboxName, java.lang.String custClassValue)

Methods inherited from class java.lang.Object

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

Field Detail

SANDBOX_TIP_LAYER_CLASS_NAME

public static final java.lang.String SANDBOX_TIP_LAYER_CLASS_NAME

See Also:

Constant Field Values

SANDBOX_TIP_LAYER_VALUE

public static final java.lang.String SANDBOX_TIP_LAYER_VALUE

See Also:

Constant Field Values

SANDBOX_TIP_LAYER_NAME

public static final java.lang.String SANDBOX_TIP_LAYER_NAME

See Also:

Constant Field Values

SANDBOX_TIP_LAYER_VALUE_LABEL

public static final java.lang.String SANDBOX_TIP_LAYER_VALUE_LABEL

See Also:

Constant Field Values

SANDBOX_TIP_LAYER_LABEL

public static final java.lang.String SANDBOX_TIP_LAYER_LABEL

See Also:

Constant Field Values

DYNAMIC_LAYER_COUNT

public static final java.lang.String DYNAMIC_LAYER_COUNT

See Also:

Constant Field Values

DYNAMIC_LAYER_CLASS_NAME

public static final java.lang.String DYNAMIC_LAYER_CLASS_NAME

See Also:

Constant Field Values

DYNAMIC_LAYER_NAME

public static final java.lang.String DYNAMIC_LAYER_NAME

See Also:

Constant Field Values

DYNAMIC_LAYER_VALUE

public static final java.lang.String DYNAMIC_LAYER_VALUE

See Also:

Constant Field Values

DYNAMIC_LAYER_VALUE_LABEL

public static final java.lang.String DYNAMIC_LAYER_VALUE_LABEL

See Also:

Constant Field Values

DYNAMIC_LAYER_LABEL

public static final java.lang.String DYNAMIC_LAYER_LABEL

See Also:

Constant Field Values

SANDBOX_MODE

public static final java.lang.String SANDBOX_MODE

See Also:

Constant Field Values

SANDBOX_PREVIEW_MODE

public static final java.lang.String SANDBOX_PREVIEW_MODE

See Also:

Constant Field Values

SANDBOX_EDIT_MODE

public static final java.lang.String SANDBOX_EDIT_MODE

See Also:

Constant Field Values

SANDBOX_DEFAULT_MODE

public static final java.lang.String SANDBOX_DEFAULT_MODE

See Also:

Constant Field Values

SANDBOX_CONTEXT_LABEL

public static final java.lang.String SANDBOX_CONTEXT_LABEL

Sandbox Customizatiaon Context (i.e tip layer) display label.

See Also:

Constant Field Values

SANDBOX_CONTEXT_VALUE_LABEL

public static final java.lang.String SANDBOX_CONTEXT_VALUE_LABEL

Sandbox Customizatiaon Context Value (i.e tip value) display label.

See Also:

Constant Field Values

Constructor Detail

SandboxUtil

public SandboxUtil()

Method Detail

getMDSSandboxName

@Deprecated
public static java.lang.String getMDSSandboxName(Sandbox sandboxObj)

Deprecated. Call sandboxObj.getRepositoryBranchId(MetadataEnvironment.MDS_DEFAULT_CUST_STORE_REPOSITORY)

Returns the branch ID of MetadataEnvironment.MDS_DEFAULT_CUST_STORE_REPOSITORY if such repository is branched.

Parameters:

sandboxObj - the unified sandbox

Returns:

the branch ID of MetadataEnvironment.MDS_DEFAULT_CUST_STORE_REPOSITORY

getMDSSandboxName

public static java.lang.String getMDSSandboxName(java.lang.String sandboxId)

Returns the branch ID of MetadataEnvironment.MDS_DEFAULT_CUST_STORE_REPOSITORY if such repository is branched.

Parameters:

sandboxId - the ID of the unified sandbox

Returns:

the branch ID of MetadataEnvironment.MDS_DEFAULT_CUST_STORE_REPOSITORY, null if the unified sandbox does not exist or the repository is not branched

getDefaultCustStoreMappedNs

public static oracle.mds.naming.Namespace getDefaultCustStoreMappedNs(oracle.mds.core.MDSInstance mdsInstance)

getMDSSandbox

public static oracle.mds.sandbox.Sandbox getMDSSandbox(java.lang.String mdsSandboxName)

getMDSSandboxMetadata

public static oracle.mds.sandbox.SandboxMetadata getMDSSandboxMetadata(java.lang.String mdsSandboxName)

getMDSSandboxMetadataProperty

public static java.lang.String getMDSSandboxMetadataProperty(java.lang.String mdsSandboxName,
                                                             java.lang.String propertyName)

setMDSSandboxMetadataProperty

public static boolean setMDSSandboxMetadataProperty(java.lang.String mdsSandboxName,
                                                    java.lang.String propertyName,
                                                    java.lang.String propertyValue)

setMDSSandboxMetadataProperties

public static boolean setMDSSandboxMetadataProperties(java.lang.String mdsSandboxName,
                                                      java.util.Map<java.lang.String,java.lang.String> properties)

setMDSSandboxTipLayerClassName

public static boolean setMDSSandboxTipLayerClassName(java.lang.String mdsSandboxName,
                                                     java.lang.String custClassName)

getMDSSandboxTipLayerClassName

public static java.lang.String getMDSSandboxTipLayerClassName(java.lang.String mdsSandboxName)

getSandboxTipLayerClassName

public static java.lang.String getSandboxTipLayerClassName(Sandbox sandboxObj)

setMDSSandboxTipLayerValue

public static boolean setMDSSandboxTipLayerValue(java.lang.String mdsSandboxName,
                                                 java.lang.String custClassValue)

getMDSSandboxTipLayerValue

public static java.lang.String getMDSSandboxTipLayerValue(java.lang.String mdsSandboxName)

getSandboxTipLayerValue

public static java.lang.String getSandboxTipLayerValue(Sandbox sandboxObj)

getMDSSandboxTipLayerValueLabel

public static java.lang.String getMDSSandboxTipLayerValueLabel(java.lang.String mdsSandboxName)

getSandboxContextLayerAndValue

public static java.util.List<java.lang.String> getSandboxContextLayerAndValue(Sandbox sandboxObj)

getSandboxDynamicLayerMap

public static java.util.Map<java.lang.String,java.lang.String> getSandboxDynamicLayerMap(Sandbox sandboxObj)

Returns the dynamicLayerClass/layerValue assocaited with the mds sandbox as key/value pair Useful for CustomizationClass implementation to fetch the layer value associated with the sandbox for a given layer.

Parameters:

sandboxObj - - Unified Sandbox Object

Returns:

getMDSSandboxDynamicLayerMap

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

Returns the dynamicLayerClass/layerValue assocaited with the mds sandbox as key/value pair Useful for CustomizationClass implementation to fetch the layer value associated with the sandbox for a given layer.

Parameters:

mdsSandboxName -

Returns:

getSandboxDynamicLayerDetails

public static java.util.List<java.util.Map<java.lang.String,java.lang.String>> getSandboxDynamicLayerDetails(Sandbox sandboxObj)

Returns details of the dynamic layers associated with the given sandbox. Each Map object contains 3 values (dynamicLayerName, dynamicLayerClassName, dynamicLayerValue). Order of items are based on the order in which they appeared in sandbox configuration metadata file while creating sandbox.

Parameters:

sandboxObj - - Unified Sandbox Object

Returns:

getMDSSandboxDynamicLayerDetails

public static java.util.List<java.util.Map<java.lang.String,java.lang.String>> getMDSSandboxDynamicLayerDetails(java.lang.String mdsSandboxName)

Returns details of the dynamic layers associated with the given mds sandbox. Each Map object contains 3 values (dynamicLayerName, dynamicLayerClassName, dynamicLayerValue). Order of items are based on the order in which they appeared in sandbox configuration metadata file while creating sandbox.

Parameters:

mdsSandboxName -

Returns:

getMDSCustConfig

public static oracle.mds.config.CustConfig getMDSCustConfig()

isSandboxEditModeSupported

@Deprecated
public static boolean isSandboxEditModeSupported(Sandbox sandboxObj)

Deprecated. Use SandboxSessionSupport.getInstance().checkCurrentCustomizationContext(SandboxConstraints). Sandbox is in edit mode we will continue to be in edit mode only if the dynamic layers upto tip layer are available in the same order as selected during sandbox creation and they return the value selected for that layer during sandbox creation.

Parameters:

sandboxObj - - Sandbox object

Returns:

isSandboxEditModeSupported

public static boolean isSandboxEditModeSupported(java.lang.String mdsSandboxName)

Sandbox is in edit mode we will continue to be in edit mode only if the dynamic layers upto tip layer are available in the same order as selected during sandbox creation and they return the value selected for that layer during sandbox creation.

Parameters:

mdsSandboxName - - MDS Sandbox Name

Returns:

getSandbox

public static Sandbox getSandbox(java.lang.String mdsSandboxName)

Legacy method was using MDS Sandbox Id to get customization context associated with the sandbox as the context details are saved in mds sandbox metadata. It is now saved in unified sandbox table. To continue to support legacy helper APIs we need to get sandbox id from mds sandbox name. This API's parses mds sandbox name and returns Sandbox Object.

Parameters:

mdsSandboxName -

Returns:

Unified Sandbox Object

listUnifiedSandboxes

@Deprecated
public static java.util.List<SandboxInfo> listUnifiedSandboxes(java.lang.String searchAttr,
                                                                           java.lang.String searchValue,
                                                                           java.util.List<java.lang.String> toolIds,
                                                                           java.lang.String viewType,
                                                                           SandboxedFeatures sfList,
                                                                           java.lang.String developmentMode)

Deprecated.

Returns the sandboxes based on the search criteria (Search Attribute and Value) and Tool Id's. The list is sorted by the creation dates of the sandboxes from the newest to the oldest.

Parameters:

searchAttr - Search Key indicating the Type of search User is trying to perform. It can be a Name, Contect or Publishable fields search

searchValue - Search Value provided in the Search UI

toolIds - List of Tool Ids selected in the UI for filtering the Sandboxes based on tools

viewType - indicates the View Type to be rendered in the UI. It can be Available, Previewable or Published Sandboxes View

sfList - Sandboxed Feature list used for processing the selected tools while creating the sandbox

developmentMode - indicates VERTICAL or no-VERTICAL Development mode This API is deprecated and should not be used.

Returns:

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

Throws:

java.lang.IllegalArgumentException - if the given name is null

listUnifiedSandboxes

public static java.util.List<SandboxInfo> listUnifiedSandboxes(java.lang.String searchAttr,
                                                               java.lang.String searchValue,
                                                               java.util.List<java.lang.String> toolIds,
                                                               java.lang.String viewType,
                                                               SandboxedFeatures sfList,
                                                               java.lang.String developmentMode,
                                                               java.lang.String currentUserName)

Returns the sandboxes based on the search criteria (Search Attribute and Value) and Tool Id's. The list is sorted by the creation dates of the sandboxes from the newest to the oldest.

Parameters:

searchAttr - Search Key indicating the Type of search User is trying to perform. It can be a Name, Contect or Publishable fields search

searchValue - Search Value provided in the Search UI

toolIds - List of Tool Ids selected in the UI for filtering the Sandboxes based on tools

viewType - indicates the View Type to be rendered in the UI. It can be Available, Previewable or Published Sandboxes View

sfList - Sandboxed Feature list used for processing the selected tools while creating the sandbox

developmentMode - indicates VERTICAL or no-VERTICAL Development mode

currentUserName - indicates the Current Logged in User

Returns:

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

Throws:

java.lang.IllegalArgumentException - if the given name is null

listUnifiedSandboxIds

public static java.util.List<java.lang.String> listUnifiedSandboxIds()

Returns the list of Active Sandbox IDs. The list is sorted by the creation dates of the sandboxes from the newest to the oldest.

Returns:

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

Throws:

java.lang.IllegalArgumentException - if the given name is null

isStringNullOrEmpty

public static boolean isStringNullOrEmpty(java.lang.String str)