|
Oracle© Fusion Middleware Java API Reference for Oracle ADF Faces 11g Release 1 (11.1.1.7.0) E10684-08 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object
oracle.adf.view.rich.model.RegionModel
oracle.adf.view.rich.model.RemoteRegionModel
public abstract class RemoteRegionModel
Model for a remote Region Component. This model provides extensions that are needed to allow the Region to make a connection to another server. This version of the RegionModel also implements the contract for the RemoteRegionListener. The contract for this listener is the same as for the standard RemoteRegionListener except that the models beforeRequest is guarenteed to be executed before any other listener and it's endRequest is guarenteed to be executed after any other listener and no registration of the listener is necessary.
RemoteRegionListener
Nested Class Summary |
---|
Nested classes/interfaces inherited from class oracle.adf.view.rich.model.RegionModel |
---|
RegionModel.RegionAction |
Constructor Summary | |
---|---|
RemoteRegionModel() |
Method Summary | |
---|---|
abstract void |
afterRequest(RemoteApplicationResponse resp, java.util.Map<java.lang.String,java.lang.Object> stateMap) Executed after the request to the remote region. |
abstract void |
beforeRequest(RemoteApplicationRequest req, java.util.Map<java.lang.String,java.lang.Object> stateMap) Executed before the request to the remote region. |
void |
clearRemoteApplicationInstance() Removes the stored RemoteApplicationInstance from the model. |
java.lang.String |
getBootstrap() Return bootstrap |
RemoteApplicationInstance |
getRemoteApplicationInstance() Returns the current RemoteApplicationInstance. |
abstract java.util.concurrent.ConcurrentHashMap<java.lang.String,java.io.Serializable> |
getRemoteAttributeMap() Returns a map that may be used for persisted storage. |
abstract java.net.URI |
getURI() Returns the URI for the remote application context. |
boolean |
isActive() Allows the model to prevent a remote application call from being made. |
boolean |
isAuthorizationRequired() Returns whether or not an authorization token should be provided on the first request. |
boolean |
isRemoteApplicationInstancePresent() Tells whether there is a RemoteApplicationInstance stored in this model |
protected void |
queueRefreshEvent() Queues a RegionRefreshEvent on all of the components which are represented by this RemoteRegionModel instance. |
void |
setRemoteApplicationInstance(RemoteApplicationInstance instance) Sets the current RemoteApplicationInstance. |
Methods inherited from class oracle.adf.view.rich.model.RegionModel |
---|
getActions, getCapabilities, getRegionComponentClientIds, getViewId, markRegionDirty, processBeginRegion, processBeginRegion, processEndRegion, processEndRegion, refresh |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public RemoteRegionModel()
Method Detail |
---|
public abstract void beforeRequest(RemoteApplicationRequest req, java.util.Map<java.lang.String,java.lang.Object> stateMap)
beforeRequest
in interface RemoteRegionListener
req
- the Response from the remote serverstateMap
- a of string keys and object values that provides temporary storage between the begin and the beforeRequest and afterRequest methods.RemoteRegionListener
public abstract void afterRequest(RemoteApplicationResponse resp, java.util.Map<java.lang.String,java.lang.Object> stateMap)
afterRequest
in interface RemoteRegionListener
resp
- the Response from the remote serverstateMap
- a of string keys and object values that provides temporary storage between the begin and the beforeRequest and afterRequest methods.RemoteRegionListener
public abstract java.net.URI getURI()
public boolean isAuthorizationRequired()
true
if authorization should be sent on the first call to the producer and false
if the normal challenge/response should be used.public boolean isActive()
false
if the remote connection is not needed or true
if it is.public abstract java.util.concurrent.ConcurrentHashMap<java.lang.String,java.io.Serializable> getRemoteAttributeMap()
It is important to not that this map has two requirements. First is must be thread-safe and second is it must be serializable. As such, the ConcurrentHashMap is returned from this method rather then a more generic type.
ConcurrentHashMap
containing the modules statepublic void setRemoteApplicationInstance(RemoteApplicationInstance instance)
null
then it should be the same as unsetting the instance value such that calls to getRemoteApplicationInstance()
return null
. This method will change both the persisted RemoteApplicationInstance as well as the locally stored instance.instance
- the RemoteApplicationInstance for this region or null
NullPointerException
- if the provided application instance is null
public void clearRemoteApplicationInstance()
RemoteApplicationInstance
from the model.public RemoteApplicationInstance getRemoteApplicationInstance()
setRemoteApplicationInstance(RemoteApplicationInstance)
will change the locally stored copy.RemoteApplicationInstance
or null
if one has not been stored.public boolean isRemoteApplicationInstancePresent()
public java.lang.String getBootstrap()
protected void queueRefreshEvent()
|
Oracle© Fusion Middleware Java API Reference for Oracle ADF Faces 11g Release 1 (11.1.1.7.0) E10684-08 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |