io.druid.server.namespace.cache

Class NamespaceExtractionCacheManager

java.lang.Object

io.druid.server.namespace.cache.NamespaceExtractionCacheManager

Direct Known Subclasses:

OffHeapNamespaceExtractionCacheManager, OnHeapNamespaceExtractionCacheManager

public abstract class NamespaceExtractionCacheManager
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
protected AtomicLong	dataSize
protected ConcurrentMap<String,com.google.common.base.Function<String,String>>	fnCache
protected ConcurrentMap<String,io.druid.server.namespace.cache.NamespaceExtractionCacheManager.NamespaceImplData>	implData
protected com.metamx.emitter.service.ServiceEmitter	serviceEmitter
protected AtomicLong	tasksStarted

Constructor Summary

Constructors

Constructor and Description
NamespaceExtractionCacheManager(com.metamx.common.lifecycle.Lifecycle lifecycle, ConcurrentMap<String,com.google.common.base.Function<String,String>> fnCache, com.metamx.emitter.service.ServiceEmitter serviceEmitter, Map<Class<? extends ExtractionNamespace>,ExtractionNamespaceFunctionFactory<?>> namespaceFunctionFactoryMap)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	delete(String ns) Clears out resources used by the namespace such as threads.
abstract ConcurrentMap<String,String>	getCacheMap(String namespaceOrCacheKey) Return a ConcurrentMap with the specified ID (either namespace's name or a cache key ID)
Collection<String>	getKnownNamespaces()
protected <T extends ExtractionNamespace> Runnable	getPostRunnable(T namespace, ExtractionNamespaceFunctionFactory<T> factory, String cacheId)
String	getVersion(String namespace)
<T extends ExtractionNamespace> com.google.common.util.concurrent.ListenableFuture<?>	schedule(T namespace)
protected <T extends ExtractionNamespace> com.google.common.util.concurrent.ListenableFuture<?>	schedule(T namespace, ExtractionNamespaceFunctionFactory<T> factory, Runnable postRunnable, String cacheId)
void	scheduleOrUpdate(Collection<ExtractionNamespace> namespaces)
protected abstract boolean	swapAndClearCache(String namespaceKey, String cacheKey) This method is expected to swap the cacheKey into the active namespace, and leave future requests for new cacheKey available.
protected void	waitForServiceToEnd(long time, TimeUnit unit)

Methods inherited from class java.lang.Object

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

Field Detail

fnCache

protected final ConcurrentMap<String,com.google.common.base.Function<String,String>> fnCache

implData

protected final ConcurrentMap<String,io.druid.server.namespace.cache.NamespaceExtractionCacheManager.NamespaceImplData> implData

tasksStarted

protected final AtomicLong tasksStarted

dataSize

protected final AtomicLong dataSize

serviceEmitter

protected final com.metamx.emitter.service.ServiceEmitter serviceEmitter

Constructor Detail

NamespaceExtractionCacheManager

public NamespaceExtractionCacheManager(com.metamx.common.lifecycle.Lifecycle lifecycle,
                               ConcurrentMap<String,com.google.common.base.Function<String,String>> fnCache,
                               com.metamx.emitter.service.ServiceEmitter serviceEmitter,
                               Map<Class<? extends ExtractionNamespace>,ExtractionNamespaceFunctionFactory<?>> namespaceFunctionFactoryMap)

Method Detail

waitForServiceToEnd

protected void waitForServiceToEnd(long time,
                       TimeUnit unit)
                            throws InterruptedException

Throws:

InterruptedException

getPostRunnable

protected <T extends ExtractionNamespace> Runnable getPostRunnable(T namespace,
                                                       ExtractionNamespaceFunctionFactory<T> factory,
                                                       String cacheId)

scheduleOrUpdate

public void scheduleOrUpdate(Collection<ExtractionNamespace> namespaces)

schedule

public <T extends ExtractionNamespace> com.google.common.util.concurrent.ListenableFuture<?> schedule(T namespace)

schedule

protected <T extends ExtractionNamespace> com.google.common.util.concurrent.ListenableFuture<?> schedule(T namespace,
                                                                                             ExtractionNamespaceFunctionFactory<T> factory,
                                                                                             Runnable postRunnable,
                                                                                             String cacheId)

swapAndClearCache

protected abstract boolean swapAndClearCache(String namespaceKey,
                        String cacheKey)

This method is expected to swap the cacheKey into the active namespace, and leave future requests for new cacheKey available. getCacheMap(cacheKey) should return empty data after this call.

Parameters:

namespaceKey - The namespace to swap the cache into

cacheKey - The cacheKey that contains the data of interest

Returns:

true if old data was cleared. False if no old data was found

getCacheMap

public abstract ConcurrentMap<String,String> getCacheMap(String namespaceOrCacheKey)

Return a ConcurrentMap with the specified ID (either namespace's name or a cache key ID)

Parameters:

namespaceOrCacheKey - Either a namespace or cache key should be acceptable here.

Returns:

A ConcurrentMap that is backed by the impl which implements this method.

delete

public boolean delete(String ns)

Clears out resources used by the namespace such as threads. Implementations may override this and call super.delete(...) if they have resources of their own which need cleared.

This particular method is NOT thread safe, and any impl which is intended to be thread safe should safe-guard calls to this method.

Parameters:

ns - The namespace to be deleted

Returns:

True if a deletion occurred, false if no deletion occurred.

Throws:

com.metamx.common.ISE - if there is an error cancelling the namespace's future task

getVersion

public String getVersion(String namespace)

getKnownNamespaces

public Collection<String> getKnownNamespaces()