Integration Server 10.11 | Built-In Services Reference Guide | Cache Folder | Summary of Elements in this Folder | pub.cache:getKeys
 
pub.cache:getKeys
WmPublic. Retrieves the keys of all elements available in the cache.
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 keys. This parameter is case sensitive.
excludeExpiredKeys
String Optional. Indicates whether the service results exclude keys for expired elements. Set to:
*true to exclude the keys of expired elements. This is the default.
*false to include the keys of all elements.
Output Parameters
keys
Object List List of keys of elements in the cache.
Usage Notes
Retrieving all of the keys from a cache may negatively impact the performance of the calling service. This may be especially true when retrieving all of the keys for a large, distributed cache.
Retrieving all of the keys from a cache is a memory-intensive activity. It is possible for the list of available keys to be larger than the memory available on your system. In such cases, Integration Server might issue an OutOfMemoryError and become unresponsive.
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.