org.graylog2.plugin.lookup

Class LookupDataAdapter

java.lang.Object

com.google.common.util.concurrent.AbstractIdleService

org.graylog2.plugin.lookup.LookupDataAdapter

All Implemented Interfaces:

com.google.common.util.concurrent.Service

Direct Known Subclasses:

CSVFileDataAdapter, DnsLookupDataAdapter, DSVHTTPDataAdapter, HTTPJSONPathDataAdapter, MaxmindDataAdapter

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

Nested Class Summary

Nested Classes

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

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	LookupDataAdapter(String id, String name, LookupDataAdapterConfiguration config, com.codahale.metrics.MetricRegistry metricRegistry)

Method Summary

Modifier and Type	Method and Description
protected void	clearError()
protected abstract LookupResult	doGet(Object key)
protected abstract void	doRefresh(LookupCachePurge cachePurge)
protected abstract void	doStart()
protected abstract void	doStop()
LookupResult	get(Object key)
LookupDataAdapterConfiguration	getConfig()
Optional<Throwable>	getError()
String	id()
String	name()
void	refresh(LookupCachePurge cachePurge)
abstract org.joda.time.Duration	refreshInterval() Returns the refresh interval for this data adapter.
abstract void	set(Object key, Object value)
protected void	setError(Throwable throwable)
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

Constructor Detail

LookupDataAdapter

protected LookupDataAdapter(String id,
                            String name,
                            LookupDataAdapterConfiguration config,
                            com.codahale.metrics.MetricRegistry metricRegistry)

Method Detail

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

refreshInterval

public abstract org.joda.time.Duration refreshInterval()

Returns the refresh interval for this data adapter. Use Duration.ZERO if refresh should be disabled.

Returns:

the refresh interval

refresh

public void refresh(LookupCachePurge cachePurge)

doRefresh

protected abstract void doRefresh(LookupCachePurge cachePurge)
                           throws Exception

Throws:

Exception

clearError

protected void clearError()

getError

public Optional<Throwable> getError()

setError

protected void setError(Throwable throwable)

id

public String id()

name

public String name()

get

public LookupResult get(Object key)

doGet

protected abstract LookupResult doGet(Object key)

set

public abstract void set(Object key,
                         Object value)

getConfig

public LookupDataAdapterConfiguration getConfig()