System.Cache
URI: http://soap.zeus.com/zxtm/1.3/System/Cache/
The System.Cache interface provides information about the content cache for a machine. Using this interface, you can retrieve both individual cache entries and global cache data, delete all entries in the cache, delete entries matching wildcards or delete individual entries.
Methods
clearCacheContentItems( virtual_servers, protocols, hosts, items )
Delete individual items from the Web Cache. All input arguments are arrays of strings and only those items are deleted whose virtual server, protocol, host and path attribute match all the corresponding values for a given index into the arguments.
void clearCacheContentItems(
String[] virtual_servers
System.Cache.Protocol[] protocols
String[] hosts
String[] items
)clearMatchingCacheContent( protocol, host_wildcard, path_wildcard )
Delete the Web Cache entries matching the input arguments.
void clearMatchingCacheContent(
System.Cache.Protocol protocol
String host_wildcard
String path_wildcard
)clearWebCache()
Clear all entries from the Web Cache for this machine.
void clearWebCache()getCacheContent( protocol, host_wildcard, path_wildcard, max_entries )
Get information about the Web Cache entries matching the input arguments.
System.Cache.CacheContentInfo getCacheContent(
System.Cache.Protocol protocol
String host_wildcard
String path_wildcard
Integer max_entries
)getGlobalCacheInfo()
Get the size of the Web Cache, the number of Web Cache entries and the percentage memory used by the Web Cache for this machine.
System.Cache.GlobalInfo getGlobalCacheInfo()Structures
System.Cache.CacheContent
This structure contains the basic information about an individual cache entry for a machine.
struct System.Cache.CacheContent {
# The virtual server hosting the entry.
String virtual_server;
# The protocol of the entry: http or https.
System.Cache.Protocol protocol;
# The host name of the entry.
String host;
# The path of the entry.
String path;
# The time that the entry was last used.
Time time_used;
# The time that the entry expires.
Time time_expires;
# The number of hits for the entry.
Long hits;
# Whether or not Web Accelerator has optimized the content of this cache
# entry.
Boolean optimized;
# The number of variants of this entry in the cache.
Integer num_variants;
# The HTTP response code for this entry in the cache.
Integer response_code;
# The HTTP versions the entry is cached for.
String[] versions;
# The set of request-header fields that determine if the cache entry may be
# used for a particular request.
String[] varys;
# The specific web browsers for which this entry is cached.
String[] browsers;
}System.Cache.CacheContentInfo
This structure contains the information about the cache content.
struct System.Cache.CacheContentInfo {
# The total number of items matching the wildcards in a query.
Integer number_matching_items;
# The total size of the items matching the wildcards in a query.
Long size_matching_items;
# The set of individual entries in the cache that matched the query.
System.Cache.CacheContent[] matching_items;
}System.Cache.GlobalInfo
This structure contains the basic information about the content cache for a machine.
struct System.Cache.GlobalInfo {
# The number of bytes of memory used by the cache.
Long bytes_used;
# The percentage of the cache used.
Float percent_used;
# The number of entries in the cache.
Integer entries;
# The number of times a request has tried to get a page from the cache.
Long num_lookups;
# The number of times a request has successfully been served from the cache.
Long num_hits;
}Enumerations
System.Cache.Protocol
This enumeration defines the possible protocols for cache entries.
enum System.Cache.Protocol {
# The hypertext transfer protocol (port 80 by default).
http,
# The hypertext transfer protocol secure (port 443 by default).
https,
# This special value can be used as wildcard to match both http and https. It
# is never returned by the methods in this interface.
both
}