Package uk.gov.gchq.gaffer.federatedstore

Class FederatedStoreCacheTransient

java.lang.Object

uk.gov.gchq.gaffer.cache.Cache<String,Pair<GraphSerialisable,byte[]>>

uk.gov.gchq.gaffer.federatedstore.FederatedStoreCacheTransient

public class FederatedStoreCacheTransient
extends Cache<String,Pair<GraphSerialisable,byte[]>>

Implementation of Cache for handling Graphs within a FederatedStore.

Field Summary

Fields

Modifier and Type	Field	Description
static String	ERROR_ADDING_GRAPH_TO_CACHE_GRAPH_ID_S
static String	FEDERATED_STORE_CACHE_SERVICE_NAME

Constructor Summary

Constructors

Constructor	Description
FederatedStoreCacheTransient(String suffixFederatedStoreCacheName)

Method Summary

Modifier and Type	Method	Description
void	addGraphToCache(Graph graph, byte[] access, boolean overwrite)	Add the specified Graph to the cache.
void	addGraphToCache(GraphSerialisable graphSerialisable, byte[] access, boolean overwrite)	Add the specified Graph to the cache.
void	deleteGraphFromCache(String graphId)
byte[]	getAccessFromCache(String graphId)
Iterable<String>	getAllGraphIds()	Get all the ID's related to the Graph's stored in the cache.
static String	getCacheNameFrom(String suffixFederatedStoreCacheName)
GraphSerialisable	getGraphFromCache(String graphId)	Retrieve the GraphSerialisable with the specified ID from the cache.
GraphSerialisable	getGraphSerialisableFromCache(String graphId)	Retrieve the Graph with the specified ID from the cache.
String	getSuffixCacheName()

Methods inherited from class uk.gov.gchq.gaffer.cache.Cache

clearCache, contains, deleteFromCache, getAllKeys, getCache, getCacheName, getCacheNameFrom, getFromCache, getSuffixCacheNameWithoutPrefix

Methods inherited from class java.lang.Object

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

Field Detail

ERROR_ADDING_GRAPH_TO_CACHE_GRAPH_ID_S

public static final String ERROR_ADDING_GRAPH_TO_CACHE_GRAPH_ID_S

See Also:

Constant Field Values

FEDERATED_STORE_CACHE_SERVICE_NAME

public static final String FEDERATED_STORE_CACHE_SERVICE_NAME

See Also:

Constant Field Values

Constructor Detail

FederatedStoreCacheTransient

public FederatedStoreCacheTransient(String suffixFederatedStoreCacheName)

Method Detail

getCacheNameFrom

public static String getCacheNameFrom(String suffixFederatedStoreCacheName)

getSuffixCacheName

public String getSuffixCacheName()

getAllGraphIds

public Iterable<String> getAllGraphIds()

Get all the ID's related to the Graph's stored in the cache.

Returns:

Iterable of all the Graph ID's within the cache.

addGraphToCache

public void addGraphToCache(Graph graph,
                            byte[] access,
                            boolean overwrite)
                     throws CacheOperationException

Add the specified Graph to the cache.

Parameters:

graph - the Graph to be added

overwrite - if true, overwrite any graphs already in the cache with the same ID

access - Access for the graph being stored.

Throws:

CacheOperationException - if issues adding to cache

addGraphToCache

public void addGraphToCache(GraphSerialisable graphSerialisable,
                            byte[] access,
                            boolean overwrite)
                     throws CacheOperationException

Add the specified Graph to the cache.

Parameters:

graphSerialisable - the serialised Graph to be added

access - Access for the graph being stored.

overwrite - if true, overwrite any graphs already in the cache with the same ID

Throws:

CacheOperationException - if issues adding to cache

deleteGraphFromCache

public void deleteGraphFromCache(String graphId)

getGraphFromCache

public GraphSerialisable getGraphFromCache(String graphId)
                                    throws CacheOperationException

Retrieve the GraphSerialisable with the specified ID from the cache.

Parameters:

graphId - the ID of the Graph to retrieve

Returns:

the GraphSerialisable related to the specified ID

Throws:

CacheOperationException - exception

getGraphSerialisableFromCache

public GraphSerialisable getGraphSerialisableFromCache(String graphId)
                                                throws CacheOperationException

Retrieve the Graph with the specified ID from the cache.

Parameters:

graphId - the ID of the Graph to retrieve

Returns:

the Graph related to the specified ID

Throws:

CacheOperationException - exception

getAccessFromCache

public byte[] getAccessFromCache(String graphId)
                          throws CacheOperationException

Throws:

CacheOperationException