[infinispan-commits] Infinispan SVN: r494 - in trunk/core/src/main/java/org/infinispan: loaders and 2 other directories.

infinispan-commits at lists.jboss.org infinispan-commits at lists.jboss.org
Tue Jun 23 09:39:27 EDT 2009


Author: vblagojevic at jboss.com
Date: 2009-06-23 09:39:27 -0400 (Tue, 23 Jun 2009)
New Revision: 494

Modified:
   trunk/core/src/main/java/org/infinispan/config/GlobalConfiguration.java
   trunk/core/src/main/java/org/infinispan/loaders/AbstractCacheStoreConfig.java
   trunk/core/src/main/java/org/infinispan/loaders/LockSupportCacheStoreConfig.java
   trunk/core/src/main/java/org/infinispan/loaders/decorators/SingletonStoreConfig.java
   trunk/core/src/main/java/org/infinispan/loaders/file/FileCacheStoreConfig.java
Log:
[ISPN-89] - Document all configuration options available in XML

Modified: trunk/core/src/main/java/org/infinispan/config/GlobalConfiguration.java
===================================================================
--- trunk/core/src/main/java/org/infinispan/config/GlobalConfiguration.java	2009-06-23 10:55:35 UTC (rev 493)
+++ trunk/core/src/main/java/org/infinispan/config/GlobalConfiguration.java	2009-06-23 13:39:27 UTC (rev 494)
@@ -25,6 +25,14 @@
  */
 @NonVolatile
 @Scope(Scopes.GLOBAL)
+ at ConfigurationElements(elements = {
+         @ConfigurationElement(name = "global", parent = "infinispan", description = ""),
+         @ConfigurationElement(name = "asyncListenerExecutor", parent = "global", description = ""), 
+         @ConfigurationElement(name = "evictionScheduledExecutor", parent = "global", description = ""),
+         @ConfigurationElement(name = "replicationQueueScheduledExecutor", parent = "global", description = ""),  
+         @ConfigurationElement(name = "globalJmxStatistics", parent = "global", description = ""),   
+         @ConfigurationElement(name = "asyncTransportExecutor", parent = "global", description = "")
+})
 public class GlobalConfiguration extends AbstractConfigurationBean {
 
    /**
@@ -60,6 +68,9 @@
       return exposeGlobalJmxStatistics;
    }
 
+   @ConfigurationAttribute(name = "enabled", 
+            containingElement = "globalJmxStatistics", 
+            description = "If true, global JMX statistics are published")
    public void setExposeGlobalJmxStatistics(boolean exposeGlobalJmxStatistics) {
       testImmutability("exposeGlobalManagementStatistics");
       this.exposeGlobalJmxStatistics = exposeGlobalJmxStatistics;
@@ -69,6 +80,9 @@
     * If JMX statistics are enabled then all 'published' JMX objects will appear under this name. This is optional, if
     * not specified an object name will be created for you by default.
     */
+   @ConfigurationAttribute(name = "jmxDomain", 
+            containingElement = "globalJmxStatistics", 
+            description = "If JMX statistics are enabled then all 'published' JMX objects will appear under this name")
    public void setJmxDomain(String jmxObjectName) {
       testImmutability("jmxNameBase");
       this.jmxDomain = jmxObjectName;
@@ -130,6 +144,9 @@
       return asyncListenerExecutorFactoryClass;
    }
 
+   @ConfigurationAttribute(name = "factory", 
+            containingElement = "asyncListenerExecutor", 
+            description = "ExecutorService factory class for asynchronous listeners")
    public void setAsyncListenerExecutorFactoryClass(String asyncListenerExecutorFactoryClass) {
       testImmutability("asyncListenerExecutorFactoryClass");
       this.asyncListenerExecutorFactoryClass = asyncListenerExecutorFactoryClass;
@@ -148,6 +165,9 @@
       return evictionScheduledExecutorFactoryClass;
    }
 
+   @ConfigurationAttribute(name = "factory", 
+            containingElement = "evictionScheduledExecutor", 
+            description = "ExecutorService factory class for eviction threads")
    public void setEvictionScheduledExecutorFactoryClass(String evictionScheduledExecutorFactoryClass) {
       testImmutability("evictionScheduledExecutorFactoryClass");
       this.evictionScheduledExecutorFactoryClass = evictionScheduledExecutorFactoryClass;
@@ -157,6 +177,9 @@
       return replicationQueueScheduledExecutorFactoryClass;
    }
 
+   @ConfigurationAttribute(name = "factory", 
+            containingElement = "replicationQueueScheduledExecutor", 
+            description = "ExecutorService factory class for replication queue threads")
    public void setReplicationQueueScheduledExecutorFactoryClass(String replicationQueueScheduledExecutorFactoryClass) {
       testImmutability("replicationQueueScheduledExecutorFactoryClass");
       this.replicationQueueScheduledExecutorFactoryClass = replicationQueueScheduledExecutorFactoryClass;
@@ -235,7 +258,11 @@
    public Properties getAsyncListenerExecutorProperties() {
       return asyncListenerExecutorProperties;
    }
+   
 
+   @ConfigurationProperties(elements = {
+            @ConfigurationProperty(name = "maxThreads", parentElement = "asyncListenerExecutor"),
+            @ConfigurationProperty(name = "threadNamePrefix", parentElement = "asyncListenerExecutor") })
    public void setAsyncListenerExecutorProperties(Properties asyncListenerExecutorProperties) {
       testImmutability("asyncListenerExecutorProperties");
       this.asyncListenerExecutorProperties = toTypedProperties(asyncListenerExecutorProperties);

Modified: trunk/core/src/main/java/org/infinispan/loaders/AbstractCacheStoreConfig.java
===================================================================
--- trunk/core/src/main/java/org/infinispan/loaders/AbstractCacheStoreConfig.java	2009-06-23 10:55:35 UTC (rev 493)
+++ trunk/core/src/main/java/org/infinispan/loaders/AbstractCacheStoreConfig.java	2009-06-23 13:39:27 UTC (rev 494)
@@ -1,5 +1,6 @@
 package org.infinispan.loaders;
 
+import org.infinispan.config.ConfigurationAttribute;
 import org.infinispan.config.PluggableConfigurationComponent;
 import org.infinispan.loaders.decorators.AsyncStoreConfig;
 import org.infinispan.loaders.decorators.SingletonStoreConfig;
@@ -41,6 +42,9 @@
       return cacheLoaderClassName;
    }
 
+   @ConfigurationAttribute(name = "class", 
+            containingElement = "loader", 
+            description = "Full class name of a cache loader")
    public void setCacheLoaderClassName(String className) {
       if (className == null || className.length() == 0) return;
       testImmutability("cacheLoaderClassName");
@@ -55,11 +59,17 @@
       return fetchPersistentState;
    }
 
+   @ConfigurationAttribute(name = "fetchPersistentState", 
+            containingElement = "loader", 
+            description = "If true, fetch persistent state on state transfer")
    public void setFetchPersistentState(boolean fetchPersistentState) {
       testImmutability("fetchPersistentState");
       this.fetchPersistentState = fetchPersistentState;
    }
 
+   @ConfigurationAttribute(name = "ignoreModifications", 
+            containingElement = "loader",
+            description = "If true, store operations will not be sent to this loader")
    public void setIgnoreModifications(boolean ignoreModifications) {
       testImmutability("ignoreModifications");
       this.ignoreModifications = ignoreModifications;
@@ -69,6 +79,9 @@
       return ignoreModifications;
    }
 
+   @ConfigurationAttribute(name = "purgeOnStartup", 
+            containingElement = "loader", 
+            description = "If true, purge node state on startup")
    public void setPurgeOnStartup(boolean purgeOnStartup) {
       testImmutability("purgeOnStartup");
       this.purgeOnStartup = purgeOnStartup;

Modified: trunk/core/src/main/java/org/infinispan/loaders/LockSupportCacheStoreConfig.java
===================================================================
--- trunk/core/src/main/java/org/infinispan/loaders/LockSupportCacheStoreConfig.java	2009-06-23 10:55:35 UTC (rev 493)
+++ trunk/core/src/main/java/org/infinispan/loaders/LockSupportCacheStoreConfig.java	2009-06-23 13:39:27 UTC (rev 494)
@@ -1,5 +1,7 @@
 package org.infinispan.loaders;
 
+import org.infinispan.config.ConfigurationProperty;
+
 /**
  * Adds configuration support for {@link LockSupportCacheStore}.
  *
@@ -22,6 +24,9 @@
    /**
     * Sets number of threads expected to use this class concurrently.
     */
+   @ConfigurationProperty(name = "lockConcurrencyLevel", 
+            parentElement = "properties", 
+            description = "Concurrency level as integer. Default is 2048")
    public void setLockConcurrencyLevel(int lockConcurrencyLevel) {
       testImmutability("lockConcurrencyLevel");
       this.lockConcurrencyLevel = lockConcurrencyLevel;
@@ -31,6 +36,9 @@
       return lockAcquistionTimeout;
    }
 
+   @ConfigurationProperty(name = "lockAcquistionTimeout", 
+            parentElement = "properties",
+            description= "Default lock acquisition timeout as long. Default is 60000")
    public void setLockAcquistionTimeout(long lockAcquistionTimeout) {
       testImmutability("lockAcquistionTimeout");
       this.lockAcquistionTimeout = lockAcquistionTimeout;

Modified: trunk/core/src/main/java/org/infinispan/loaders/decorators/SingletonStoreConfig.java
===================================================================
--- trunk/core/src/main/java/org/infinispan/loaders/decorators/SingletonStoreConfig.java	2009-06-23 10:55:35 UTC (rev 493)
+++ trunk/core/src/main/java/org/infinispan/loaders/decorators/SingletonStoreConfig.java	2009-06-23 13:39:27 UTC (rev 494)
@@ -1,6 +1,8 @@
 package org.infinispan.loaders.decorators;
 
 import org.infinispan.config.AbstractNamedCacheConfigurationBean;
+import org.infinispan.config.ConfigurationAttribute;
+import org.infinispan.config.ConfigurationElement;
 
 /**
  * Configuration for a singleton store
@@ -8,6 +10,7 @@
  * @author Manik Surtani
  * @since 4.0
  */
+ at ConfigurationElement(name="singletonStore", parent="loader")
 public class SingletonStoreConfig extends AbstractNamedCacheConfigurationBean {
 
    private static final long serialVersionUID = 824251894176131850L;
@@ -20,6 +23,9 @@
       return singletonStoreEnabled;
    }
 
+   @ConfigurationAttribute(name = "singletonStoreEnabled", 
+            containingElement = "singletonStore",
+            description="Switch to enable singleton store")              
    public void setSingletonStoreEnabled(boolean singletonStoreEnabled) {
       testImmutability("singletonStoreEnabled");
       this.singletonStoreEnabled = singletonStoreEnabled;
@@ -30,6 +36,9 @@
       return pushStateWhenCoordinator;
    }
 
+   @ConfigurationAttribute(name = "pushStateWhenCoordinator", 
+            containingElement = "singletonStore",
+            description="TODO")
    public void setPushStateWhenCoordinator(boolean pushStateWhenCoordinator) {
       testImmutability("pushStateWhenCoordinator");
       this.pushStateWhenCoordinator = pushStateWhenCoordinator;
@@ -39,6 +48,9 @@
       return pushStateTimeout;
    }
 
+   @ConfigurationAttribute(name = "pushStateTimeout", 
+            containingElement = "singletonStore",
+            description="TODO")
    public void setPushStateTimeout(long pushStateTimeout) {
       testImmutability("pushStateTimeout");
       this.pushStateTimeout = pushStateTimeout;

Modified: trunk/core/src/main/java/org/infinispan/loaders/file/FileCacheStoreConfig.java
===================================================================
--- trunk/core/src/main/java/org/infinispan/loaders/file/FileCacheStoreConfig.java	2009-06-23 10:55:35 UTC (rev 493)
+++ trunk/core/src/main/java/org/infinispan/loaders/file/FileCacheStoreConfig.java	2009-06-23 13:39:27 UTC (rev 494)
@@ -1,5 +1,8 @@
 package org.infinispan.loaders.file;
 
+import org.infinispan.config.ConfigurationElement;
+import org.infinispan.config.ConfigurationElements;
+import org.infinispan.config.ConfigurationProperty;
 import org.infinispan.loaders.LockSupportCacheStoreConfig;
 
 /**
@@ -20,6 +23,9 @@
  * @author Manik Surtani
  * @since 4.0
  */
+ at ConfigurationElements(elements = {
+         @ConfigurationElement(name = "loader", parent = "loaders", description = "org.infinispan.loaders.file.FileCacheStore"),
+         @ConfigurationElement(name = "properties", parent = "loader") })
 public class FileCacheStoreConfig extends LockSupportCacheStoreConfig {
    String location = "Infinispan-FileCacheStore";
    private int streamBufferSize = 8192;
@@ -32,6 +38,9 @@
       return location;
    }
 
+   @ConfigurationProperty(name="location",
+            parentElement="properties",
+            description="Path to file")
    public void setLocation(String location) {
       testImmutability("location");
       this.location = location;




More information about the infinispan-commits mailing list