io.apiman.gateway.engine.es

Class PollCachingESRegistry

java.lang.Object

io.apiman.gateway.engine.es.AbstractESComponent

io.apiman.gateway.engine.es.ESRegistry

io.apiman.gateway.engine.es.CachingESRegistry

io.apiman.gateway.engine.es.PollCachingESRegistry

All Implemented Interfaces:

io.apiman.gateway.engine.IRegistry

public class PollCachingESRegistry
extends CachingESRegistry

Extends the ESRegistry to provide multi-node caching. This caching solution will work in a cluster, although it is a rather naive implementation. The approach taken is that whenever the ES index is modified, a "last modified" record is set in elasticsearch. The registry utilizes a thread to periodically poll the ES store to check if the data has been changed. If the data *has* been changed, then the cache is invalidated.

Author:

eric.wittmann@redhat.com

Constructor Summary

Constructors

Constructor and Description
PollCachingESRegistry(Map<String,String> config) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	checkCacheVersion() Checks the ES store to see if the 'dataVersion' entry has been updated with a newer version #.
protected void	finalize()
void	publishService(io.apiman.gateway.engine.beans.Service service, io.apiman.gateway.engine.async.IAsyncResultHandler<Void> handler)
void	registerApplication(io.apiman.gateway.engine.beans.Application application, io.apiman.gateway.engine.async.IAsyncResultHandler<Void> handler)
void	retireService(io.apiman.gateway.engine.beans.Service service, io.apiman.gateway.engine.async.IAsyncResultHandler<Void> handler)
protected void	startCacheInvalidator() Starts up a thread that polls the ES store for updates.
void	unregisterApplication(io.apiman.gateway.engine.beans.Application application, io.apiman.gateway.engine.async.IAsyncResultHandler<Void> handler)
protected void	updateDataVersion() Stores a "dataversion" record in the ES store.

Methods inherited from class io.apiman.gateway.engine.es.CachingESRegistry

cacheApplication, cacheService, decacheApplication, decacheService, getContract, getService, invalidateCache, loadAndCacheApp

Methods inherited from class io.apiman.gateway.engine.es.ESRegistry

checkService, getIndexName, getService, unregisterServiceContracts

Methods inherited from class io.apiman.gateway.engine.es.AbstractESComponent

getClient

Methods inherited from class java.lang.Object

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

Constructor Detail

PollCachingESRegistry

public PollCachingESRegistry(Map<String,String> config)

Constructor.

Method Detail

publishService

public void publishService(io.apiman.gateway.engine.beans.Service service,
                  io.apiman.gateway.engine.async.IAsyncResultHandler<Void> handler)

Specified by:

publishService in interface io.apiman.gateway.engine.IRegistry

Overrides:

publishService in class CachingESRegistry

See Also:

CachingESRegistry.publishService(io.apiman.gateway.engine.beans.Service, io.apiman.gateway.engine.async.IAsyncResultHandler)

retireService

public void retireService(io.apiman.gateway.engine.beans.Service service,
                 io.apiman.gateway.engine.async.IAsyncResultHandler<Void> handler)

Specified by:

retireService in interface io.apiman.gateway.engine.IRegistry

Overrides:

retireService in class CachingESRegistry

See Also:

CachingESRegistry.retireService(io.apiman.gateway.engine.beans.Service, io.apiman.gateway.engine.async.IAsyncResultHandler)

registerApplication

public void registerApplication(io.apiman.gateway.engine.beans.Application application,
                       io.apiman.gateway.engine.async.IAsyncResultHandler<Void> handler)

Specified by:

registerApplication in interface io.apiman.gateway.engine.IRegistry

Overrides:

registerApplication in class CachingESRegistry

See Also:

CachingESRegistry.registerApplication(io.apiman.gateway.engine.beans.Application, io.apiman.gateway.engine.async.IAsyncResultHandler)

unregisterApplication

public void unregisterApplication(io.apiman.gateway.engine.beans.Application application,
                         io.apiman.gateway.engine.async.IAsyncResultHandler<Void> handler)

Specified by:

unregisterApplication in interface io.apiman.gateway.engine.IRegistry

Overrides:

unregisterApplication in class CachingESRegistry

See Also:

CachingESRegistry.unregisterApplication(io.apiman.gateway.engine.beans.Application, io.apiman.gateway.engine.async.IAsyncResultHandler)

updateDataVersion

protected void updateDataVersion()

Stores a "dataversion" record in the ES store. There is only a single one of these. The return value of the add will include the version number of the entity. This version number is what we use to determine whether our cache is stale.

startCacheInvalidator

protected void startCacheInvalidator()

Starts up a thread that polls the ES store for updates.

finalize

protected void finalize()
                 throws Throwable

Overrides:

finalize in class Object

Throws:

Throwable

See Also:

Object.finalize()

checkCacheVersion

protected void checkCacheVersion()

Checks the ES store to see if the 'dataVersion' entry has been updated with a newer version #. If it has, then we need to invalidate our cache.