org.springframework.data.couchbase.cache

Class CouchbaseCache

java.lang.Object

org.springframework.data.couchbase.cache.CouchbaseCache

All Implemented Interfaces:

Cache

public class CouchbaseCache
extends Object
implements Cache

The CouchbaseCache class implements the Spring Cache interface on top of Couchbase Server and the Couchbase Java SDK.

Author:

Michael Nitschinger, Konrad Król

See Also:

Official Spring Cache Reference

Nested Class Summary

Nested classes/interfaces inherited from interface org.springframework.cache.Cache

Cache.ValueWrapper

Constructor Summary

Constructors

Constructor and Description
CouchbaseCache(String name, com.couchbase.client.CouchbaseClient client) Construct the cache and pass in the CouchbaseClient instance.
CouchbaseCache(String name, com.couchbase.client.CouchbaseClient client, int ttl) Construct the cache and pass in the CouchbaseClient instance.

Method Summary

Modifier and Type	Method and Description
void	clear() Clear the complete cache.
void	evict(Object key) Remove an object from Couchbase.
Cache.ValueWrapper	get(Object key) Get an element from the cache.
<T> T	get(Object key, Class<T> clazz)
String	getName() Returns the name of the cache.
com.couchbase.client.CouchbaseClient	getNativeCache() Returns the actual CouchbaseClient instance.
int	getTtl() Returns the TTL value for this cache.
void	put(Object key, Object value) Store a object in Couchbase.
Cache.ValueWrapper	putIfAbsent(Object key, Object value)

Methods inherited from class java.lang.Object

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

Constructor Detail

CouchbaseCache

public CouchbaseCache(String name,
                      com.couchbase.client.CouchbaseClient client)

Construct the cache and pass in the CouchbaseClient instance.

Parameters:

name - the name of the cache reference.

client - the CouchbaseClient instance.

CouchbaseCache

public CouchbaseCache(String name,
                      com.couchbase.client.CouchbaseClient client,
                      int ttl)

Construct the cache and pass in the CouchbaseClient instance.

Parameters:

name - the name of the cache reference.

client - the CouchbaseClient instance.

ttl - TTL value for objects in this cache

Method Detail

getName

public final String getName()

Returns the name of the cache.

Specified by:

getName in interface Cache

Returns:

the name of the cache.

getNativeCache

public final com.couchbase.client.CouchbaseClient getNativeCache()

Returns the actual CouchbaseClient instance.

Specified by:

getNativeCache in interface Cache

Returns:

the actual CouchbaseClient instance.

getTtl

public final int getTtl()

Returns the TTL value for this cache.

Returns:

TTL value

get

public final Cache.ValueWrapper get(Object key)

Get an element from the cache.

Specified by:

get in interface Cache

Parameters:

key - the key to lookup against.

Returns:

the fetched value from Couchbase.

get

public final <T> T get(Object key,
                       Class<T> clazz)

Specified by:

get in interface Cache

put

public final void put(Object key,
                      Object value)

Store a object in Couchbase.

Specified by:

put in interface Cache

Parameters:

key - the Key of the storable object.

value - the Object to store.

evict

public final void evict(Object key)

Remove an object from Couchbase.

Specified by:

evict in interface Cache

Parameters:

key - the Key of the object to delete.

clear

public final void clear()

Clear the complete cache. Note that this action is very destructive, so only use it with care. Also note that "flush" may not be enabled on the bucket.

Specified by:

clear in interface Cache

putIfAbsent

public Cache.ValueWrapper putIfAbsent(Object key,
                                      Object value)

Specified by:

putIfAbsent in interface Cache