org.graylog2.lookup.adapters

Class CSVFileDataAdapter.Config

java.lang.Object

org.graylog2.lookup.adapters.CSVFileDataAdapter.Config

All Implemented Interfaces:

LookupDataAdapterConfiguration

Enclosing class:

CSVFileDataAdapter

public abstract static class CSVFileDataAdapter.Config
extends Object
implements LookupDataAdapterConfiguration

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CSVFileDataAdapter.Config.Builder

Field Summary

Fields inherited from interface org.graylog2.plugin.lookup.LookupDataAdapterConfiguration

TYPE_FIELD

Constructor Summary

Constructors

Constructor and Description
Config()

Method Summary

Modifier and Type	Method and Description
static CSVFileDataAdapter.Config.Builder	builder()
abstract Optional<Boolean>	caseInsensitiveLookup()
abstract @Min(value=1L) long	checkInterval()
boolean	isCaseInsensitiveLookup()
abstract @NotEmpty String	keyColumn()
abstract @NotEmpty String	path()
abstract @Size(min=1,max=1) @NotEmpty String	quotechar()
char	quotecharAsChar()
abstract @Size(min=1,max=1) @NotEmpty String	separator()
char	separatorAsChar()
abstract String	type()
Optional<com.google.common.collect.Multimap<String,String>>	validate() Override this method to check for logical errors in the configuration, such as missing files, or invalid combinations of options.
abstract @NotEmpty String	valueColumn()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.graylog2.plugin.lookup.LookupDataAdapterConfiguration

validate

Constructor Detail

Config

public Config()

Method Detail

type

public abstract String type()

Specified by:

type in interface LookupDataAdapterConfiguration

path

@NotEmpty
public abstract @NotEmpty String path()

separator

@Size(min=1,
      max=1)
 @NotEmpty
public abstract @Size(min=1,max=1) @NotEmpty String separator()

separatorAsChar

public char separatorAsChar()

quotechar

@Size(min=1,
      max=1)
 @NotEmpty
public abstract @Size(min=1,max=1) @NotEmpty String quotechar()

quotecharAsChar

public char quotecharAsChar()

keyColumn

@NotEmpty
public abstract @NotEmpty String keyColumn()

valueColumn

@NotEmpty
public abstract @NotEmpty String valueColumn()

checkInterval

@Min(value=1L)
public abstract @Min(value=1L) long checkInterval()

caseInsensitiveLookup

public abstract Optional<Boolean> caseInsensitiveLookup()

isCaseInsensitiveLookup

public boolean isCaseInsensitiveLookup()

builder

public static CSVFileDataAdapter.Config.Builder builder()

validate

public Optional<com.google.common.collect.Multimap<String,String>> validate()

Description copied from interface: LookupDataAdapterConfiguration

Override this method to check for logical errors in the configuration, such as missing files, or invalid combinations of options. Prefer validation annotations for simple per-property validations rules, such as min/max values, non-empty strings etc.

By default the configuration has no extra validation errors (i.e. the result of this method is Optional.empty().

Returning failing validations here does not prevent saving the configuration!

If your validation needs access to additional services, override LookupDataAdapterConfiguration.validate(LookupDataAdapterValidationContext) instead.

Specified by:

validate in interface LookupDataAdapterConfiguration

Returns:

optionally map of property name to error messages