io.druid.query.lookup

Class LookupReferencesManager

java.lang.Object

io.druid.query.lookup.LookupReferencesManager

public class LookupReferencesManager
extends Object

This class provide a basic LookupExtractorFactory references manager. It allows basic operations fetching, listing, adding and deleting of LookupExtractor objects It is be used by queries to fetch the lookup reference. It is used by Lookup configuration manager to add/remove or list lookups configuration via HTTP or other protocols. It does periodic snap shot of the list of lookup in order to bootstrap nodes after restart.

Constructor Summary

Constructors

Constructor and Description
LookupReferencesManager(LookupConfig lookupConfig, com.fasterxml.jackson.databind.ObjectMapper objectMapper)

Method Summary

Modifier and Type	Method and Description
LookupExtractorFactory	get(String lookupName)
Map<String,LookupExtractorFactory>	getAll()
boolean	isClosed()
void	put(Map<String,LookupExtractorFactory> lookups)
boolean	put(String lookupName, LookupExtractorFactory lookupExtractorFactory)
boolean	remove(String lookupName)
void	start()
void	stop()
boolean	updateIfNew(String lookupName, LookupExtractorFactory lookupExtractorFactory) Add or update a lookup factory

Methods inherited from class java.lang.Object

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

Constructor Detail

LookupReferencesManager

@Inject
public LookupReferencesManager(LookupConfig lookupConfig,
                                       com.fasterxml.jackson.databind.ObjectMapper objectMapper)

Method Detail

start

public void start()

stop

public void stop()

put

public boolean put(String lookupName,
                   LookupExtractorFactory lookupExtractorFactory)

Parameters:

lookupName - name of the lookupExtractorFactory object

lookupExtractorFactory - LookupExtractorFactory implementation reference.

Returns:

true if the lookup is added otherwise false.

Throws:

IllegalStateException - If the manager is closed or if start of lookup returns false.

put

public void put(Map<String,LookupExtractorFactory> lookups)

Parameters:

lookups - Map containing all the lookup as one batch.

Throws:

IllegalStateException - if the manager is closed or if LookupExtractorFactory.start() returns false

updateIfNew

public boolean updateIfNew(String lookupName,
                           LookupExtractorFactory lookupExtractorFactory)

Add or update a lookup factory

Parameters:

lookupName - The name of the lookup

lookupExtractorFactory - The factory of the lookup

Returns:

True if the lookup was updated, false otherwise

Throws:

IllegalStateException - if start of the factory fails

remove

public boolean remove(String lookupName)

Parameters:

lookupName - name of LookupExtractorFactory to delete from the reference registry. this function does call the cleaning method LookupExtractorFactory.close()

Returns:

true only if lookupName is removed and the lookup correctly stopped

get

@Nullable
public LookupExtractorFactory get(String lookupName)

Parameters:

lookupName - key to fetch the reference of the object LookupExtractor

Returns:

reference of LookupExtractorFactory that correspond the lookupName or null if absent

Throws:

IllegalStateException - if the LookupReferencesManager is closed or did not start yet

getAll

public Map<String,LookupExtractorFactory> getAll()

Returns:

Returns Map containing a copy of the current state.

Throws:

ISE - if the is is closed or did not start yet.

isClosed

public boolean isClosed()