Module io.ebean.api

Package io.ebean.cache

Class TenantAwareCache

java.lang.Object

io.ebean.cache.TenantAwareCache

All Implemented Interfaces:

ServerCache

public final class TenantAwareCache
extends Object
implements ServerCache

A ServerCache proxy that is tenant aware.

Constructor Summary

Constructors

Constructor	Description
TenantAwareCache(ServerCache delegate, TenantAwareKey tenantAwareKey)	Create given the TenantAwareKey and delegate cache to proxy to.

Method Summary

Modifier and Type	Method	Description
void	clear()	Clear all entries from the cache.
Object	get(Object id)	Return the value given the key.
Map<Object,Object>	getAll(Set<Object> keys)	Get values for many keys.
int	hitRatio()	Return the hit ratio the cache is currently getting.
void	put(Object id, Object value)	Put the value in the cache with a given id.
void	putAll(Map<Object,Object> keyValues)	Put all the values in the cache.
void	remove(Object id)	Remove a entry from the cache given its id.
void	removeAll(Set<Object> keys)	Remove the entries from the cache given the id values.
int	size()	Return the number of entries in the cache.
ServerCacheStatistics	statistics(boolean reset)	Return statistics for the cache.
<T> T	unwrap(Class<T> cls)	Return the underlying ServerCache that is being delegated to.
void	visit(MetricVisitor visitor)	Visit the metrics for the cache.

Methods inherited from class java.lang.Object

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

Constructor Detail

TenantAwareCache

public TenantAwareCache(ServerCache delegate,
                        TenantAwareKey tenantAwareKey)

Create given the TenantAwareKey and delegate cache to proxy to.

Parameters:

delegate - The cache to proxy to

tenantAwareKey - Provides tenant aware keys to use in the cache

Method Detail

unwrap

public <T> T unwrap(Class<T> cls)

Return the underlying ServerCache that is being delegated to.

Specified by:

unwrap in interface ServerCache

visit

public void visit(MetricVisitor visitor)

Description copied from interface: ServerCache

Visit the metrics for the cache.

Specified by:

visit in interface ServerCache

get

public Object get(Object id)

Description copied from interface: ServerCache

Return the value given the key.

Specified by:

get in interface ServerCache

put

public void put(Object id,
                Object value)

Description copied from interface: ServerCache

Put the value in the cache with a given id.

Specified by:

put in interface ServerCache

remove

public void remove(Object id)

Description copied from interface: ServerCache

Remove a entry from the cache given its id.

Specified by:

remove in interface ServerCache

clear

public void clear()

Description copied from interface: ServerCache

Clear all entries from the cache.

Specified by:

clear in interface ServerCache

size

public int size()

Description copied from interface: ServerCache

Return the number of entries in the cache.

Specified by:

size in interface ServerCache

hitRatio

public int hitRatio()

Description copied from interface: ServerCache

Return the hit ratio the cache is currently getting.

Specified by:

hitRatio in interface ServerCache

statistics

public ServerCacheStatistics statistics(boolean reset)

Description copied from interface: ServerCache

Return statistics for the cache.

Specified by:

statistics in interface ServerCache

Parameters:

reset - if true the statistics are reset.

getAll

public Map<Object,Object> getAll(Set<Object> keys)

Description copied from interface: ServerCache

Get values for many keys.

Specified by:

getAll in interface ServerCache

putAll

public void putAll(Map<Object,Object> keyValues)

Description copied from interface: ServerCache

Put all the values in the cache.

Specified by:

putAll in interface ServerCache

removeAll

public void removeAll(Set<Object> keys)

Description copied from interface: ServerCache

Remove the entries from the cache given the id values.

Specified by:

removeAll in interface ServerCache