|
Oracle Fusion Middleware Java API Reference for Oracle ADF Model 11g Release 1 (11.1.1.7.0) E10653-08 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectoracle.adf.model.BindingContext
public class BindingContext
Nested Class Summary |
---|
Nested classes/interfaces inherited from interface java.util.Map |
---|
java.util.Map.Entry<K,V> |
Field Summary | |
---|---|
static java.lang.String |
ADF_CONTEXT
|
static java.lang.String |
APPLICATION_DEF
|
static java.lang.String |
BINDINGS_HELPER
|
static byte |
CLIENT_TYPE_ABSTRACT
|
static byte |
CLIENT_TYPE_JCLIENT
|
static java.lang.String |
CONTEXT_HELPER
|
static java.lang.String |
CONTEXT_ID
|
static java.lang.String |
CURRENT_DATACONTROL_FRAME
|
static java.lang.String |
CUSTOM_EVENT_DISPATCHER_CLASSNAME
|
static java.lang.String |
DEFAULT_DATA_CONTROL
|
static java.lang.String |
ERROR_HANDLER
|
static java.lang.String |
HTTP_REQUEST
|
static java.lang.String |
HTTP_RESPONSE
|
static java.lang.String |
INPUT_VALUE_HANDLERS
|
static java.lang.String |
IS_INITIALIZED
|
static java.lang.String |
LOCALE_CONTEXT
|
static java.lang.String |
MAP_RESOLVER
|
static java.lang.String |
PERMISSION_MAP
|
static java.lang.String |
RESERVED_BINDINGS
|
static java.lang.String |
ROOT_FRAME_NAME
|
Constructor Summary | |
---|---|
BindingContext()
|
|
BindingContext(int size)
|
Method Summary | |
---|---|
void |
addPersistentState(java.lang.String name,
java.io.Serializable psState)
Deprecated. since 10.1.3. Applications should use the StateManager instead. See StateManager |
void |
addPersPageMapEntry(java.lang.String sPath,
java.lang.String sUsageId)
|
void |
beginRequest(oracle.adf.share.ADFContext adfContext,
java.util.HashMap requestCtx)
|
DataControlFrame |
beginTransaction(java.lang.String name,
java.util.List<DataControlPolicy> policies,
DataControlPolicy defaultPolicy)
Creates a new datacontrol frame with the given name if it does not exist, and begins a new transaction. |
java.util.Collection<DCBindingContainer> |
bindingContainers()
|
java.util.Iterator |
bindingContainersIterator()
|
java.lang.String |
cachePageMapPath(java.lang.String path,
java.lang.String id)
Only PageMap implementations should call this method for page paths they want to cache in the session based BindingContext, so individual app defs will not need to be consulted repeatedly for unchanging mappings. |
void |
clear()
|
boolean |
containsBindingContainerKey(java.lang.Object key)
INTERNAL USE ONLY. |
boolean |
containsKey(java.lang.Object key)
|
boolean |
containsValue(java.lang.Object value)
|
DataControlFrame |
createDataControlFrame(java.lang.String name,
DataControlFrame parentFrame,
java.util.List<DataControlPolicy> policies,
DataControlPolicy defaultPolicy)
Creates a datacontrol frame with the given name. |
DataControlFrame |
createDataControlFrame(java.lang.String name,
java.util.List<DataControlPolicy> policies,
DataControlPolicy defaultPolicy)
Deprecated. since 11.1.1.0.0 |
java.io.Serializable |
createSnapshot()
Internal use only. |
DataControlFrame |
dataControlFrame()
|
void |
dataControlFrameReleased(DataControlFrame frame)
Callback method from datacontrol frame to notify the bindingcontext that it has been released. |
java.util.Iterator |
dataControlsIterator()
|
void |
endRequest(oracle.adf.share.ADFContext adfContext,
java.util.HashMap requestCtx)
|
java.util.Set |
entrySet()
Returns the Entry Set for the properties that have been registered with BindingContext. |
java.lang.String |
findAppDefNameByBindingContainerDefName(java.lang.String fullDefName)
|
DCBindingContainer |
findBindingContainer(java.lang.String name)
|
DCBindingContainer |
findBindingContainerByPath(java.lang.String path)
Given the view path, find a mapping entry in this BindingContext's pageMap definition and return a bindingContainer whose usage name maps the value of the mapped entry. |
DCBindingContainerDef |
findBindingContainerDefByPath(java.lang.String path)
Given the view path, find a mapping entry in this BindingContext's pageMap definition and return it's definition. |
java.lang.String |
findBindingContainerIdByPath(java.lang.String path)
Given the view path, find a mapping entry in this BindingContext's pageMap definition and return the mapped value which should be a bindingContainer ID that can be used to lookup a bindingContainer instance in this BindingContext. |
DCDataControl |
findDataControl(java.lang.String name)
|
DCDataControl |
findDataControlForScripting(java.lang.String dataControlReferenceId)
Deprecated. |
DataControlFrame |
findDataControlFrame(java.lang.String name)
Returns a datacontrol frame with the given name. |
java.io.Serializable |
findPersistentState(java.lang.String name)
Deprecated. since 10.1.3. Applications should use the StateManager instead. See StateManager |
java.lang.Object |
get(java.lang.Object key)
|
java.lang.Object |
getBindingInputHandler(java.lang.String type)
|
static BindingContext |
getCurrent()
Returns the BindingContext instance for the invoking session. |
java.lang.String |
getCurrentAppDefName()
Deprecated. since 11.1.1.6.0 For internal framework use only |
BindingContainer |
getCurrentBindingsEntry()
Returns the current BindingContainer for the execution context. |
java.lang.String |
getCurrentDataControlFrame()
return the current datacontrol frame of this BindingContext |
static java.lang.String |
getDCNameFromDCKey(java.lang.String dcKey)
|
DefinitionObject |
getDef()
|
DCDataControl |
getDefaultDataControl()
Internal: Applications should not use this class. Only for use in JClient internally to get to JUApplication. |
DCErrorHandler |
getErrorHandler()
|
LocaleContext |
getLocaleContext()
|
long |
getLockTimeout()
|
java.lang.Object |
getPersonalizationKey()
|
SessionContext |
getSessionContext()
|
java.util.concurrent.locks.ReentrantLock |
getSyncLock()
|
static java.lang.String |
getTransformedDCKey(DCDataControl dc)
Internal Framework implementation: do not use |
void |
initialize(java.lang.String defName)
|
void |
initializeSessionContext(SessionContext currentSession)
Internal: Applications should not use this class. |
DCDataControl |
instantiateDataControl(DataControlFrame frame,
java.lang.String dcKey,
java.lang.String transactionName)
For use by datacontrol frame to instantiate a new datacontrol, using the DataControlReference found in the BindingContext location passed. |
java.lang.Object |
internalGet(java.lang.Object key)
Internal: Applications should not use this class. Returns BindingContext entries without transitioning references. |
boolean |
isEmpty()
|
boolean |
isGenericApp()
|
boolean |
isJClientApp()
Internal: Applications should not use this class. |
java.util.Set |
keySet()
Returns the keys of all properties, BindingContainers, and DataControls that have been put in the BindingContext. |
java.util.Iterator |
keysIterator()
Returns a thread safe keys iterator. |
java.lang.Object |
put(java.lang.Object key,
java.lang.Object value)
|
void |
putAll(java.util.Map t)
|
void |
refreshAfterMetadataChanges(DCBindingContainer bindings)
Refresh the binding context and binding containers after the metadata has changed |
void |
release()
|
void |
releaseObsoleteBindingContainers()
Release any BindingContainers that have been updated by MDS |
java.lang.Object |
remove(java.lang.Object key)
|
java.lang.Object |
removeDataControl(java.lang.String dcUsageName,
java.lang.String dcKey)
|
void |
removePersistentState(java.lang.String name)
Deprecated. since 10.1.3. Applications should use the StateManager instead. See StateManager |
void |
removeSnapshot(java.io.Serializable handle)
Internal use only. |
void |
restoreSnapshot(java.io.Serializable handle)
Internal use only. |
boolean |
resumeTransaction(java.lang.String name)
Resume the transaction associated with the datacontrol frame with the given name, and set that datacontrol frame as the current frame. |
static java.lang.String |
setAppDefNameTL(java.lang.String appDefName)
framework internal use only |
void |
setBindingInputHandlers(java.util.Map map)
|
void |
setClientAppType(byte clientType)
Internal: Applications should not use this class. |
static void |
setCurrent(BindingContext ctx)
Internal: Applications should not use this method. ADFm uses this internally to add the current BindingContext to the sessionScope of the executing thread. |
protected void |
setCurrent(boolean force)
|
BindingContainer |
setCurrentBindingsEntry(BindingContainer bindings)
Sets the current BindingContainer for the execution context. |
BindingContainer |
setCurrentBindingsEntry(BindingContainer bindings,
java.util.Map map)
Sets the current BindingContainer for the execution context. |
boolean |
setCurrentDataControlFrame(java.lang.String name)
Set the datacontrol frame with the given name as the current datacontrol frame in the BindingContext. |
DataControlFrame |
setCurrentFrameInternal(DataControlFrame frame)
|
void |
setErrorHandler(DCErrorHandler errHandlerObj)
|
void |
setLocaleContext(LocaleContext lCtx)
|
void |
setLockTimeout(long lockTimeout)
|
void |
setPersonalizationKey(java.lang.Object key)
|
void |
setSessionContext(SessionContext currentSession)
Internal: Applications should not use this class. |
int |
size()
|
void |
syncPageMapEntry(java.lang.String path,
java.lang.String pageDefId,
java.lang.String pageDefFullName)
Internal: Applications should not use this class. |
void |
touch()
Internal: Applications should not use this method. Used to notify a container that the BindingContext needs to be replicated. |
static java.lang.String |
transformDCKey(java.lang.String appDefName,
java.lang.String dcName)
Framework internal: applications should not use |
java.util.Collection |
values()
Return values for the properties, DataControls, and BindingContainers that have already been instantiated within the invoking context. |
java.util.Iterator |
valuesIterator()
Returns a thread safe values iterator. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface java.util.Map |
---|
equals, hashCode |
Field Detail |
---|
public static final java.lang.String RESERVED_BINDINGS
public static final java.lang.String CONTEXT_HELPER
public static final java.lang.String BINDINGS_HELPER
public static final java.lang.String CONTEXT_ID
public static final java.lang.String DEFAULT_DATA_CONTROL
public static final java.lang.String LOCALE_CONTEXT
public static final java.lang.String ERROR_HANDLER
public static final java.lang.String MAP_RESOLVER
public static final java.lang.String ADF_CONTEXT
public static final java.lang.String HTTP_REQUEST
public static final java.lang.String HTTP_RESPONSE
public static final java.lang.String INPUT_VALUE_HANDLERS
public static final java.lang.String APPLICATION_DEF
public static final java.lang.String IS_INITIALIZED
public static final java.lang.String CURRENT_DATACONTROL_FRAME
public static final java.lang.String ROOT_FRAME_NAME
public static final java.lang.String CUSTOM_EVENT_DISPATCHER_CLASSNAME
public static final byte CLIENT_TYPE_ABSTRACT
public static final byte CLIENT_TYPE_JCLIENT
public static final java.lang.String PERMISSION_MAP
Constructor Detail |
---|
public BindingContext(int size)
public BindingContext()
Method Detail |
---|
public static BindingContext getCurrent()
public static void setCurrent(BindingContext ctx)
protected void setCurrent(boolean force)
public void touch()
public final java.util.concurrent.locks.ReentrantLock getSyncLock()
public void setLockTimeout(long lockTimeout)
public long getLockTimeout()
public final void setPersonalizationKey(java.lang.Object key)
public final java.lang.Object getPersonalizationKey()
public DefinitionObject getDef()
public void initialize(java.lang.String defName)
public void setLocaleContext(LocaleContext lCtx)
public LocaleContext getLocaleContext()
public void setErrorHandler(DCErrorHandler errHandlerObj)
public void setClientAppType(byte clientType)
public boolean isJClientApp()
public boolean isGenericApp()
public final DCErrorHandler getErrorHandler()
public final BindingContainer getCurrentBindingsEntry()
public final BindingContainer setCurrentBindingsEntry(BindingContainer bindings)
bindings
- the BindingContainer to be set
public final BindingContainer setCurrentBindingsEntry(BindingContainer bindings, java.util.Map map)
bindings
- the BindingContainer to be setmap
- the context on which to set the BindingContainer
public DCDataControl getDefaultDataControl()
public void initializeSessionContext(SessionContext currentSession)
public void setSessionContext(SessionContext currentSession)
public SessionContext getSessionContext()
public void release()
public java.io.Serializable createSnapshot()
removeSnapshot(java.io.Serializable)
once the snapshot is no longer needed. Not
invoking removeSnapshot will result in an accumulation of snapshots
in the durable snapshot store.
Applications should not invoke this directly. Instead,
applications should use ADFc TaskFlows to declaratively work with
snapshots.
public void restoreSnapshot(java.io.Serializable handle)
createSnapshot()
. After restore the BindingContext state
will be equivalent to the state when createSnapshot was invoked.
Applications should not invoke this directly. Instead,
applications should use ADFc TaskFlows to declaratively work with
snapshots.
handle
- public void removeSnapshot(java.io.Serializable handle)
createSnapshot()
.
Applications should not invoke this directly. Instead,
applications should use ADFc TaskFlows to declaratively work with
snapshots.
handle
- public static java.lang.String setAppDefNameTL(java.lang.String appDefName)
appDefName
- public DCDataControl findDataControl(java.lang.String name)
public DCDataControl findDataControlForScripting(java.lang.String dataControlReferenceId)
dataControlReferenceId
-
public DCBindingContainer findBindingContainer(java.lang.String name)
public java.io.Serializable findPersistentState(java.lang.String name)
StateManager
public void addPersistentState(java.lang.String name, java.io.Serializable psState)
StateManager
public void removePersistentState(java.lang.String name)
StateManager
public java.util.Iterator valuesIterator()
This iterator will not include the DataControls or BindingContainers. Must use dataControlIterator or bindingContainersIterator to iterate those members.
public java.util.Iterator dataControlsIterator()
public java.util.Iterator bindingContainersIterator()
public java.util.Iterator keysIterator()
This iterator will not include the DataControls or BindingContainers.
public int size()
size
in interface java.util.Map
public boolean isEmpty()
isEmpty
in interface java.util.Map
public boolean containsKey(java.lang.Object key)
containsKey
in interface java.util.Map
public boolean containsBindingContainerKey(java.lang.Object key)
public boolean containsValue(java.lang.Object value)
containsValue
in interface java.util.Map
public DCDataControl instantiateDataControl(DataControlFrame frame, java.lang.String dcKey, java.lang.String transactionName)
dcKey
- The location where the DataControlReference should be located
in the BindingContext. If found, use it to create a
datacontrol instance.transactionName
- optionally provide a transaction name to be used
by the datacontrol for it to create a parent datacontrol with
that name.
public java.lang.Object get(java.lang.Object key)
get
in interface java.util.Map
public final java.util.Collection<DCBindingContainer> bindingContainers()
public java.lang.Object internalGet(java.lang.Object key)
public java.lang.Object put(java.lang.Object key, java.lang.Object value)
put
in interface java.util.Map
public java.lang.Object remove(java.lang.Object key)
remove
in interface java.util.Map
public java.lang.Object removeDataControl(java.lang.String dcUsageName, java.lang.String dcKey)
public void putAll(java.util.Map t)
putAll
in interface java.util.Map
public void clear()
clear
in interface java.util.Map
public java.util.Set keySet()
Applications should use this method sparingly as the implementation must aggregate the keys from the DataControl map, the BindingContainer map, and the property map.
Note that the BindingContainer and DataControl keys in the keySet may refer to uninstantiated BindingContainer and DataControl references.
keySet
in interface java.util.Map
public java.util.Collection values()
size()
.
Applications should not use this method. The implementation is very expensive because it requires the framework to aggregate the values from the mDCMap, the BindingContainer map, and the mDefaultMap. Further, the keySet(), values(), and entrySet() implementations are not consistent with one another.
values
in interface java.util.Map
public java.util.Set entrySet()
entrySet
in interface java.util.Map
public java.lang.Object getBindingInputHandler(java.lang.String type)
public void setBindingInputHandlers(java.util.Map map)
public DCBindingContainer findBindingContainerByPath(java.lang.String path)
public java.lang.String findAppDefNameByBindingContainerDefName(java.lang.String fullDefName)
public DCBindingContainerDef findBindingContainerDefByPath(java.lang.String path)
public java.lang.String findBindingContainerIdByPath(java.lang.String path)
public java.lang.String cachePageMapPath(java.lang.String path, java.lang.String id)
path
- the page path (ex: /app1/view/page1.jspx)id
- the usage id (ex: app1_view_page1PageDef)
public void beginRequest(oracle.adf.share.ADFContext adfContext, java.util.HashMap requestCtx)
public void refreshAfterMetadataChanges(DCBindingContainer bindings)
public void releaseObsoleteBindingContainers()
public void endRequest(oracle.adf.share.ADFContext adfContext, java.util.HashMap requestCtx)
public DataControlFrame createDataControlFrame(java.lang.String name, java.util.List<DataControlPolicy> policies, DataControlPolicy defaultPolicy)
public DataControlFrame createDataControlFrame(java.lang.String name, DataControlFrame parentFrame, java.util.List<DataControlPolicy> policies, DataControlPolicy defaultPolicy)
name
- Name of the new datacontrol frame.policies
- An optional list of DataControlPolicy objects for
datacontrols that have different policies than the
default policy.defaultPolicy
- The default DataControlPolicy for all datacontrols
in this datacontrol frame.
public DataControlFrame findDataControlFrame(java.lang.String name)
name
- Name of the datacontrol frame.
public boolean setCurrentDataControlFrame(java.lang.String name)
name
- Name of the datacontrol frame to be set as the current frame.
public void dataControlFrameReleased(DataControlFrame frame)
frame
- the datacontrol frame that is released.public final DataControlFrame dataControlFrame()
public DataControlFrame setCurrentFrameInternal(DataControlFrame frame)
public java.lang.String getCurrentDataControlFrame()
public DataControlFrame beginTransaction(java.lang.String name, java.util.List<DataControlPolicy> policies, DataControlPolicy defaultPolicy)
name
- Name of the datacontrol frame that should starts a new
transactionpolicies
- An optional list of DataControlPolicy objects for
datacontrols that have different policies than the
default policy.defaultPolicy
- The default DataControlPolicy for all datacontrols
in this datacontrol frame.
public boolean resumeTransaction(java.lang.String name)
name
- Name of the datacontrol frame whose transaction should be
resumed.
public void syncPageMapEntry(java.lang.String path, java.lang.String pageDefId, java.lang.String pageDefFullName)
public void addPersPageMapEntry(java.lang.String sPath, java.lang.String sUsageId)
public java.lang.String getCurrentAppDefName()
public static final java.lang.String getTransformedDCKey(DCDataControl dc)
public static final java.lang.String transformDCKey(java.lang.String appDefName, java.lang.String dcName)
appDefName
- dcName
-
public static final java.lang.String getDCNameFromDCKey(java.lang.String dcKey)
|
Oracle Fusion Middleware Java API Reference for Oracle ADF Model 11g Release 1 (11.1.1.7.0) E10653-08 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |