Callable

ebox.system.cache.providers.concurrent.Callable interface"> Callable

Class

ColdBox Platform - CacheBox Version 1.3.1

FRAMES

cachebox.system.cache.providers
Class CacheBoxProvider

WEB-INF.cftags.component
        cachebox.system.cache.AbstractCacheBoxProvider
            cachebox.system.cache.providers.CacheBoxProvider

All Implemented Interfaces:: ICacheProvider

Direct Known Subclasses:: CacheBoxColdBoxProvider

public class CacheBoxProvider
extends AbstractCacheBoxProvider
extends AbstractCacheBoxProvider

The coolest standalone CacheBox Provider ever built

Constructor Summary

init()
          Constructor

Method Summary

void _reap()
          Reap the cache, clear out everything that is dead

private void announceExpiration(any objectKey)
          Announce an Expiration

any<boolean> clear(any objectKey)
          Clears an object from the cache by using its cache key

void clearAll()
          Clear all the cache elements from the cache

void clearByKeySnippet(any keySnippet, [any<boolean> regex='false'], [any<boolean> async='false'])
          Clears keys using the passed in object key snippet

any<boolean> clearKey(any objectKey)
          Deprecated, please use clear()

any<struct> clearMulti(any keys, [any prefix=''])
          Clears objects from the cache by using its cache key

any<boolean> clearQuiet(any objectKey)
          Clears an object from the cache by using its cache key

void configure()
          Configures the cache for operation, sets the configuration object, sets and creates the eviction policy and clears the stats

void expireAll()
          Expire All Objects

void expireByKeySnippet(any keySnippet, [any<boolean> regex='false'])
          Same as expireKey but can touch multiple objects depending on the keysnippet that is sent in

void expireObject(any objectKey)
          Expire an Object

any get(any objectKey)
          Get an object from cache

any<struct> getCachedObjectMetadata(any objectKey)
          Get the cached object's metadata structure

any<struct> getCachedObjectMetadataMulti(any keys, [any prefix=''])
          Get the cached object's metadata structure

any getJavaRuntime()
          Get the java runtime object for reporting purposes

any<array> getKeys()
          Get a listing of all the keys of the objects in the cache

any<struct> getMulti(any keys, [any prefix=''])
          The returned value is a structure of name-value pairs of all the keys that where found

any<IObjectStore> getObjectStore()
          If the cache provider implements it, this returns the cache's object store as type: cachebox

any getQuiet(any objectKey)
          Get an object from cache

any<numeric> getSize()
          Get the cache's size in items

any<struct> getStoreMetadataKeyMap()
          Get a key lookup structure where cachebox can build the report on

any<struct> getStoreMetadataReport()
          Get a structure of all the keys in the cache with their appropriate metadata structures

any<boolean> isExpired(any objectKey)
          Has the object key expired in the cache

private any locateEvictionPolicy([string policy])
          Locate the eviction policy

private any locateObjectStore([string store])
          Locate the object store

any<boolean> lookup(any objectKey)
          Check if an object is in cache, if not found it records a miss

any<struct> lookupMulti(any keys, [any prefix=''])
          The returned value is a structure of name-value pairs of all the keys that where found or not

any<boolean> lookupQuiet(any objectKey)
          Check if an object is in cache quietly, advising nobody!

void reap()
          Reap the cache, clear out everything that is dead

any<boolean> set(any objectKey, any object, [any timeout=''], [any lastAccessTimeout=''], [any<struct> extra])
          sets an object in cache

void setMulti(any<struct> mapping, [any timeout=''], [any lastAccessTimeout=''], [any prefix=''])
          Sets Multiple Ojects in the cache

any<boolean> setQuiet(any objectKey, any object, [any timeout=''], [any lastAccessTimeout=''], [any<struct> extra])
          sets an object in cache

void shutdown()
          Shutdown command issued when CacheBox is going through shutdown phase

private boolean thresholdChecks(any threshold='')
          JVM Threshold checks

private void validateConfiguration()
          Validate incoming set configuration data

Methods inherited from class cachebox.system.cache.AbstractCacheBoxProvider

clearStatistics, getCacheFactory, getCacheID, getConfiguration, getEventManager, getMemento, getName, getStats, getUtil, isEnabled, isReportingEnabled, setCacheFactory, setConfiguration, setEventManager, setName, statusCheck

Methods inherited from class WEB-INF.cftags.component

Constructor Summary
`init()` Constructor

Method Summary
`void`	`_reap()` Reap the cache, clear out everything that is dead
`private void`	`announceExpiration(any objectKey)` Announce an Expiration
`any<boolean>`	`clear(any objectKey)` Clears an object from the cache by using its cache key
`void`	`clearAll()` Clear all the cache elements from the cache
`void`	`clearByKeySnippet(any keySnippet, [any<boolean> regex='false'], [any<boolean> async='false'])` Clears keys using the passed in object key snippet
`any<boolean>`	`clearKey(any objectKey)` Deprecated, please use clear()
`any<struct>`	`clearMulti(any keys, [any prefix=''])` Clears objects from the cache by using its cache key
`any<boolean>`	`clearQuiet(any objectKey)` Clears an object from the cache by using its cache key
`void`	`configure()` Configures the cache for operation, sets the configuration object, sets and creates the eviction policy and clears the stats
`void`	`expireAll()` Expire All Objects
`void`	`expireByKeySnippet(any keySnippet, [any<boolean> regex='false'])` Same as expireKey but can touch multiple objects depending on the keysnippet that is sent in
`void`	`expireObject(any objectKey)` Expire an Object
`any`	`get(any objectKey)` Get an object from cache
`any<struct>`	`getCachedObjectMetadata(any objectKey)` Get the cached object's metadata structure
`any<struct>`	`getCachedObjectMetadataMulti(any keys, [any prefix=''])` Get the cached object's metadata structure
`any`	`getJavaRuntime()` Get the java runtime object for reporting purposes
`any<array>`	`getKeys()` Get a listing of all the keys of the objects in the cache
`any<struct>`	`getMulti(any keys, [any prefix=''])` The returned value is a structure of name-value pairs of all the keys that where found
`any<IObjectStore>`	`getObjectStore()` If the cache provider implements it, this returns the cache's object store as type: cachebox
`any`	`getQuiet(any objectKey)` Get an object from cache
`any<numeric>`	`getSize()` Get the cache's size in items
`any<struct>`	`getStoreMetadataKeyMap()` Get a key lookup structure where cachebox can build the report on
`any<struct>`	`getStoreMetadataReport()` Get a structure of all the keys in the cache with their appropriate metadata structures
`any<boolean>`	`isExpired(any objectKey)` Has the object key expired in the cache
`private any`	`locateEvictionPolicy([string policy])` Locate the eviction policy
`private any`	`locateObjectStore([string store])` Locate the object store
`any<boolean>`	`lookup(any objectKey)` Check if an object is in cache, if not found it records a miss
`any<struct>`	`lookupMulti(any keys, [any prefix=''])` The returned value is a structure of name-value pairs of all the keys that where found or not
`any<boolean>`	`lookupQuiet(any objectKey)` Check if an object is in cache quietly, advising nobody!
`void`	`reap()` Reap the cache, clear out everything that is dead
`any<boolean>`	`set(any objectKey, any object, [any timeout=''], [any lastAccessTimeout=''], [any<struct> extra])` sets an object in cache
`void`	`setMulti(any<struct> mapping, [any timeout=''], [any lastAccessTimeout=''], [any prefix=''])` Sets Multiple Ojects in the cache
`any<boolean>`	`setQuiet(any objectKey, any object, [any timeout=''], [any lastAccessTimeout=''], [any<struct> extra])` sets an object in cache
`void`	`shutdown()` Shutdown command issued when CacheBox is going through shutdown phase
`private boolean`	`thresholdChecks(any threshold='')` JVM Threshold checks
`private void`	`validateConfiguration()` Validate incoming set configuration data

Methods inherited from class cachebox.system.cache.AbstractCacheBoxProvider
`clearStatistics, getCacheFactory, getCacheID, getConfiguration, getEventManager, getMemento, getName, getStats, getUtil, isEnabled, isReportingEnabled, setCacheFactory, setConfiguration, setEventManager, setName, statusCheck`

Constructor Detail

init

public init()

Constructor

Method Detail

_reap

public void _reap()

Reap the cache, clear out everything that is dead.

announceExpiration

private void announceExpiration(any objectKey)

Announce an Expiration

clear

public any<boolean> clear(any objectKey)

Clears an object from the cache by using its cache key. Returns false if object was not removed or did not exist anymore

clearAll

public void clearAll()

Clear all the cache elements from the cache

clearByKeySnippet

public void clearByKeySnippet(any keySnippet, [any<boolean> regex='false'], [any<boolean> async='false'])

Clears keys using the passed in object key snippet

clearKey

public any<boolean> clearKey(any objectKey)

Deprecated, please use clear()

clearMulti

public any<struct> clearMulti(any keys, [any prefix=''])

Clears objects from the cache by using its cache key. The returned value is a structure of name-value pairs of all the keys that where removed from the operation.

clearQuiet

public any<boolean> clearQuiet(any objectKey)

Clears an object from the cache by using its cache key. Returns false if object was not removed or did not exist anymore

configure

public void configure()

Configures the cache for operation, sets the configuration object, sets and creates the eviction policy and clears the stats. If this method is not called, the cache is useless.

expireAll

public void expireAll()

Expire All Objects. Use this instead of clear() from within handlers or any cached object, this sets the metadata for the objects to expire in the next request. Note that this is not an inmmediate expiration. Clear should only be used from outside a cached object

expireByKeySnippet

public void expireByKeySnippet(any keySnippet, [any<boolean> regex='false'])

Same as expireKey but can touch multiple objects depending on the keysnippet that is sent in.

expireObject

public void expireObject(any objectKey)

Expire an Object. Use this instead of clearKey() from within handlers or any cached object, this sets the metadata for the objects to expire in the next request. Note that this is not an inmmediate expiration. Clear should only be used from outside a cached object

get

public any get(any objectKey)

Get an object from cache. If object does not exist it returns null

getCachedObjectMetadata

public any<struct> getCachedObjectMetadata(any objectKey)

Get the cached object's metadata structure. If the object does not exist, it returns an empty structure.

getCachedObjectMetadataMulti

public any<struct> getCachedObjectMetadataMulti(any keys, [any prefix=''])

Get the cached object's metadata structure. If the object does not exist, it returns an empty structure.

getJavaRuntime

public any getJavaRuntime()

Get the java runtime object for reporting purposes.

getKeys

public any<array> getKeys()

Get a listing of all the keys of the objects in the cache

getMulti

public any<struct> getMulti(any keys, [any prefix=''])

The returned value is a structure of name-value pairs of all the keys that where found. Not found values will not be returned

getObjectStore

public any<IObjectStore> getObjectStore()

If the cache provider implements it, this returns the cache's object store as type: cachebox.system.cache.store.IObjectStore

getQuiet

public any getQuiet(any objectKey)

Get an object from cache. If object does not exist it returns null

getSize

public any<numeric> getSize()

Get the cache's size in items

getStoreMetadataKeyMap

public any<struct> getStoreMetadataKeyMap()

Get a key lookup structure where cachebox can build the report on. Ex: [timeout=timeout,lastAccessTimeout=idleTimeout]. It is a way for the visualizer to construct the columns correctly on the reports

getStoreMetadataReport

public any<struct> getStoreMetadataReport()

Get a structure of all the keys in the cache with their appropriate metadata structures. This is used to build the reporting.[keyX->[metadataStructure]]

isExpired

public any<boolean> isExpired(any objectKey)

Has the object key expired in the cache

locateEvictionPolicy

private any locateEvictionPolicy([string policy])

Locate the eviction policy

locateObjectStore

private any locateObjectStore([string store])

Locate the object store

lookup

public any<boolean> lookup(any objectKey)

Check if an object is in cache, if not found it records a miss.

lookupMulti

public any<struct> lookupMulti(any keys, [any prefix=''])

The returned value is a structure of name-value pairs of all the keys that where found or not.

lookupQuiet

public any<boolean> lookupQuiet(any objectKey)

Check if an object is in cache quietly, advising nobody!

reap

public void reap()

Reap the cache, clear out everything that is dead.

set

public any<boolean> set(any objectKey, any object, [any timeout=''], [any lastAccessTimeout=''], [any<struct> extra])

sets an object in cache. Sets might be expensive. If the JVM threshold is used and it has been reached, the object won't be cached. If the pool is at maximum it will expire using its eviction policy and still cache the object. Cleanup will be done later.

setMulti

public void setMulti(any<struct> mapping, [any timeout=''], [any lastAccessTimeout=''], [any prefix=''])

Sets Multiple Ojects in the cache. Sets might be expensive. If the JVM threshold is used and it has been reached, the object won't be cached. If the pool is at maximum it will expire using its eviction policy and still cache the object. Cleanup will be done later.

setQuiet

public any<boolean> setQuiet(any objectKey, any object, [any timeout=''], [any lastAccessTimeout=''], [any<struct> extra])

sets an object in cache. Sets might be expensive. If the JVM threshold is used and it has been reached, the object won't be cached. If the pool is at maximum it will expire using its eviction policy and still cache the object. Cleanup will be done later.

shutdown

public void shutdown()

Shutdown command issued when CacheBox is going through shutdown phase

thresholdChecks

private boolean thresholdChecks(any threshold='')

JVM Threshold checks

validateConfiguration

private void validateConfiguration()

Validate incoming set configuration data

Overview

Package