de.innovationgate.wgpublisher.cache

Class WebTMLCache

java.lang.Object

de.innovationgate.wgpublisher.cache.WebTMLCache

public class WebTMLCache
extends java.lang.Object

A wrapper around a generic cache object to use it as WebTML cache

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	WebTMLCache.CacheEntry
static class	WebTMLCache.CacheKey
class	WebTMLCache.PreloaderListener
class	WebTMLCache.PreloaderTask
class	WebTMLCache.PreloadEvent
class	WebTMLCache.RefreshTask

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CACHEPRELOADTASK_NAME
static int	MAX_ATTEMPTS
static java.lang.String	SERVEROPTION_CACHE_PRELOAD_INTERVAL
static java.lang.String	SERVEROPTION_CACHE_PRELOAD_REFRESHINTERVAL
static int	SERVEROPTIONDEFAULT_CACHE_PRELOAD_INTERVAL
static int	SERVEROPTIONDEFAULT_CACHE_PRELOAD_REFRESHINTERVAL

Constructor Summary

Constructors

Constructor and Description
WebTMLCache(WGACore core, de.innovationgate.wga.config.WGAConfiguration config)

Method Summary

Methods

Modifier and Type	Method and Description
void	addCachePreloader(CachePreloader preloader, de.innovationgate.webgate.api.WGDatabase db, java.lang.String cacheId, java.lang.String cacheKey)
void	clear()
void	clearForDatabase(java.lang.String dbKey)
void	close()
boolean	configure(de.innovationgate.wga.config.WGAConfiguration config)
void	dump(java.io.Writer out)
de.innovationgate.utils.cache.Cache	getCache()
WebTMLCache.CacheEntry	getCacheEntry(java.lang.String dbKey, java.lang.String tagid, java.lang.String key)
int	getCapacity()
long	getEntriesCount()
WebTMLCache.CacheEntry	getPreloadCacheEntry(java.lang.String dbKey, java.lang.String tagid, java.lang.String key)
long	getPreloadEntriesCount()
java.util.concurrent.ConcurrentLinkedQueue<WebTMLCache.PreloadEvent>	getPreloadEvents()
int	getRegisteredPreloadCacheCount(de.innovationgate.webgate.api.WGDatabase db)
int	getRemainingPreloadInitEventsCount()
int	getUninitializedPreloadCacheCount(de.innovationgate.webgate.api.WGDatabase db)
WebTMLCache.CacheEntry	putCacheEntry(java.lang.String dbKey, java.lang.String tagid, java.lang.String key, java.lang.String content, java.util.Date cacheDate, int latency)
WebTMLCache.CacheEntry	putPreloadCacheEntry(java.lang.String dbKey, java.lang.String tagid, java.lang.String key, java.lang.String content, java.util.Date cacheDate, int latency)
void	removeCache(java.lang.String dbKey, java.lang.String tagid, java.lang.String key)
void	runPreloadCacheTask()
void	setCapacity(int capacity)

Methods inherited from class java.lang.Object

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

Field Detail

CACHEPRELOADTASK_NAME

public static final java.lang.String CACHEPRELOADTASK_NAME

See Also:

Constant Field Values

SERVEROPTION_CACHE_PRELOAD_INTERVAL

public static final java.lang.String SERVEROPTION_CACHE_PRELOAD_INTERVAL

See Also:

Constant Field Values

SERVEROPTIONDEFAULT_CACHE_PRELOAD_INTERVAL

public static final int SERVEROPTIONDEFAULT_CACHE_PRELOAD_INTERVAL

See Also:

Constant Field Values

SERVEROPTION_CACHE_PRELOAD_REFRESHINTERVAL

public static final java.lang.String SERVEROPTION_CACHE_PRELOAD_REFRESHINTERVAL

See Also:

Constant Field Values

SERVEROPTIONDEFAULT_CACHE_PRELOAD_REFRESHINTERVAL

public static final int SERVEROPTIONDEFAULT_CACHE_PRELOAD_REFRESHINTERVAL

See Also:

Constant Field Values

MAX_ATTEMPTS

public static final int MAX_ATTEMPTS

See Also:

Constant Field Values

Constructor Detail

WebTMLCache

public WebTMLCache(WGACore core,
           de.innovationgate.wga.config.WGAConfiguration config)
            throws de.innovationgate.utils.cache.CacheException,
                   de.innovationgate.wga.modules.options.OptionConversionException

Throws:

de.innovationgate.utils.cache.CacheException

de.innovationgate.wga.modules.options.OptionConversionException

Method Detail

getPreloadEvents

public java.util.concurrent.ConcurrentLinkedQueue<WebTMLCache.PreloadEvent> getPreloadEvents()

clear

public void clear()
           throws de.innovationgate.utils.cache.CacheException

Throws:

de.innovationgate.utils.cache.CacheException

runPreloadCacheTask

public void runPreloadCacheTask()

clearForDatabase

public void clearForDatabase(java.lang.String dbKey)
                      throws de.innovationgate.utils.cache.CacheException

Throws:

de.innovationgate.utils.cache.CacheException

close

public void close()
           throws de.innovationgate.utils.cache.CacheException

Throws:

de.innovationgate.utils.cache.CacheException

dump

public void dump(java.io.Writer out)
          throws java.io.IOException

Throws:

java.io.IOException

getCacheEntry

public WebTMLCache.CacheEntry getCacheEntry(java.lang.String dbKey,
                                   java.lang.String tagid,
                                   java.lang.String key)
                                     throws de.innovationgate.utils.cache.CacheException

Throws:

de.innovationgate.utils.cache.CacheException

getPreloadCacheEntry

public WebTMLCache.CacheEntry getPreloadCacheEntry(java.lang.String dbKey,
                                          java.lang.String tagid,
                                          java.lang.String key)
                                            throws de.innovationgate.utils.cache.CacheException

Throws:

de.innovationgate.utils.cache.CacheException

removeCache

public void removeCache(java.lang.String dbKey,
               java.lang.String tagid,
               java.lang.String key)
                 throws de.innovationgate.utils.cache.CacheException

Throws:

de.innovationgate.utils.cache.CacheException

getEntriesCount

public long getEntriesCount()

getPreloadEntriesCount

public long getPreloadEntriesCount()

configure

public boolean configure(de.innovationgate.wga.config.WGAConfiguration config)
                  throws de.innovationgate.utils.cache.CacheException,
                         de.innovationgate.wga.modules.options.OptionConversionException

Throws:

de.innovationgate.utils.cache.CacheException

de.innovationgate.wga.modules.options.OptionConversionException

putCacheEntry

public WebTMLCache.CacheEntry putCacheEntry(java.lang.String dbKey,
                                   java.lang.String tagid,
                                   java.lang.String key,
                                   java.lang.String content,
                                   java.util.Date cacheDate,
                                   int latency)
                                     throws de.innovationgate.utils.cache.CacheException

Throws:

de.innovationgate.utils.cache.CacheException

putPreloadCacheEntry

public WebTMLCache.CacheEntry putPreloadCacheEntry(java.lang.String dbKey,
                                          java.lang.String tagid,
                                          java.lang.String key,
                                          java.lang.String content,
                                          java.util.Date cacheDate,
                                          int latency)
                                            throws de.innovationgate.utils.cache.CacheException

Throws:

de.innovationgate.utils.cache.CacheException

getCapacity

public int getCapacity()

setCapacity

public void setCapacity(int capacity)
                 throws de.innovationgate.utils.cache.CacheException

Throws:

de.innovationgate.utils.cache.CacheException

getCache

public de.innovationgate.utils.cache.Cache getCache()

addCachePreloader

public void addCachePreloader(CachePreloader preloader,
                     de.innovationgate.webgate.api.WGDatabase db,
                     java.lang.String cacheId,
                     java.lang.String cacheKey)

getUninitializedPreloadCacheCount

public int getUninitializedPreloadCacheCount(de.innovationgate.webgate.api.WGDatabase db)

getRegisteredPreloadCacheCount

public int getRegisteredPreloadCacheCount(de.innovationgate.webgate.api.WGDatabase db)

getRemainingPreloadInitEventsCount

public int getRemainingPreloadInitEventsCount()