org.graylog2.lookup

Class LookupDataAdapterRefreshService

java.lang.Object

com.google.common.util.concurrent.AbstractIdleService

org.graylog2.lookup.LookupDataAdapterRefreshService

All Implemented Interfaces:

com.google.common.util.concurrent.Service

public class LookupDataAdapterRefreshService
extends com.google.common.util.concurrent.AbstractIdleService

This is responsible for scheduling LookupDataAdapter refreshes.

Every LookupDataAdapter can be configured to run a refresh job to load new data, do internal cleanup or similar tasks. This object takes care of scheduling the refresh so the data adapter don't have to do that on their own.

A service LookupDataAdapterRefreshService.Listener instance will be attached to every LookupDataAdapter during startup. The listener takes care of adding and removing the LookupDataAdapter from the refresh service when the data adapter gets started or stopped.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LookupDataAdapterRefreshService.Listener This service listener should be attached to a data adapter service.

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

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

Constructor Summary

Constructors

Constructor and Description
LookupDataAdapterRefreshService(ScheduledExecutorService scheduler, ConcurrentMap<String,LookupTable> liveTables)

Method Summary

Modifier and Type	Method and Description
void	add(LookupDataAdapter dataAdapter) Add the given LookupDataAdapter to the refresh service.
LookupDataAdapterRefreshService.Listener	newServiceListener(LookupDataAdapter adapter) Returns a new Service.Listener to add and remove the given data adapter to the refresh service.
void	remove(LookupDataAdapter dataAdapter) Remove the given LookupDataAdapter from the refresh service.
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

LookupDataAdapterRefreshService

public LookupDataAdapterRefreshService(ScheduledExecutorService scheduler,
                                       ConcurrentMap<String,LookupTable> liveTables)

Method Detail

startUp

protected void startUp()
                throws Exception

Specified by:

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

Throws:

Exception

shutDown

protected void shutDown()
                 throws Exception

Specified by:

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

Throws:

Exception

newServiceListener

public LookupDataAdapterRefreshService.Listener newServiceListener(LookupDataAdapter adapter)

Returns a new Service.Listener to add and remove the given data adapter to the refresh service.

Parameters:

adapter - the data adapter to be added/removed

Returns:

the new listener

add

public void add(LookupDataAdapter dataAdapter)

Add the given LookupDataAdapter to the refresh service.

The refresh method method will be called periodically according to the refresh interval of the data adapter.

Parameters:

dataAdapter - the adapter to be added

remove

public void remove(LookupDataAdapter dataAdapter)

Remove the given LookupDataAdapter from the refresh service.

Parameters:

dataAdapter -