pub.cache:get
WmPublic. Retrieves the value of a cached element for the specified key.
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 retrieve the element. This parameter is case sensitive. |
key | Object Key associated with the cached value. |
useLoader | String Optional. Indicates whether to use a cache loader to retrieve the element from the cache. Set to: true to use a cache loader to retrieve the element if it is not already in the cache. Note: | If useLoader is true and no loaders are configured for the cache, Integration Server issues a ServiceException. |
false to retrieve the element from the cache without a cache loader. This is the default setting. |
Output Parameters
value | Object Value of the element retrieved from the cache. |
Usage Notes
If useLoader is set to false and pub.cache:get finds the key in the cache, the results contain the value of the element. If the key does not exist in the cache, pub.cache:get returns a null in the value parameter.
If useLoader is set to true and pub.cache:get cannot find the specified key in the cache, it uses the configured cache loader to find the key in the system-of-record (SOR). If the SOR contains the key, pub.cache:get returns the value of the element. If the key does not exist in the SOR, pub.cache:get returns a null in the value parameter.
The pub.cache:get service returns a null in the value parameter if:
![*](bullet.gif)
You run the service on a disabled cache.
![*](bullet.gif)
The service cannot find the specified key.
![*](bullet.gif)
The element associated with the specified key is expired.
Integration Server issues a ServiceException in the following cases:
![*](bullet.gif)
If
useLoader is
true and no loaders are configured for the cache.
![*](bullet.gif)
If you do not specify all required input parameters.
![*](bullet.gif)
If
Integration Server cannot find the specified cache manager or cache.
![*](bullet.gif)
If a cache operation fails.