box.system.cache.store.concurrent.Callable interface"> Callable
ColdBox Platform - WireBox Version 1.2.0

wirebox.system.cache.store
Class JDBCStore

WEB-INF.cftags.component
        extended by wirebox.system.cache.store.JDBCStore
All Implemented Interfaces:
IObjectStore

public class JDBCStore
extends WEB-INF.cftags.component

I am a cool cool JDBC Store for CacheBox


Constructor Summary
init(any<ICacheProvider> cacheProvider)
          Constructor
 
Method Summary
 any clear(any objectKey)
          Clears an object from the storage pool
 void clearAll()
          Clear all elements of the store
private void ensureTable()
          Create the caching table if necessary
 void expireObject(any objectKey)
          Mark an object for expiration
 void flush()
          Flush the store to a permanent storage
 any get(any objectKey)
          Get an object from cache
 any getIndexer()
          Get the store's pool metadata indexer structure
 any getKeys()
          Get all the store's object keys
 any getNormalizedID(any objectKey)
          Get the cached normalized id
 any getQuiet(any objectKey)
          Get an object from cache with no stats
 any getSize()
          Get the cache's size in items
 any getStoreID()
          Get this storage's ID
private any getUtil()
          Create and return a util object
 any isExpired(any objectKey)
          Test if an object in the store has expired or not, returns false if object not found
 any lookup(any objectKey)
          Check if an object is in cache
private any lookupQuery(any objectKey)
          Get the lookup query
 void reap()
          Reap the storage, clean it from old stuff
 void set(any objectKey, any object, [any timeout='0'], [any lastAccessTimeout='0'], [any extras='[runtime expression]'])
          sets an object in the storage
 
Methods inherited from class WEB-INF.cftags.component
 

Constructor Detail

init

public init(any<ICacheProvider> cacheProvider)
Constructor

Parameters:
cacheProvider - The associated cache provider as wirebox.system.cache.ICacheProvider
Method Detail

clear

public any clear(any objectKey)
Clears an object from the storage pool

Specified by:
clear in interface IObjectStore
Parameters:
objectKey - The object key

clearAll

public void clearAll()
Clear all elements of the store

Specified by:
clearAll in interface IObjectStore

ensureTable

private void ensureTable()
Create the caching table if necessary


expireObject

public void expireObject(any objectKey)
Mark an object for expiration

Specified by:
expireObject in interface IObjectStore
Parameters:
objectKey - The object key

flush

public void flush()
Flush the store to a permanent storage

Specified by:
flush in interface IObjectStore

get

public any get(any objectKey)
Get an object from cache

Specified by:
get in interface IObjectStore
Parameters:
objectKey - The key of the object

getIndexer

public any getIndexer()
Get the store's pool metadata indexer structure

Specified by:
getIndexer in interface IObjectStore

getKeys

public any getKeys()
Get all the store's object keys

Specified by:
getKeys in interface IObjectStore

getNormalizedID

public any getNormalizedID(any objectKey)
Get the cached normalized id

Parameters:
objectKey - The key of the object

getQuiet

public any getQuiet(any objectKey)
Get an object from cache with no stats

Specified by:
getQuiet in interface IObjectStore
Parameters:
objectKey - The key of the object

getSize

public any getSize()
Get the cache's size in items

Specified by:
getSize in interface IObjectStore

getStoreID

public any getStoreID()
Get this storage's ID


getUtil

private any getUtil()
Create and return a util object


isExpired

public any isExpired(any objectKey)
Test if an object in the store has expired or not, returns false if object not found

Specified by:
isExpired in interface IObjectStore
Parameters:
objectKey - The object key

lookup

public any lookup(any objectKey)
Check if an object is in cache.

Specified by:
lookup in interface IObjectStore
Parameters:
objectKey - The key of the object

lookupQuery

private any lookupQuery(any objectKey)
Get the lookup query

Parameters:
objectKey - The key of the object

reap

public void reap()
Reap the storage, clean it from old stuff

Specified by:
reap in interface IObjectStore

set

public void set(any objectKey, any object, [any timeout='0'], [any lastAccessTimeout='0'], [any extras='[runtime expression]'])
sets an object in the storage.

Specified by:
set in interface IObjectStore
Parameters:
objectKey - The object key
object - The object to save
timeout - Timeout in minutes
lastAccessTimeout - Timeout in minutes
extras - A map of extra name-value pairs

ColdBox Platform - WireBox Version 1.2.0