org.cache2k.impl

Class StorageAdapter

java.lang.Object

org.cache2k.impl.StorageAdapter

Direct Known Subclasses:

AggregationStorageAdapter, FailureStorageAdapter, NoopStorageAdapter, PassingStorageAdapter

public abstract class StorageAdapter
extends Object

Author:

Jens Wilke; created: 2014-05-08

Constructor Summary

Constructors

Constructor and Description
StorageAdapter()

Method Summary

Methods

Modifier and Type	Method and Description
protected static Throwable	buildThrowable(String txt, Throwable ex)
abstract Future<Void>	cancelTimerJobs() Cancel all schedules timer jobs in the storage.
abstract boolean	checkStorageStillDisconnectedForClear()
abstract Future<Void>	clearAndReconnect() Starts the parallel clearing process, returns immediatly
abstract void	disable(Throwable t)
abstract void	disconnectStorageForClear()
abstract void	evict(Entry e)
abstract void	expire(Entry e) TODO: Relly needed?
abstract void	flush()
abstract StorageEntry	get(Object key)
abstract int	getAlert() 0 means no alert, 1 orange, 2, red alert
abstract int	getTotalEntryCount() Return the total number of entries within the heap and the storage.
abstract ClosableIterator<Entry>	iterateAll()
abstract void	open()
abstract void	purge()
abstract void	put(Entry e, long _nextRefreshTime)
abstract boolean	remove(Object key)
protected static void	rethrow(String txt, Throwable ex)
abstract Future<Void>	shutdown()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

StorageAdapter

public StorageAdapter()

Method Detail

open

public abstract void open()

cancelTimerJobs

public abstract Future<Void> cancelTimerJobs()

Cancel all schedules timer jobs in the storage.

shutdown

public abstract Future<Void> shutdown()

flush

public abstract void flush()

purge

public abstract void purge()

checkStorageStillDisconnectedForClear

public abstract boolean checkStorageStillDisconnectedForClear()

disconnectStorageForClear

public abstract void disconnectStorageForClear()

clearAndReconnect

public abstract Future<Void> clearAndReconnect()

Starts the parallel clearing process, returns immediatly

put

public abstract void put(Entry e,
       long _nextRefreshTime)

Parameters:

_nextRefreshTime - value expiry time in millis, 0: expire immediately, Long.MAX_VALUE: no expiry

get

public abstract StorageEntry get(Object key)

remove

public abstract boolean remove(Object key)

evict

public abstract void evict(Entry e)

expire

public abstract void expire(Entry e)

TODO: Relly needed?

iterateAll

public abstract ClosableIterator<Entry> iterateAll()

getTotalEntryCount

public abstract int getTotalEntryCount()

Return the total number of entries within the heap and the storage. Should apply simple calculations to give and exact number. No heavy operation e.g. checking for duplicates.

See Also:

Cache.getTotalEntryCount()

getAlert

public abstract int getAlert()

0 means no alert, 1 orange, 2, red alert

disable

public abstract void disable(Throwable t)

buildThrowable

protected static Throwable buildThrowable(String txt,
                       Throwable ex)

rethrow

protected static void rethrow(String txt,
           Throwable ex)