org.jboss.hibernate.jbc.cacheprovider
Class CacheProperties

java.lang.Object
  extended by org.jboss.hibernate.jbc.cacheprovider.CacheProperties

public class CacheProperties
extends Object

CacheProperties.

Author:
Galder Zamarreno

Field Summary
static String DEFAULT_CACHE_OBJECT_NAME
          Default ObjectName for the JBoss Cache instance that will be used if HIBERNATE_CACHE_OBJECT_NAME_PROPERTY is not provided.
static String DEFAULT_LOCAL_PUTS_ONLY
          Default value for the JBoss Cache instance that will be used if HIBERNATE_CACHE_LOCAL_PUTS_ONLY_PROPERTY is not provided.
static String DEFAULT_QUERYCACHE_LOCAL_WRITES_ONLY
          Default value for the JBoss Cache instance that will be used if HIBERNATE_CACHE_QUERYCACHE_LOCAL_WRITES_ONLY_PROPERTY is not provided.
static String HIBERNATE_CACHE_LOCAL_PUTS_ONLY_PROPERTY
          This property controls whether any put calls on the Second Level Cache as a result of a read operation from the database are done locally or not.
static String HIBERNATE_CACHE_OBJECT_NAME_PROPERTY
          Name of the Hibernate configuration property used to provide the ObjectName of the JBoss Cache instance.
static String HIBERNATE_CACHE_QUERYCACHE_LOCAL_WRITES_ONLY_PROPERTY
          If query cache has been enabled, this property controls whether the query cache is only populated and updated locally or instead it's replicated.
static String HIBERNATE_CACHE_REGION_PREFIX_PROPERTY
          A prefix to use for second-level cache region names.
static String LEGACY_HIBERNATE_CACHE_LOCAL_PUTS_ONLY_PROPERTY
          Deprecated. Deprecated version of HIBERNATE_CACHE_LOCAL_PUTS_ONLY_PROPERTY.
static String LEGACY_HIBERNATE_CACHE_QUERYCACHE_LOCAL_WRITES_ONLY_PROPERTY
          Deprecated. Deprecated version of HIBERNATE_CACHE_QUERYCACHE_LOCAL_WRITES_ONLY_PROPERTY.
 
Constructor Summary
CacheProperties(Properties properties)
           
 
Method Summary
 String getCacheObjectName()
           
 String getCacheRegionPrefix()
           
 boolean isLocalPutsOnly()
           
 boolean isQueryCacheLocalWritesOnly()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

HIBERNATE_CACHE_OBJECT_NAME_PROPERTY

public static final String HIBERNATE_CACHE_OBJECT_NAME_PROPERTY
Name of the Hibernate configuration property used to provide the ObjectName of the JBoss Cache instance.

See Also:
Constant Field Values

DEFAULT_CACHE_OBJECT_NAME

public static final String DEFAULT_CACHE_OBJECT_NAME
Default ObjectName for the JBoss Cache instance that will be used if HIBERNATE_CACHE_OBJECT_NAME_PROPERTY is not provided.

See Also:
Constant Field Values

HIBERNATE_CACHE_REGION_PREFIX_PROPERTY

public static final String HIBERNATE_CACHE_REGION_PREFIX_PROPERTY
A prefix to use for second-level cache region names. This is a very useful option when trying to segregate (quite often isolated) deployments in the Second Level Cache. Each isolated deployment would use a different region prefix.

See Also:
Constant Field Values

HIBERNATE_CACHE_QUERYCACHE_LOCAL_WRITES_ONLY_PROPERTY

public static final String HIBERNATE_CACHE_QUERYCACHE_LOCAL_WRITES_ONLY_PROPERTY
If query cache has been enabled, this property controls whether the query cache is only populated and updated locally or instead it's replicated. If the property is set to true, the query cache is only local.

See Also:
Constant Field Values

LEGACY_HIBERNATE_CACHE_QUERYCACHE_LOCAL_WRITES_ONLY_PROPERTY

public static final String LEGACY_HIBERNATE_CACHE_QUERYCACHE_LOCAL_WRITES_ONLY_PROPERTY
Deprecated. Deprecated version of HIBERNATE_CACHE_QUERYCACHE_LOCAL_WRITES_ONLY_PROPERTY.
See Also:
Constant Field Values

DEFAULT_QUERYCACHE_LOCAL_WRITES_ONLY

public static final String DEFAULT_QUERYCACHE_LOCAL_WRITES_ONLY
Default value for the JBoss Cache instance that will be used if HIBERNATE_CACHE_QUERYCACHE_LOCAL_WRITES_ONLY_PROPERTY is not provided.

See Also:
Constant Field Values

HIBERNATE_CACHE_LOCAL_PUTS_ONLY_PROPERTY

public static final String HIBERNATE_CACHE_LOCAL_PUTS_ONLY_PROPERTY
This property controls whether any put calls on the Second Level Cache as a result of a read operation from the database are done locally or not. If the property is set to true, it means that data read from database is not replicated to other nodes.

See Also:
Constant Field Values

LEGACY_HIBERNATE_CACHE_LOCAL_PUTS_ONLY_PROPERTY

public static final String LEGACY_HIBERNATE_CACHE_LOCAL_PUTS_ONLY_PROPERTY
Deprecated. Deprecated version of HIBERNATE_CACHE_LOCAL_PUTS_ONLY_PROPERTY.
See Also:
Constant Field Values

DEFAULT_LOCAL_PUTS_ONLY

public static final String DEFAULT_LOCAL_PUTS_ONLY
Default value for the JBoss Cache instance that will be used if HIBERNATE_CACHE_LOCAL_PUTS_ONLY_PROPERTY is not provided.

See Also:
Constant Field Values
Constructor Detail

CacheProperties

public CacheProperties(Properties properties)
Method Detail

getCacheObjectName

public String getCacheObjectName()

getCacheRegionPrefix

public String getCacheRegionPrefix()

isQueryCacheLocalWritesOnly

public boolean isQueryCacheLocalWritesOnly()

isLocalPutsOnly

public boolean isLocalPutsOnly()


Copyright © 2008 JBoss, a division of Red Hat, Inc.. All Rights Reserved.