Module io.ebean.api

Package io.ebean.cache

Class ServerCacheConfig

java.lang.Object

io.ebean.cache.ServerCacheConfig

public class ServerCacheConfig
extends Object

Configuration used to create ServerCache instances.

Constructor Summary

Constructors

Constructor	Description
ServerCacheConfig(ServerCacheType type, String cacheKey, String shortName, ServerCacheOptions cacheOptions, CurrentTenantProvider tenantProvider, QueryCacheEntryValidate queryCacheEntryValidate)

Method Summary

Modifier and Type	Method	Description
String	getCacheKey()	Return the name of the cache.
ServerCacheOptions	getCacheOptions()	Return the tuning options.
QueryCacheEntryValidate	getQueryCacheEntryValidate()	Return the service that provides validation for query cache entries.
String	getShortName()	Return the short name for the cache.
CurrentTenantProvider	getTenantProvider()	Return the current tenant provider.
ServerCacheType	getType()	Return the cache type.
boolean	isQueryCache()	Return true if the cache is a query cache.
ServerCache	tenantAware(ServerCache cache)	Return the ServerCache taking into account if multi-tenant is used.

Methods inherited from class java.lang.Object

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

Constructor Detail

ServerCacheConfig

public ServerCacheConfig(ServerCacheType type,
                         String cacheKey,
                         String shortName,
                         ServerCacheOptions cacheOptions,
                         CurrentTenantProvider tenantProvider,
                         QueryCacheEntryValidate queryCacheEntryValidate)

Method Detail

tenantAware

public ServerCache tenantAware(ServerCache cache)

Return the ServerCache taking into account if multi-tenant is used.

getType

public ServerCacheType getType()

Return the cache type.

getCacheKey

public String getCacheKey()

Return the name of the cache.

getShortName

public String getShortName()

Return the short name for the cache.

getCacheOptions

public ServerCacheOptions getCacheOptions()

Return the tuning options.

getTenantProvider

public CurrentTenantProvider getTenantProvider()

Return the current tenant provider.

getQueryCacheEntryValidate

public QueryCacheEntryValidate getQueryCacheEntryValidate()

Return the service that provides validation for query cache entries.

isQueryCache

public boolean isQueryCache()

Return true if the cache is a query cache.