org.graylog2.plugin.lookup

Class LookupResult

java.lang.Object

org.graylog2.plugin.lookup.LookupResult

public abstract class LookupResult
extends Object

The result of looking up a key in a lookup table (i. e. lookup data adapter or lookup cache).

For convenience, this class can be serialized and deserialized with Jackson (see ObjectMapper, but we strongly recommend implementing your own serialization and deserialization logic if you're implementing a lookup cache.

There are no guarantees about binary compatibility of this class across Graylog releases!

See Also:

LookupDataAdapter.get(Object), LookupCache.get(LookupCacheKey, java.util.concurrent.Callable), LookupCacheKey

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LookupResult.Builder

Field Summary

Fields

Modifier and Type	Field and Description
static String	SINGLE_VALUE_KEY

Constructor Summary

Constructors

Constructor and Description
LookupResult()

Method Summary

Modifier and Type	Method and Description
static LookupResult.Builder	builder()
abstract long	cacheTTL() The time to live (in milliseconds) for a LookupResult instance.
static LookupResult	createFromJSON(Object singleValue, Map<Object,Object> multiValue, long cacheTTL)
static LookupResult	empty()
boolean	isEmpty()
static LookupResult	multi(Boolean singleValue, Map<Object,Object> multiValue)
static LookupResult	multi(CharSequence singleValue, Map<Object,Object> multiValue)
static LookupResult	multi(Number singleValue, Map<Object,Object> multiValue)
abstract Map<Object,Object>	multiValue()
static LookupResult	single(Boolean singleValue)
static LookupResult	single(CharSequence singleValue)
static LookupResult	single(Number singleValue)
abstract Object	singleValue()
static LookupResult	withDefaults(LookupDefaultSingleValue singleValue, LookupDefaultMultiValue multiValue)
static LookupResult.Builder	withoutTTL()

Methods inherited from class java.lang.Object

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

Field Detail

SINGLE_VALUE_KEY

public static final String SINGLE_VALUE_KEY

See Also:

Constant Field Values

Constructor Detail

LookupResult

public LookupResult()

Method Detail

singleValue

@Nullable
public abstract Object singleValue()

multiValue

@Nullable
public abstract Map<Object,Object> multiValue()

cacheTTL

public abstract long cacheTTL()

The time to live (in milliseconds) for a LookupResult instance. Prevents repeated lookups for the same key during the time to live period. Data Tables processing does not currently use this functionality, but we expect to add support for it at some point. Some Data Adaptors may fill this ttl value in anticipation of future implementation.

isEmpty

public boolean isEmpty()

empty

public static LookupResult empty()

single

public static LookupResult single(CharSequence singleValue)

single

public static LookupResult single(Number singleValue)

single

public static LookupResult single(Boolean singleValue)

multi

public static LookupResult multi(CharSequence singleValue,
                                 Map<Object,Object> multiValue)

multi

public static LookupResult multi(Number singleValue,
                                 Map<Object,Object> multiValue)

multi

public static LookupResult multi(Boolean singleValue,
                                 Map<Object,Object> multiValue)

withDefaults

public static LookupResult withDefaults(LookupDefaultSingleValue singleValue,
                                        LookupDefaultMultiValue multiValue)

createFromJSON

public static LookupResult createFromJSON(Object singleValue,
                                          Map<Object,Object> multiValue,
                                          long cacheTTL)

withoutTTL

public static LookupResult.Builder withoutTTL()

builder

public static LookupResult.Builder builder()