Cache Entry Object
A cache entry object encapsulates a response that was returned to a client which can also safely be returned to another client making the same request. The cache entry object also contains a locked or unlocked flag and a state code. Though a state code doesn't belong in a cache entry object, it allows the Cache Manager's search method to return a single result for the cache entry, rather than a cache entry and a separate state code.
There are three possible state code values, however, two of them indicate that the cache entry does not contain any content.
• NOT_CACHEABLE
The cache manager is not willing to cache responses for the request being processed.
• CACHEABLE
The cache manager would be willing to cache a response for the active request, but the cache manager does not currently contain a response.
• IN_CACHE
The cache entry contains a valid response that could be returned to the client.
An entry may be locked by a call to E3CacheManager.search. If a cache entry is locked, the cache manager refrains from deallocating the cache entry object. A cache entry should always be locked during transmission to the client. The caller requesting the lock is responsible for calling E3CacheEntry.unlock.