ICacheConfig (ymate-platform-v2-码云(gitee.com))

All Superinterfaces:

IInitialization<ICaches>

All Known Implementing Classes:

DefaultCacheConfig
```
@Ignored
public interface ICacheConfig
extends IInitialization<ICaches>
```
缓存配置接口

Author:

刘镇 (suninformation@163.com) on 14-12-1 上午2:52

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`CONFIG_FILE`
`static String`	`DEFAULT_CACHE_NAME`
`static String`	`DEFAULT_CACHE_TIMEOUT`
`static String`	`DEFAULT_CONFIG_FILE`
`static String`	`DEFAULT_STR`
`static String`	`ENABLED_SUBSCRIBE_EXPIRED`
`static String`	`EVENT_LISTENER_CLASS`
`static String`	`KEY_GENERATOR_CLASS`
`static String`	`MULTILEVEL_SLAVE_AUTO_SYNC`
`static String`	`PROVIDER_CLASS`
`static String`	`SCOPE_PROCESSOR_CLASS`
`static String`	`SERIALIZER_CLASS`
`static String`	`STORAGE_WITH_SET`

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`ICacheEventListener`	`getCacheEventListener()` 缓存对象事件监听器，可选参数，默认值为空
`ICacheProvider`	`getCacheProvider()` 缓存提供者，可选参数，默认值为 net.ymate.platform.cache.impl.DefaultCacheProvider
`ICacheScopeProcessor`	`getCacheScopeProcessor()` 缓存作用域处理器，可选参数，默认值为空
`File`	`getConfigFile()` 获取Ehcache配置文件，可选参数，若未设置或设置的文件路径无效将被忽略，默认值为空
`String`	`getDefaultCacheName()` 默认缓存名称，可选参数，默认值为default，对应于Ehcache配置文件中设置name="__DEFAULT__"
`int`	`getDefaultCacheTimeout()` 默认缓存数据超时时间(秒)，可选参数，数值必须大于等于0，默认值为0
`ICacheKeyGenerator<?>`	`getKeyGenerator()` 缓存Key生成器，可选参数，默认值为 net.ymate.platform.cache.impl.DefaultCacheKeyGenerator
`ISerializer`	`getSerializer()` 对象序列化接口实现，可选参数，默认值为 SerializerManager.getDefaultSerializer()
`boolean`	`isEnabledSubscribeExpired()` 是否开启Redis订阅缓存元素过期事件，可选参数，默认值为false
`boolean`	`isMultilevelSlavesAutoSync()` Multilevel模式下是否自动同步Master和Slave级缓存，可选参数，默认值为false
`boolean`	`isStorageWithSet()` 是否采用Set存储缓存键名

Methods inherited from interface net.ymate.platform.core.support.IInitialization
initialize, isInitialized

- Field Detail
  - DEFAULT_STR
```
static final String DEFAULT_STR
```
    See Also:
    
    Constant Field Values
  - PROVIDER_CLASS
```
static final String PROVIDER_CLASS
```
    See Also:
    
    Constant Field Values
  - EVENT_LISTENER_CLASS
```
static final String EVENT_LISTENER_CLASS
```
    See Also:
    
    Constant Field Values
  - SCOPE_PROCESSOR_CLASS
```
static final String SCOPE_PROCESSOR_CLASS
```
    See Also:
    
    Constant Field Values
  - SERIALIZER_CLASS
```
static final String SERIALIZER_CLASS
```
    See Also:
    
    Constant Field Values
  - KEY_GENERATOR_CLASS
```
static final String KEY_GENERATOR_CLASS
```
    See Also:
    
    Constant Field Values
  - DEFAULT_CACHE_NAME
```
static final String DEFAULT_CACHE_NAME
```
    See Also:
    
    Constant Field Values
  - DEFAULT_CACHE_TIMEOUT
```
static final String DEFAULT_CACHE_TIMEOUT
```
    See Also:
    
    Constant Field Values
  - DEFAULT_CONFIG_FILE
```
static final String DEFAULT_CONFIG_FILE
```
    See Also:
    
    Constant Field Values
  - CONFIG_FILE
```
static final String CONFIG_FILE
```
    See Also:
    
    Constant Field Values
  - STORAGE_WITH_SET
```
static final String STORAGE_WITH_SET
```
    See Also:
    
    Constant Field Values
  - ENABLED_SUBSCRIBE_EXPIRED
```
static final String ENABLED_SUBSCRIBE_EXPIRED
```
    See Also:
    
    Constant Field Values
  - MULTILEVEL_SLAVE_AUTO_SYNC
```
static final String MULTILEVEL_SLAVE_AUTO_SYNC
```
    See Also:
    
    Constant Field Values
- Method Detail
  - getCacheProvider
```
ICacheProvider getCacheProvider()
```
    缓存提供者，可选参数，默认值为 net.ymate.platform.cache.impl.DefaultCacheProvider
    
    Returns:
    
    返回缓存提供者实例
  - getCacheEventListener
```
ICacheEventListener getCacheEventListener()
```
    缓存对象事件监听器，可选参数，默认值为空
    
    Returns:
    
    返回缓存对象事件监听器实例
  - getCacheScopeProcessor
```
ICacheScopeProcessor getCacheScopeProcessor()
```
    缓存作用域处理器，可选参数，默认值为空
    
    Returns:
    
    返回缓存作用域处理器实例
  - getKeyGenerator
```
ICacheKeyGenerator<?> getKeyGenerator()
```
    缓存Key生成器，可选参数，默认值为 net.ymate.platform.cache.impl.DefaultCacheKeyGenerator
    
    Returns:
    
    返回缓存Key生成器实例
  - getSerializer
```
ISerializer getSerializer()
```
    对象序列化接口实现，可选参数，默认值为 SerializerManager.getDefaultSerializer()
    
    Returns:
    
    返回对象序列化接口实现
  - getDefaultCacheName
```
String getDefaultCacheName()
```
    默认缓存名称，可选参数，默认值为default，对应于Ehcache配置文件中设置name="__DEFAULT__"
    
    Returns:
    
    返回默认缓存名称
  - getDefaultCacheTimeout
```
int getDefaultCacheTimeout()
```
    默认缓存数据超时时间(秒)，可选参数，数值必须大于等于0，默认值为0
    
    Returns:
    
    返回默认缓存数据超时时间(秒)
  - getConfigFile
```
File getConfigFile()
```
    获取Ehcache配置文件，可选参数，若未设置或设置的文件路径无效将被忽略，默认值为空
    
    Returns:
    
    返回Ehcache配置文件
  - isStorageWithSet
```
boolean isStorageWithSet()
```
    是否采用Set存储缓存键名
    
    Returns:
    
    返回true表示采用
  - isEnabledSubscribeExpired
```
boolean isEnabledSubscribeExpired()
```
    是否开启Redis订阅缓存元素过期事件，可选参数，默认值为false
    
    Returns:
    
    返回true表示已开启
  - isMultilevelSlavesAutoSync
```
boolean isMultilevelSlavesAutoSync()
```
    Multilevel模式下是否自动同步Master和Slave级缓存，可选参数，默认值为false
    
    Returns:
    
    返回true表示同步

Interface ICacheConfig

Field Summary

Method Summary

Methods inherited from interface net.ymate.platform.core.support.IInitialization

Field Detail

DEFAULT_STR

PROVIDER_CLASS

EVENT_LISTENER_CLASS

SCOPE_PROCESSOR_CLASS

SERIALIZER_CLASS

KEY_GENERATOR_CLASS

DEFAULT_CACHE_NAME

DEFAULT_CACHE_TIMEOUT

DEFAULT_CONFIG_FILE

CONFIG_FILE

STORAGE_WITH_SET

ENABLED_SUBSCRIBE_EXPIRED

MULTILEVEL_SLAVE_AUTO_SYNC

Method Detail

getCacheProvider

getCacheEventListener

getCacheScopeProcessor

getKeyGenerator

getSerializer

getDefaultCacheName

getDefaultCacheTimeout

getConfigFile

isStorageWithSet

isEnabledSubscribeExpired

isMultilevelSlavesAutoSync