[infinispan-commits] Infinispan SVN: r746 - 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
Fri Aug 28 05:19:50 EDT 2009
Author: vblagojevic at jboss.com
Date: 2009-08-28 05:19:49 -0400 (Fri, 28 Aug 2009)
New Revision: 746
Modified:
trunk/core/src/main/java/org/infinispan/config/CacheLoaderManagerConfig.java
trunk/core/src/main/java/org/infinispan/config/Configuration.java
trunk/core/src/main/java/org/infinispan/config/CustomInterceptorConfig.java
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/decorators/AsyncStoreConfig.java
trunk/core/src/main/java/org/infinispan/loaders/decorators/SingletonStoreConfig.java
trunk/tools/src/main/java/org/infinispan/tools/doclet/config/ConfigHtmlGenerator.java
Log:
configuration reference documentation content completed
Modified: trunk/core/src/main/java/org/infinispan/config/CacheLoaderManagerConfig.java
===================================================================
--- trunk/core/src/main/java/org/infinispan/config/CacheLoaderManagerConfig.java 2009-08-27 12:41:34 UTC (rev 745)
+++ trunk/core/src/main/java/org/infinispan/config/CacheLoaderManagerConfig.java 2009-08-28 09:19:49 UTC (rev 746)
@@ -42,7 +42,7 @@
* provide meta data for configuration file XML schema generation. Please modify these annotations
* and Java element types they annotate with utmost understanding and care.
*
- * @configRef loaders
+ * @configRef loaders|Holds the configuration of the cache loader chain.
*
* @author <a href="mailto:manik at jboss.org">Manik Surtani (manik at jboss.org)</a>
* @author Brian Stansberry
@@ -54,12 +54,23 @@
public class CacheLoaderManagerConfig extends AbstractNamedCacheConfigurationBean {
private static final long serialVersionUID = 2210349340378984424L;
+ /**
+ * @configRef |If true, activates entries that have been passivated to a store by loading them into memory
+ * as well as writes evicted entries back to the store
+ * */
@XmlAttribute
protected Boolean passivation = false;
+ /**
+ * @configRef | If true, performs a preload on the cache loader
+ * */
@XmlAttribute
protected Boolean preload = false;
+ /**
+ * @configRef |If true, the node that makes a modification is the only one who writes it to the
+ * store using the relevant cache loader.
+ * */
@XmlAttribute
protected Boolean shared = false;
Modified: trunk/core/src/main/java/org/infinispan/config/Configuration.java
===================================================================
--- trunk/core/src/main/java/org/infinispan/config/Configuration.java 2009-08-27 12:41:34 UTC (rev 745)
+++ trunk/core/src/main/java/org/infinispan/config/Configuration.java 2009-08-28 09:19:49 UTC (rev 746)
@@ -701,17 +701,29 @@
/** The serialVersionUID */
private static final long serialVersionUID = -3867090839830874603L;
+ /**
+ * @configRef |Fully qualified class name of a class that is supposed to obtain reference to a transaction manager
+ * */
protected String transactionManagerLookupClass;
@XmlTransient
protected TransactionManagerLookup transactionManagerLookup;
+ /**
+ * @configRef |If true, commit phase will be done as a synchronous call
+ * */
@Dynamic
protected Boolean syncCommitPhase = false;
+ /**
+ * @configRef |If true, rollback phase will be done as a synchronous call
+ * */
@Dynamic
protected Boolean syncRollbackPhase = false;
+ /**
+ * @configRef |If true, eagerly lock cache keys across cluster instead of during two-phase prepare/commit phase
+ * */
@Dynamic
protected Boolean useEagerLocking = false;
@@ -822,6 +834,9 @@
/** The serialVersionUID */
private static final long serialVersionUID = 4048135465543498430L;
+ /**
+ * @configRef mode|Cache replication mode
+ * */
@XmlAttribute(name="mode")
protected String stringMode;
@@ -1209,7 +1224,9 @@
/** @configRef |Toggle to enable/disable deadlock detection*/
protected Boolean enabled=false;
- /** @configRef |todo*/
+ /** @configRef |Time period that determines how often is lock acquisition attempted
+ * within maximum time allowed to acquire a particular lock
+ * */
protected Long spinDuration=100L;
@XmlAttribute
@@ -1227,7 +1244,10 @@
/**
*
- * @configRef unsafe|Allows you to tune various unsafe or non-standard characteristics. Use with care.
+ * @configRef unsafe|Allows you to tune various unsafe or non-standard characteristics. Certain operations
+ * such as Cache.put() that are supposed to return the previous value associated with the specified key according
+ * to the java.util.Map contract will not fulfill this contract if unsafe toggle is turned on. Use with care.
+ * See details at http://www.jboss.org/community/wiki/infinispantechnicalfaqs
*/
@XmlAccessorType(XmlAccessType.PROPERTY)
private static class UnsafeType extends AbstractNamedCacheConfigurationBean{
@@ -1235,7 +1255,7 @@
/** The serialVersionUID */
private static final long serialVersionUID = -9200921443651234163L;
- /** @configRef |See http://www.jboss.org/community/wiki/infinispantechnicalfaqs */
+ /** @configRef |Toggle to enable/disable return value fetching */
protected Boolean unreliableReturnValues=false;
@XmlAttribute
Modified: trunk/core/src/main/java/org/infinispan/config/CustomInterceptorConfig.java
===================================================================
--- trunk/core/src/main/java/org/infinispan/config/CustomInterceptorConfig.java 2009-08-27 12:41:34 UTC (rev 745)
+++ trunk/core/src/main/java/org/infinispan/config/CustomInterceptorConfig.java 2009-08-28 09:19:49 UTC (rev 746)
@@ -43,7 +43,7 @@
* provide meta data for configuration file XML schema generation. Please modify these annotations
* and Java element types they annotate with utmost understanding and care.
*
- * @configRef interceptor
+ * @configRef interceptor|Holds information about the custom interceptors defined in the configuration file.
*
* @author Mircea.Markus at jboss.com
* @author Vladimir Blagojevic
@@ -63,15 +63,27 @@
@XmlTransient
protected boolean isLast;
+ /**
+ * @configRef |Position this interceptor at the specified valid index of the interceptor chain
+ * */
@XmlAttribute
protected Integer index = -1;
+ /**
+ * @configRef |Position this interceptor after the inteceptor specified by intereceptor's fully qualified class name
+ * */
@XmlAttribute
protected String after;
+ /**
+ * @configRef |Position this interceptor before the inteceptor specified by intereceptor's fully qualified class name
+ * */
@XmlAttribute
protected String before;
+ /**
+ * @configRef |Position this interceptor as either FIRST or LAST intereceptor
+ * */
@XmlAttribute
protected Position position;
Modified: trunk/core/src/main/java/org/infinispan/config/GlobalConfiguration.java
===================================================================
--- trunk/core/src/main/java/org/infinispan/config/GlobalConfiguration.java 2009-08-27 12:41:34 UTC (rev 745)
+++ trunk/core/src/main/java/org/infinispan/config/GlobalConfiguration.java 2009-08-28 09:19:49 UTC (rev 746)
@@ -484,10 +484,10 @@
@XmlAccessorType(XmlAccessType.PROPERTY)
private static class TransportType extends AbstractConfigurationBeanWithGCR {
- /** @configRef |todo */
+ /** @configRef |Cluster name where all cache instances defined are connected */
protected String clusterName = "Infinispan-Cluster";
- /** @configRef |todo */
+ /** @configRef |todo */
protected Long distributedSyncTimeout = 60000L; // default
/** @configRef | Fully qualified name of a class that implements network transport*/
@@ -584,7 +584,7 @@
/** @configRef |Fully qualified name of class that will attempt to find JMX MBean server */
protected String mBeanServerLookup = PlatformMBeanServerLookup.class.getName();
- /** @configRef |todo */
+ /** @configRef |If true, multiple cache manager instances could be configured under the same JMX domain */
protected Boolean allowDuplicateDomains = false;
@XmlAttribute
Modified: trunk/core/src/main/java/org/infinispan/loaders/AbstractCacheStoreConfig.java
===================================================================
--- trunk/core/src/main/java/org/infinispan/loaders/AbstractCacheStoreConfig.java 2009-08-27 12:41:34 UTC (rev 745)
+++ trunk/core/src/main/java/org/infinispan/loaders/AbstractCacheStoreConfig.java 2009-08-28 09:19:49 UTC (rev 746)
@@ -25,7 +25,7 @@
* provide meta data for configuration file XML schema generation. Please modify these annotations
* and Java element types they annotate with utmost understanding and care.
*
- * @configRef loader
+ * @configRef loader|Responsible for loading/storing cache data from/to an external source.
*
* @author Mircea.Markus at jboss.com
* @since 4.0
@@ -53,7 +53,7 @@
protected Boolean purgeOnStartup = false;
/**
- * @configRef |If true, and purging is turned on, purge on startup will be done synchronously
+ * @configRef |If true, CacheStore#purgeExpired() call will be done synchronously
* */
@XmlAttribute
protected Boolean purgeSynchronously = false;
Modified: trunk/core/src/main/java/org/infinispan/loaders/decorators/AsyncStoreConfig.java
===================================================================
--- trunk/core/src/main/java/org/infinispan/loaders/decorators/AsyncStoreConfig.java 2009-08-27 12:41:34 UTC (rev 745)
+++ trunk/core/src/main/java/org/infinispan/loaders/decorators/AsyncStoreConfig.java 2009-08-28 09:19:49 UTC (rev 746)
@@ -16,7 +16,7 @@
* provide meta data for configuration file XML schema generation. Please modify these annotations
* and Java element types they annotate with utmost understanding and care.
*
- * @configRef async:loader:
+ * @configRef async:loader:|Configuration for the async cache loader.
*
* @author Manik Surtani
* @author Vladimir Blagojevic
Modified: trunk/core/src/main/java/org/infinispan/loaders/decorators/SingletonStoreConfig.java
===================================================================
--- trunk/core/src/main/java/org/infinispan/loaders/decorators/SingletonStoreConfig.java 2009-08-27 12:41:34 UTC (rev 745)
+++ trunk/core/src/main/java/org/infinispan/loaders/decorators/SingletonStoreConfig.java 2009-08-28 09:19:49 UTC (rev 746)
@@ -15,7 +15,10 @@
* provide meta data for configuration file XML schema generation. Please modify these annotations
* and Java element types they annotate with utmost understanding and care.
*
- * @configRef singletonStore
+ * @configRef singletonStore|SingletonStore is a delegating cache store used for situations when only one
+ * instance should interact with the underlying store. The coordinator of the cluster will be responsible for
+ * the underlying CacheStore. SingletonStore is a simply facade to a real CacheStore implementation. It always
+ * delegates reads to the real CacheStore.
*
* @author Manik Surtani
* @author Vladimir Blagojevic
@@ -26,12 +29,22 @@
private static final long serialVersionUID = 824251894176131850L;
+ /**
+ * @configRef |If true, the relevant cache store is turned into singleton store
+ * */
@XmlAttribute
protected Boolean enabled = false;
+ /**
+ * @configRef |If true and the node becomes the coordinator, the in-memory state transfer
+ * to the underlying cache store is initiated
+ * */
@XmlAttribute
protected Boolean pushStateWhenCoordinator = true;
+ /**
+ * @configRef |If pushStateWhenCoordinator is true, the in-memory state transfer to cache store timeout
+ * */
@XmlAttribute
protected Long pushStateTimeout = 10000L;
Modified: trunk/tools/src/main/java/org/infinispan/tools/doclet/config/ConfigHtmlGenerator.java
===================================================================
--- trunk/tools/src/main/java/org/infinispan/tools/doclet/config/ConfigHtmlGenerator.java 2009-08-27 12:41:34 UTC (rev 745)
+++ trunk/tools/src/main/java/org/infinispan/tools/doclet/config/ConfigHtmlGenerator.java 2009-08-28 09:19:49 UTC (rev 746)
@@ -334,7 +334,7 @@
}
}
if (c.getSuperclass() != null)
- findFieldDocRecursively(c.getSuperclass(), fieldName, tagName);
+ return findFieldDocRecursively(c.getSuperclass(), fieldName, tagName);
return null;
}
More information about the infinispan-commits
mailing list