public class ADFSessionOptions
extends java.lang.Object
implements java.io.Serializable
Modifier and Type | Class and Description |
---|---|
static class |
ADFSessionOptions.DefMode
def mode enums
|
static class |
ADFSessionOptions.Mode
Certain methods are prohibited in ADFSessionOptions based on the
the current Mode.
|
Modifier and Type | Field and Description |
---|---|
static int |
CLEVEL_CHECK_AND_CHANGE |
static int |
CLEVEL_CHECK_ONLY |
static int |
CLEVEL_CHECK_ONLY_INCL_WARNINGS |
static int |
CLEVEL_FORCED |
static int |
CLEVEL_NO_CHECK |
static java.lang.String |
DEFAULT_RESOLVER_CLASS_NAME |
static int |
ERR_HANDLE_COLLECT_ALL_ERRS |
static int |
ERR_HANDLE_RETURN_ON_FIRST_ERR |
static java.lang.String |
LABEL_LATEST |
static java.lang.String |
LABEL_MATCH |
static java.lang.String |
LABEL_NONE |
static java.lang.String |
LABEL_NOT_FOUND |
static java.lang.String |
MDS_SANDBOX_METADATA_CUST_CLASS_NAME_KEY |
static java.lang.String |
MDS_SANDBOX_METADATA_CUST_CLASS_VALUE_KEY |
static java.lang.String |
PName_authoringSettings |
static java.lang.String |
PName_baseLabel |
static java.lang.String |
PName_canChangeCheck |
static java.lang.String |
PName_clearCache |
static java.lang.String |
PName_custclasses |
static java.lang.String |
PName_custPolicy |
static java.lang.String |
PName_defMode |
static java.lang.String |
PName_includeTipMDSSession |
static java.lang.String |
PName_isolationLevel |
static java.lang.String |
PName_label |
static java.lang.String |
PName_mdslabel |
static java.lang.String |
PName_mode |
static java.lang.String |
PName_sboxname |
static java.lang.String |
PName_skipCheck |
Constructor and Description |
---|
ADFSessionOptions() |
ADFSessionOptions(ADFSessionOptions org) |
Modifier and Type | Method and Description |
---|---|
static boolean |
addChangeListener(ADFSessOptsChangeListener listener) |
void |
checkSessionOptionsChange(int coercionLevel) |
void |
clearCache(int coercionLevel)
Call the listeners registered with ADFSO to clear the cache.
|
java.lang.String |
computeLabel(java.lang.String labelName) |
protected boolean |
doSeedMatch(ADFSOSeed seed) |
protected boolean |
doSettingsMatch(SandboxSettings sbs) |
protected boolean |
doTipCCsMatch(java.lang.String fromSeed,
java.lang.String current) |
static java.lang.Object |
findLabels(java.lang.String matchString,
boolean firstMatch,
boolean latest) |
void |
finishSessionOptionsChange(int coercionLevel) |
static ADFSessionOptions |
fromString(java.lang.String str)
Parse an (XML) String into an ADFSessionOptions object.
|
ADFAuthoringSettings |
getAuthoringSettings() |
java.lang.String |
getBaseLabel() |
oracle.mds.cust.CustClassList |
getCustClassList()
Get the default CustClassList
|
oracle.mds.config.CustConfig |
getCustConfig()
Will return the current CustConfig object, as it would be set in MDSSession.
|
oracle.mds.cust.CustomizationPolicy |
getCustomizationPolicy()
Get the CustomizationPolicy object associated with the ADFSessionOptions instance.
|
java.lang.String |
getDefMode() |
int |
getEditRevNumber() |
int |
getErrorHandlingMode() |
oracle.mds.core.IsolationLevel |
getIsolationLevel() |
static oracle.mds.core.IsolationLevel |
getIsolationLevelValue(java.lang.String s) |
java.lang.String |
getLabel() |
static oracle.mds.config.CustConfig |
getMDSCustConfig() |
java.lang.Object |
getMergeConflictResolver() |
ADFSessionOptions.Mode |
getMode()
Get the current Mode on ADFSessionOptions.
|
java.lang.String |
getSandboxName() |
oracle.mds.naming.Namespace |
getSandboxNameSpace() |
java.lang.String |
getTrimCustClassListToClass()
Get the class name for the current tip CC layer
|
java.lang.String |
getTrimCustClassListToValue()
Deprecated.
in 12.2.2 - ADFSessionOptions no longer keeps track of this attribute
|
boolean |
includeTipMDSSession() |
boolean |
isCurrent() |
boolean |
isCustConfigTrimmed()
Deprecated.
|
boolean |
isSkipCheck() |
boolean |
isSkipSetIfUnchanged() |
static ADFSessionOptions |
loadFromXML(org.w3c.dom.Element el) |
void |
readXMLConfig(org.w3c.dom.Element el)
Copy parameter values from XML into this ADFSessionOptions instance.
|
void |
releaseLock() |
static boolean |
removeChangeListener(ADFSessOptsChangeListener listener) |
static void |
resetChangeListeners() |
boolean |
resetCustClassList(int coercionLevel)
Resets the CustomizationClass list (effects take place in session scope).
|
boolean |
setAuthoringSettings(ADFAuthoringSettings settings,
int coercionLevel) |
boolean |
setBaseLabel(java.lang.String baseLabel,
int coercionLevel) |
void |
setCustConfigNoCustomizations()
Deprecated.
|
boolean |
setCustomizationPolicy(oracle.mds.cust.CustomizationPolicy custPolicy,
int coercionLevel)
Set the CustomizationPolicy for the ADFSessionOptions instance
|
boolean |
setDefMode(java.lang.String defMode,
int coercionLevel) |
boolean |
setErrorHandlingMode(int m) |
boolean |
setIncludeTipMDSSession(boolean b,
int coercionLevel) |
boolean |
setIsolationLevel(oracle.mds.core.IsolationLevel iLevel,
int coercionLevel) |
java.lang.Object |
setMergeConflictResolver(java.lang.Object resolver)
Deprecated.
|
boolean |
setMode(ADFSessionOptions.Mode mode,
int coercionLevel)
Sets the Mode.
|
boolean |
setParam(java.lang.String paramName,
java.lang.Object paramValue,
int coercionLevel) |
boolean |
setParams(java.util.List<java.lang.String> paramNames,
java.util.List<java.lang.Object> paramValues,
int coercionLevel) |
boolean |
setSandboxName(java.lang.String sandboxName,
int coercionLevel)
Deprecated.
in 12.2.2 - Please use
setSandboxSettings(SandboxSettings,int)
or unsetSandboxSettings(int) instead. Do NOT use this method if you want to use ADFSessionOptions Modes
(setMode, setSandboxSettings). |
boolean |
setSandboxSettings(SandboxSettings sandboxSettings,
int coercionLevel)
Sets up ADFSessionOptions for a Sandbox environment.
|
boolean |
setSkipCheck(boolean b,
int coercionLevel) |
boolean |
setSkipSetIfUnchanged(boolean b,
int coercionLevel) |
boolean |
setTrimCustClasses(java.lang.String custClasses,
int coercionLevel)
Set the tip CustomizationClass (CC) in the ADFSessionOptions CustConfig (default namespace, "/").
|
boolean |
setValuesFrom(ADFSessionOptions fromSO,
int coercionLevel) |
boolean |
testSetParams(java.util.List<java.lang.String> paramNames,
java.util.List<java.lang.Object> paramValues)
Tests if setting the specified parameters will result in a change of the
current ADFSessionOptions.
|
java.io.ByteArrayOutputStream |
toByteArray() |
java.lang.String |
toString()
Returns string representation of ADFSessionOptions.
|
boolean |
trimCustClassListTo(java.lang.String custClassName,
int coercionLevel)
Trims CustomizationClass list to the specified custClassName in ADFSessionOptions (effects take place in session scope)
|
boolean |
trimCustClassListTo(java.lang.String custClassName,
java.lang.String custClassValue,
int coercionLevel)
Deprecated.
in 12.2.2 - This method will ignore the custClassValue parameter;
Use
trimCustClassListTo(String, int) . |
void |
unsetCustConfigNoCustomizations()
Deprecated.
|
boolean |
unsetSandboxSettings(int coercionLevel)
Resets ADFSessionOptions values to reflect an environment without a sandbox.
|
void |
verifyCurrentMDSSession()
Compares the settings in the current MDSSession against this
ADFSessionOptions.
|
static boolean |
verifyLabel(java.lang.String newLabel) |
org.w3c.dom.Element |
writeXMLConfig(oracle.xml.parser.v2.XMLDocument doc,
org.w3c.dom.Element elemParent)
Copy current attributes of the ADFSessionOptions into an XML Element object (for serialization).
|
public static final int CLEVEL_NO_CHECK
public static final int CLEVEL_FORCED
public static final int CLEVEL_CHECK_AND_CHANGE
public static final int CLEVEL_CHECK_ONLY
public static final int CLEVEL_CHECK_ONLY_INCL_WARNINGS
public static final java.lang.String PName_sboxname
public static final java.lang.String PName_clearCache
public static final java.lang.String PName_baseLabel
public static final java.lang.String PName_label
public static final java.lang.String PName_mdslabel
public static final java.lang.String PName_includeTipMDSSession
public static final java.lang.String PName_isolationLevel
public static final java.lang.String PName_skipCheck
public static final java.lang.String PName_canChangeCheck
public static final java.lang.String PName_custclasses
public static final java.lang.String PName_authoringSettings
public static final java.lang.String PName_custPolicy
public static final java.lang.String PName_mode
public static final java.lang.String PName_defMode
public static final java.lang.String LABEL_LATEST
public static final java.lang.String LABEL_MATCH
public static final java.lang.String LABEL_NONE
public static final java.lang.String LABEL_NOT_FOUND
public static final java.lang.String MDS_SANDBOX_METADATA_CUST_CLASS_NAME_KEY
public static final java.lang.String MDS_SANDBOX_METADATA_CUST_CLASS_VALUE_KEY
public static final int ERR_HANDLE_RETURN_ON_FIRST_ERR
public static final int ERR_HANDLE_COLLECT_ALL_ERRS
public static java.lang.String DEFAULT_RESOLVER_CLASS_NAME
public ADFSessionOptions()
public ADFSessionOptions(ADFSessionOptions org)
public void releaseLock() throws java.lang.IllegalMonitorStateException, java.lang.UnsupportedOperationException
java.lang.IllegalMonitorStateException
java.lang.UnsupportedOperationException
@Concealed @Deprecated public boolean isCustConfigTrimmed()
public int getEditRevNumber()
public int getErrorHandlingMode()
public boolean setErrorHandlingMode(int m)
public java.lang.Object getMergeConflictResolver()
public java.lang.Object setMergeConflictResolver(java.lang.Object resolver)
resolver
- public void clearCache(int coercionLevel)
coercionLevel
- - int (e.g., CLEVEL_FORCED,CLEVEL_CHECK_AND_CHANGE,CLEVEL_CHECK_ONLY,CLEVEL_CHECK_ONLY_INCL_WARNINGS)
Use CLEVEL_FORCED or CLEVEL_CHECK_AND_CHANGE for cleaning the cache.public static boolean addChangeListener(ADFSessOptsChangeListener listener)
public static boolean removeChangeListener(ADFSessOptsChangeListener listener)
public static void resetChangeListeners()
public boolean setValuesFrom(ADFSessionOptions fromSO, int coercionLevel)
public java.lang.String getSandboxName()
public void checkSessionOptionsChange(int coercionLevel)
public void finishSessionOptionsChange(int coercionLevel)
public boolean isCurrent()
public oracle.mds.naming.Namespace getSandboxNameSpace()
public ADFSessionOptions.Mode getMode()
ADFSessionOptions.Mode
for more details.public boolean setMode(ADFSessionOptions.Mode mode, int coercionLevel)
ADFSessionOptions.Mode
for more details.mode
- specific Mode to set;coercionLevel
- int representing how forced the change is (e.g., CLEVEL_CHECK_ONLY, CLEVEL_CHECK_AND_CHANGE).public boolean setSandboxSettings(SandboxSettings sandboxSettings, int coercionLevel)
sandboxSettings
- contains the Sandbox Settings to copy over to ADFSessionOptionscoercionLevel
- int representing how forced the change is (e.g., CLEVEL_CHECK_ONLY, CLEVEL_CHECK_AND_CHANGE).unsetSandboxSettings(int)
public boolean unsetSandboxSettings(int coercionLevel)
coercionLevel
- int representing how forced the change is (e.g., CLEVEL_CHECK_ONLY, CLEVEL_CHECK_AND_CHANGE).setSandboxSettings(SandboxSettings,int)
@Deprecated public boolean setSandboxName(java.lang.String sandboxName, int coercionLevel)
setSandboxSettings(SandboxSettings,int)
or unsetSandboxSettings(int)
instead. Do NOT use this method if you want to use ADFSessionOptions Modes
(setMode, setSandboxSettings).sandboxName
- String representing the sandbox name - must be the name of a valid sandbox.coercionLevel
- int representing how forced the change is (e.g., CLEVEL_CHECK_ONLY, CLEVEL_CHECK_AND_CHA
NGE).public java.lang.String getLabel()
public static java.lang.Object findLabels(java.lang.String matchString, boolean firstMatch, boolean latest)
public java.lang.String computeLabel(java.lang.String labelName)
public java.lang.String getBaseLabel()
public static boolean verifyLabel(java.lang.String newLabel)
public boolean setBaseLabel(java.lang.String baseLabel, int coercionLevel)
public boolean includeTipMDSSession()
public boolean setIncludeTipMDSSession(boolean b, int coercionLevel)
public oracle.mds.core.IsolationLevel getIsolationLevel()
public boolean setIsolationLevel(oracle.mds.core.IsolationLevel iLevel, int coercionLevel)
public static oracle.mds.core.IsolationLevel getIsolationLevelValue(java.lang.String s)
public boolean isSkipCheck()
public boolean setSkipCheck(boolean b, int coercionLevel)
public boolean isSkipSetIfUnchanged()
public boolean setSkipSetIfUnchanged(boolean b, int coercionLevel)
public static oracle.mds.config.CustConfig getMDSCustConfig()
public oracle.mds.cust.CustClassList getCustClassList()
public oracle.mds.config.CustConfig getCustConfig()
public oracle.mds.cust.CustomizationPolicy getCustomizationPolicy()
protected boolean doSeedMatch(ADFSOSeed seed)
protected boolean doTipCCsMatch(java.lang.String fromSeed, java.lang.String current)
protected boolean doSettingsMatch(SandboxSettings sbs)
public boolean setCustomizationPolicy(oracle.mds.cust.CustomizationPolicy custPolicy, int coercionLevel)
custPolicy
- - CustomizationPolicy object to setcoercionLevel
- - int (e.g., CLEVEL_CHECK_ONLY, CLEVEL_CHECK_AND_CHANGE)public java.lang.String getTrimCustClassListToClass()
@Deprecated public java.lang.String getTrimCustClassListToValue()
public boolean setTrimCustClasses(java.lang.String custClasses, int coercionLevel)
custClasses
- class name of the CC to be set as tip (if null, CC list is reset). If the CC value (e.g., "site")
is present in parentheses, it will be removed from the string before setting the tip.coercionLevel
- int (e.g., CLEVEL_CHECK_ONLY, CLEVEL_CHECK_AND_CHANGE) indicating whether to force any changestrimCustClassListTo(String,int)
,
resetCustClassList(int)
public boolean resetCustClassList(int coercionLevel)
coercionLevel
- int representing whether to force this change or not (e.g., CLEVEL_CHECK_ONLY, CLEVEL_CHECK_AND_CHANGE)@Deprecated public boolean trimCustClassListTo(java.lang.String custClassName, java.lang.String custClassValue, int coercionLevel)
trimCustClassListTo(String, int)
.custClassName
- String representing full class name of the CustomizationClass;custClassValue
- currently ignored, see deprecated warning;coercionLevel
- int representing whether to force this change or not (e.g., CLEVEL_CHECK_ONLY, CLEVEL_CHECK_AND_CHANGE).public boolean trimCustClassListTo(java.lang.String custClassName, int coercionLevel)
custClassName
- String representing full class name of the CustomizationClasscoercionLevel
- int representing whether to force this change or not (e.g., CLEVEL_CHECK_ONLY, CLEVEL_CHECK_AND_CHANGE)public ADFAuthoringSettings getAuthoringSettings()
public boolean setAuthoringSettings(ADFAuthoringSettings settings, int coercionLevel)
public boolean setParams(java.util.List<java.lang.String> paramNames, java.util.List<java.lang.Object> paramValues, int coercionLevel)
public boolean setParam(java.lang.String paramName, java.lang.Object paramValue, int coercionLevel)
public static ADFSessionOptions loadFromXML(org.w3c.dom.Element el)
public void readXMLConfig(org.w3c.dom.Element el)
el
- XML object containing ADFSessionOptions attributes to be set.public org.w3c.dom.Element writeXMLConfig(oracle.xml.parser.v2.XMLDocument doc, org.w3c.dom.Element elemParent)
doc
- XMLDocument which will contain the ADFSessionOptions XML String (used to find XML Namespace details)elemParent
- Element in which to include the ADFSessionOptions XML (as a child).public static ADFSessionOptions fromString(java.lang.String str)
str
- input String to be converted into an ADFSessionOptions object (should be a parsable XML tag
with a valid ADFSessionOptions configuration).public java.io.ByteArrayOutputStream toByteArray()
@Deprecated @Concealed public void setCustConfigNoCustomizations()
@Deprecated @Concealed public void unsetCustConfigNoCustomizations()
public boolean testSetParams(java.util.List<java.lang.String> paramNames, java.util.List<java.lang.Object> paramValues)
setParams(List, List, int)
with CLEVEL_CHECK_ONLY
,
which invokes the listeners and returns false
at the end
because no changes are made.paramNames
- a list of parameter namesparamValues
- a list of corresponding parameter valuestrue
if the given parameters are different than the
settings in this ADFSessionOptions, false
if they are the
same.public void verifyCurrentMDSSession()
ADFShareException
- if the sandbox, label, or trim CC name does not
match.public java.lang.String toString()
toString
in class java.lang.Object
public boolean setDefMode(java.lang.String defMode, int coercionLevel)
public java.lang.String getDefMode()