org.graylog2.plugin.lookup

Class LookupCache

java.lang.Object

com.google.common.util.concurrent.AbstractIdleService

org.graylog2.plugin.lookup.LookupCache

All Implemented Interfaces:

com.google.common.util.concurrent.Service

Direct Known Subclasses:

CaffeineLookupCache, NullCache

public abstract class LookupCache
extends com.google.common.util.concurrent.AbstractIdleService

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LookupCache.Descriptor<C extends LookupCacheConfiguration>
static interface	LookupCache.Factory<T extends LookupCache>

Nested classes/interfaces inherited from interface com.google.common.util.concurrent.Service

com.google.common.util.concurrent.Service.Listener, com.google.common.util.concurrent.Service.State

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	LookupCache(String id, String name, LookupCacheConfiguration config, com.codahale.metrics.MetricRegistry metricRegistry)

Method Summary

Modifier and Type	Method and Description
protected void	clearError()
protected abstract void	doStart()
protected abstract void	doStop()
long	entryCount() Get the number of elements in this lookup cache.
abstract LookupResult	get(LookupCacheKey key, Callable<LookupResult> loader)
LookupCacheConfiguration	getConfig()
Optional<Throwable>	getError()
abstract LookupResult	getIfPresent(LookupCacheKey key)
String	id()
void	incrHitCount() Deprecated.
void	incrHitCount(long n)
void	incrMissCount() Deprecated.
void	incrMissCount(long n)
void	incrTotalCount() Deprecated.
void	incrTotalCount(long n)
com.codahale.metrics.Timer.Context	lookupTimer()
String	name()
abstract void	purge()
abstract void	purge(LookupCacheKey purgeKey)
protected void	setError(Throwable throwable)
void	setId(String id)
protected void	shutDown()
protected void	startUp()

Methods inherited from class com.google.common.util.concurrent.AbstractIdleService

addListener, awaitRunning, awaitRunning, awaitTerminated, awaitTerminated, executor, failureCause, isRunning, serviceName, startAsync, state, stopAsync, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.google.common.util.concurrent.Service

awaitRunning, awaitTerminated

Constructor Detail

LookupCache

protected LookupCache(String id,
                      String name,
                      LookupCacheConfiguration config,
                      com.codahale.metrics.MetricRegistry metricRegistry)

Method Detail

incrTotalCount

@Deprecated
public void incrTotalCount()

Deprecated.

incrTotalCount

public void incrTotalCount(long n)

incrHitCount

@Deprecated
public void incrHitCount()

Deprecated.

incrHitCount

public void incrHitCount(long n)

incrMissCount

@Deprecated
public void incrMissCount()

Deprecated.

incrMissCount

public void incrMissCount(long n)

lookupTimer

public com.codahale.metrics.Timer.Context lookupTimer()

entryCount

public long entryCount()

Get the number of elements in this lookup cache.

Returns:

the number of elements in this lookup cache or -1L if the cache does not support counting entries

startUp

protected void startUp()
                throws Exception

Specified by:

startUp in class com.google.common.util.concurrent.AbstractIdleService

Throws:

Exception

doStart

protected abstract void doStart()
                         throws Exception

Throws:

Exception

shutDown

protected void shutDown()
                 throws Exception

Specified by:

shutDown in class com.google.common.util.concurrent.AbstractIdleService

Throws:

Exception

doStop

protected abstract void doStop()
                        throws Exception

Throws:

Exception

clearError

protected void clearError()

getError

public Optional<Throwable> getError()

setError

protected void setError(Throwable throwable)

id

@Nullable
public String id()

setId

public void setId(String id)

get

public abstract LookupResult get(LookupCacheKey key,
                                 Callable<LookupResult> loader)

getIfPresent

public abstract LookupResult getIfPresent(LookupCacheKey key)

purge

public abstract void purge()

purge

public abstract void purge(LookupCacheKey purgeKey)

getConfig

public LookupCacheConfiguration getConfig()

name

public String name()