org.apache.marmotta.ldcache.services

Class LDCache

java.lang.Object

org.apache.marmotta.ldcache.services.LDCache

All Implemented Interfaces:

LDCachingService

public class LDCache
extends Object
implements LDCachingService

Next generation LDCache API. Will eventually replace the old LDCache API.

Author:

Sebastian Schaffert (sschaffert@apache.org)

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.marmotta.ldcache.api.LDCachingService

LDCachingService.RefreshOpts

Constructor Summary

Constructors

Constructor and Description
LDCache(CacheConfiguration config, LDCachingBackend backend) Create a new instance of LDCache using the provided LDCache configuration and backend.

Method Summary

Methods

Modifier and Type	Method and Description
void	clear() Manually expire all cached resources.
boolean	contains(org.openrdf.model.URI resource) Return true in case the cache contains an entry for the resource given as argument.
void	expire(org.openrdf.model.URI resource) Manually expire the caching information for the given resource.
org.openrdf.model.Model	get(org.openrdf.model.URI resource, LDCachingService.RefreshOpts... options) Refresh and return the resource passed as argument.
LDClientService	getClient()
void	refresh(org.openrdf.model.URI resource, LDCachingService.RefreshOpts... options) Refresh the resource passed as argument.
void	reload() Reload configuration and initialise LDClient.
void	shutdown() Shutdown the caching service and free all occupied runtime resources.

Methods inherited from class java.lang.Object

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

Constructor Detail

LDCache

public LDCache(CacheConfiguration config,
       LDCachingBackend backend)

Create a new instance of LDCache using the provided LDCache configuration and backend. The backend needs to be initialized already. The cache configuration will be used to create an instance of LDClient.

Parameters:

config -

backend -

Method Detail

reload

public void reload()

Reload configuration and initialise LDClient.

refresh

public void refresh(org.openrdf.model.URI resource,
           LDCachingService.RefreshOpts... options)

Refresh the resource passed as argument. If the resource is not yet cached or the cache entry is expired or refreshing is forced, the remote resource is retrieved using LDClient and the result stored in the cache. Otherwise the method does nothing.

Specified by:

refresh in interface LDCachingService

Parameters:

resource - the resource to refresh

options - options for refreshing

get

public org.openrdf.model.Model get(org.openrdf.model.URI resource,
                          LDCachingService.RefreshOpts... options)

Refresh and return the resource passed as argument. If the resource is not yet cached or the cache entry is expired or refreshing is forced, the remote resource is retrieved using LDClient and the result stored in the cache. Otherwise the method returns the cached entry. In case a cached entry does not exist, the method returns an empty Model.

Specified by:

get in interface LDCachingService

Parameters:

resource - the resource to retrieve

options - options for refreshing

Returns:

a Sesame Model holding the triples representing the resource

expire

public void expire(org.openrdf.model.URI resource)

Manually expire the caching information for the given resource. The resource will be re-retrieved upon the next access.

Specified by:

expire in interface LDCachingService

Parameters:

resource - the resource to expire.

contains

public boolean contains(org.openrdf.model.URI resource)

Return true in case the cache contains an entry for the resource given as argument.

Specified by:

contains in interface LDCachingService

Parameters:

resource - the resource to check

Returns:

true in case the resource is contained in the cache

clear

public void clear()

Manually expire all cached resources.

Specified by:

clear in interface LDCachingService

shutdown

public void shutdown()

Shutdown the caching service and free all occupied runtime resources.

Specified by:

shutdown in interface LDCachingService

getClient

public LDClientService getClient()