WmPublic. Replaces the cached element value with the supplied value.
Input Parameters
cacheManagerName String Name of the cache manager that manages the cache. This
parameter is case sensitive.
cacheName String Name of the cache from which to remove the element. This
parameter is case sensitive.
key Object Key of the element to remove.
value Object Value of the element to remove.
removed String Indicates whether the service removed the element.
true indicates that the element was removed from the cache.
false indicates that the element was not removed from the
cache. The service returns false if the specified key and value do not exist in the cache.
cacheManagerName String Name of the cache manager that manages the cache. This
parameter is case sensitive.
cacheName String Name of the cache that contains the value you want to
replace. This parameter is case sensitive.
key Object Key of the cache element whose value you want to
replace.
2 Cache Folder
Output Parameters
Usage Notes
The pub.cache.atomic:replace service replaces an element in the cache only if an element with the values of the specified key and oldValue parameters already exist in the cache. If an element exist in the cache with the specified key and oldValue, pub.cache.atomic:replace replaces the cached element with the specified key and newValue.
Integration Server issues a ServiceException in the following cases:
If you do not specify all required input parameters.
If Integration Server cannot find the specified cache manager or cache.
If a cache operation fails.
pub.cache.atomic:replaceIfKeyExists
WmPublic. Replaces the cached element if an element for the specified key exists in a cache.
Input Parameters
newValue Object Value with which to replace the value of the cached
element.
replaced String Indicates whether the service replaced oldValue with newValue in the cache.
true indicates that the value was replaced in the cache.
false indicates that the value was not replaced in the cache.
cacheManagerName String Name of the cache manager that manages the cache. This
parameter is case sensitive.
cacheName String Name of the cache that contains the key. This parameter is
case sensitive.
key Object Key of the element whose value you want to replace.
value Object Value with which to replace the value of the cached
2 Cache Folder
Output Parameters
Usage Notes
The pub.cache.atomic:replaceIfKeyExists service replaces an element in the cache only if the specified key already exists in the cache. If an element with the specified key exists, pub.cache.atomic:replaceIfKeyExists replaces value of the cached element with the one specified in value.
Integration Server issues a ServiceException in the following cases:
If you do not specify all required input parameters.
If Integration Server cannot find the specified cache manager or cache.
If a cache operation fails.
pub.cache.bulk:isClusterBulkLoadEnabled
WmPublic. Checks whether the cache on at least one Integration Server node in the Terracotta Server Array cluster is enabled for bulk loading.
Input Parameters
Output Parameters
keyExists String Indicates whether the element with the passed key exists
in the cache.
true indicates that the element with the key already exists in the cache.
false indicates that the element with the key does not exist
in the cache.
oldValue Object Conditional. Value of the element the service replaced
with value. Returned only if keyExists is true.
cacheManagerName String Name of the cache manager that manages the cache. This
parameter is case sensitive.
cacheName String Name of the cache to check for bulk loading. This
parameter is case sensitive.
enabled String Indicates whether the cache on at least one Integration
Server node of the Terracotta Server Array cluster is in bulk-load mode.
true indicates that at least one node is in bulk-load mode.
2 Cache Folder
Usage Notes
The pub.cache.bulk:isClusterBulkLoadEnabled service applies only to distributed caches. If you run pub.cache.bulk:isClusterBulkLoadEnabled on a local cache, the service returns false for
enabled.
Integration Server issues a ServiceException in the following cases:
If you do not specify all required input parameters.
If Integration Server cannot find the specified cache manager or cache.
If a cache operation fails.
pub.cache.bulk:isNodeBulkLoadEnabled
WmPublic. Checks whether the cache of the current Integration Server node in the Terracotta Server Array cluster is bulk-load enabled.
Input Parameters
Output Parameters
Usage Notes
The pub.cache.bulk:isNodeBulkLoadEnabled service applies only to distributed caches. Integration Server issues a ServiceException in the following cases:
If you do not specify all required input parameters.
If Integration Server cannot find the specified cache manager or cache.
If a cache operation fails.
cacheManagerName String Name of the cache manager that manages the cache. This
parameter is case sensitive.
cacheName String Name of the distributed cache to check for bulk loading.
This parameter is case sensitive.
enabled String Indicates whether the cache is enabled for bulk loading.
true indicates that the Integration Server node calling the service is the same one that enabled bulk-loading.
false indicates one of the following:
The Integration Server node calling the service was not the same node that enabled bulk loading.
2 Cache Folder
pub.cache.bulk:setNodeBulkLoadEnabled
WmPublic. Enables or disables bulk loading mode in the current Integration Server node for the cache.
Input Parameters
Output Parameters
None.
Usage Notes
The pub.cache.bulk:setNodeBulkLoadEnabled service applies only to distributed caches. The pub.cache.bulk:setNodeBulkLoadEnabled service does nothing if you:
Try to enable bulk loading (bulkMode set to true) when the node is already in bulk- load mode.
Try to disable bulk loading (bulkMode set to false) when the node is not already in bulk-load mode.
Integration Server issues a ServiceException in the following cases:
If you do not specify all required input parameters.
If Integration Server cannot find the specified cache manager or cache.
If a cache operation fails.
cacheManagerName String Name of the cache manager that manages the cache. This
parameter is case sensitive.
cacheName String Name of the cache on which to enable or disable bulk
loading. This parameter is case sensitive.
bulkMode String Indicates whether to enable the bulk-load mode for the
cache. Set to:
true to enable the bulk-load mode. This is the default.
2 Cache Folder
pub.cache.bulk:waitUntilClusterBulkLoadComplete
WmPublic. Indicates whether Integration Server delays execution of the next step in a flow service until all of the Integration Server nodes in the Terracotta Server Array cluster disable bulk loading for the cache.
Input Parameters
Output Parameters
None.
Usage Notes
The pub.cache.bulk:waitUntilClusterBulkLoadComplete service applies only to distributed caches. If none of the nodes are bulk-load enabled, Integration Server immediately executes the next step in the flow service without waiting.
Integration Server issues a ServiceException in the following cases:
If you do not specify all required input parameters.
If Integration Server cannot find the specified cache manager or cache.
If a cache operation fails.