com.google.code.ssm.spring

Class SSMCache

java.lang.Object

com.google.code.ssm.spring.SSMCache

All Implemented Interfaces:

org.springframework.cache.Cache

public class SSMCache
extends Object
implements org.springframework.cache.Cache

Wrapper around Cache that allow to set default expiration time used in all put(Object, Object) ( Cache.set(String, int, Object, com.google.code.ssm.api.format.SerializationType)) requests.

Since:

3.0.0

Author:

Jakub Białek

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SSMCache.ValueRetrievalException A custom exception class because org.springframework.cache.Cache.ValueRetrievalException cannot be used as it is declared in Spring 4.3 but SSM shouldn't required newest Spring version.

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

org.springframework.cache.Cache.ValueWrapper

Constructor Summary

Constructors

Constructor and Description
SSMCache(Cache cache, int expiration)
SSMCache(Cache cache, int expiration, boolean allowClear)
SSMCache(Cache cache, int expiration, boolean allowClear, boolean registerAliases, boolean muteExceptions)
SSMCache(SSMCache ssmCache, int expiration)

Method Summary

Modifier and Type	Method and Description
void	clear()
void	evict(Object key)
org.springframework.cache.Cache.ValueWrapper	get(Object key)
<T> T	get(Object key, Callable<T> valueLoader) Required by Spring 4.3
<T> T	get(Object key, Class<T> type) Required by Spring 4.0
Cache	getCache()
int	getExpiration() An expiration time is specified in seconds.
String	getName()
Object	getNativeCache()
boolean	isAllowClear()
boolean	isMuteExceptions() If true exceptions thrown by underlying cache are muted and aren't forwarded to Spring Cache Abstraction, it's behaviour of SSM before 4.0.0.
boolean	isRegisterAliases() If true then all aliases of the underlying cache will be used to register the cache in Spring, otherwise the cache will be available only by name.
void	put(Object key, Object value)
org.springframework.cache.Cache.ValueWrapper	putIfAbsent(Object key, Object value) Required by Spring 4.1

Methods inherited from class java.lang.Object

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

Constructor Detail

SSMCache

public SSMCache(Cache cache,
                int expiration,
                boolean allowClear,
                boolean registerAliases,
                boolean muteExceptions)

SSMCache

public SSMCache(Cache cache,
                int expiration,
                boolean allowClear)

SSMCache

public SSMCache(Cache cache,
                int expiration)

SSMCache

public SSMCache(SSMCache ssmCache,
                int expiration)

Method Detail

getName

public String getName()

Specified by:

getName in interface org.springframework.cache.Cache

getNativeCache

public Object getNativeCache()

Specified by:

getNativeCache in interface org.springframework.cache.Cache

get

public org.springframework.cache.Cache.ValueWrapper get(Object key)

Specified by:

get in interface org.springframework.cache.Cache

get

public <T> T get(Object key,
                 Class<T> type)

Required by Spring 4.0

Specified by:

get in interface org.springframework.cache.Cache

Since:

3.4.0

get

public <T> T get(Object key,
                 Callable<T> valueLoader)

Required by Spring 4.3

Specified by:

get in interface org.springframework.cache.Cache

Since:

3.6.1

put

public void put(Object key,
                Object value)

Specified by:

put in interface org.springframework.cache.Cache

putIfAbsent

public org.springframework.cache.Cache.ValueWrapper putIfAbsent(Object key,
                                                                Object value)

Required by Spring 4.1

Specified by:

putIfAbsent in interface org.springframework.cache.Cache

Since:

3.6.0

evict

public void evict(Object key)

Specified by:

evict in interface org.springframework.cache.Cache

clear

public void clear()

Specified by:

clear in interface org.springframework.cache.Cache

getCache

@Generated(value="lombok")
public Cache getCache()

getExpiration

@Generated(value="lombok")
public int getExpiration()

An expiration time is specified in seconds. They can be set from 0, meaning "never expire", to 30 days (60*60*24*30). Any time higher than 30 days is interpreted as a unix timestamp date.

isAllowClear

@Generated(value="lombok")
public boolean isAllowClear()

isMuteExceptions

@Generated(value="lombok")
public boolean isMuteExceptions()

If true exceptions thrown by underlying cache are muted and aren't forwarded to Spring Cache Abstraction, it's behaviour of SSM before 4.0.0. If false then exceptions will be passed to caller and optionally wrapped if not RuntimeException.

Since:

4.0.0

isRegisterAliases

@Generated(value="lombok")
public boolean isRegisterAliases()

If true then all aliases of the underlying cache will be used to register the cache in Spring, otherwise the cache will be available only by name.

Since:

3.3.0