Package org.graylog2.lookup.adapters

Class CSVFileDataAdapter

java.lang.Object

com.google.common.util.concurrent.AbstractIdleService

org.graylog2.plugin.lookup.LookupDataAdapter

org.graylog2.lookup.adapters.CSVFileDataAdapter

All Implemented Interfaces:

com.google.common.util.concurrent.Service

public class CSVFileDataAdapter
extends LookupDataAdapter

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CSVFileDataAdapter.Config
static class	CSVFileDataAdapter.Descriptor
static interface	CSVFileDataAdapter.Factory

Nested classes/interfaces inherited from class org.graylog2.plugin.lookup.LookupDataAdapter

LookupDataAdapter.Factory2<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

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ALLOWED_PATH_ERROR	If the AllowedAuxiliaryPathChecker is enabled (one or more paths provided to the allowed_auxiliary_paths server configuration property), then this error path will also be triggered for cases where the file does not exist.
static final String	NAME

Constructor Summary

Constructors

Constructor	Description
CSVFileDataAdapter(String id, String name, LookupDataAdapterConfiguration config, com.codahale.metrics.MetricRegistry metricRegistry, AllowedAuxiliaryPathChecker pathChecker)

Method Summary

Modifier and Type	Method	Description
LookupResult	doGet(Object key)
protected void	doRefresh(LookupCachePurge cachePurge)
void	doStart()
void	doStop()
org.joda.time.Duration	refreshInterval()	Returns the refresh interval for this data adapter.
void	set(Object key, Object value)

Methods inherited from class org.graylog2.plugin.lookup.LookupDataAdapter

addStringList, clearError, clearKey, get, getConfig, getEmptyResult, getError, getErrorResult, id, name, refresh, removeStringList, setError, setStringList, setValue, shutDown, startUp

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

addListener, awaitRunning, awaitRunning, awaitRunning, awaitTerminated, 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

Field Details

NAME

public static final String NAME

See Also:

• Constant Field Values

ALLOWED_PATH_ERROR

public static final String ALLOWED_PATH_ERROR

If the AllowedAuxiliaryPathChecker is enabled (one or more paths provided to the allowed_auxiliary_paths server configuration property), then this error path will also be triggered for cases where the file does not exist. This is unavoidable, since the AllowedAuxiliaryPathChecker tries to resolve symbolic links and relative paths, which cannot be done if the file does not exist. Therefore this error message also indicates the possibility that the file does not exist.

See Also:

• Constant Field Values

Constructor Details

CSVFileDataAdapter

@Inject
public CSVFileDataAdapter(String id,
 String name,
 LookupDataAdapterConfiguration config,
 com.codahale.metrics.MetricRegistry metricRegistry,
 AllowedAuxiliaryPathChecker pathChecker)

Method Details

doStart

public void doStart()
             throws Exception

Specified by:

doStart in class LookupDataAdapter

Throws:

Exception

refreshInterval

public org.joda.time.Duration refreshInterval()

Description copied from class: LookupDataAdapter

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

Specified by:

refreshInterval in class LookupDataAdapter

Returns:

the refresh interval

doRefresh

protected void doRefresh(LookupCachePurge cachePurge)
                  throws Exception

Specified by:

doRefresh in class LookupDataAdapter

Throws:

Exception

doStop

public void doStop()
            throws Exception

Specified by:

doStop in class LookupDataAdapter

Throws:

Exception

doGet

public LookupResult doGet(Object key)

Specified by:

doGet in class LookupDataAdapter

set

public void set(Object key,
 Object value)

Specified by:

set in class LookupDataAdapter