public abstract class RemoteRegionModel extends RegionModel implements RemoteRegionListener
RemoteRegionListener
RegionModel.RegionAction
REMOTE_REGION_ATTRIB
Constructor and Description |
---|
RemoteRegionModel() |
Modifier and Type | Method and Description |
---|---|
protected void |
addRegionClientId(String clientId, boolean isNew)
Called whenever a clientId is added to the RegionComponentClientId set.
|
abstract void |
afterRequest(RemoteApplicationResponse resp, Map<String,Object> stateMap)
Executed after the request to the remote region.
|
abstract void |
beforeRequest(RemoteApplicationRequest req, Map<String,Object> stateMap)
Executed before the request to the remote region.
|
void |
clearRemoteApplicationInstance()
Removes the stored
RemoteApplicationInstance from the model. |
String |
getBootstrap()
Return bootstrap
|
RemoteApplicationInstance |
getRemoteApplicationInstance()
Returns the current RemoteApplicationInstance.
|
abstract ConcurrentHashMap<String,Serializable> |
getRemoteAttributeMap()
Returns a map that may be used for persisted storage.
|
abstract 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.
|
protected void |
removeRegionClientId(String clientId)
Called whenever a clientId is removed from the RegionComponentClientId set.
|
void |
setRemoteApplicationInstance(RemoteApplicationInstance instance)
Sets the current RemoteApplicationInstance.
|
getActions, getCapabilities, getRegionComponentClientIds, getRegionModelListener, getUncommittedDataWarning, getViewHandle, getViewId, isDataDirty, markRegionDirty, processBeginRegion, processBeginRegion, processEndRegion, processEndRegion, refresh, release, setRegionModelListener
public abstract void beforeRequest(RemoteApplicationRequest req, Map<String,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, Map<String,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 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 ConcurrentHashMap<String,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 String getBootstrap()
protected void queueRefreshEvent()
protected void addRegionClientId(String clientId, boolean isNew)
RegionModel
addRegionClientId
in class RegionModel
protected void removeRegionClientId(String clientId)
RegionModel
removeRegionClientId
in class RegionModel