You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@synapse.apache.org by su...@apache.org on 2010/05/08 09:03:37 UTC
svn commit: r942324 - in
/synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators:
./ config/
Author: supun
Date: Sat May 8 07:03:37 2010
New Revision: 942324
URL: http://svn.apache.org/viewvc?rev=942324&view=rev
Log:
Improving the documentation
Modified:
synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators/AndEvaluator.java
synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators/Condition.java
synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators/EqualEvaluator.java
synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators/EvaluatorException.java
synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators/MatchEvaluator.java
synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators/NotEvaluator.java
synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators/OrEvaluator.java
synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators/config/AndFactory.java
synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators/config/ConditionFactory.java
synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators/config/EqualFactory.java
synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators/config/EvaluatorFactory.java
synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators/config/EvaluatorFactoryFinder.java
synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators/config/MatchFactory.java
synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators/config/NotFactory.java
synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators/config/OrFactory.java
Modified: synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators/AndEvaluator.java
URL: http://svn.apache.org/viewvc/synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators/AndEvaluator.java?rev=942324&r1=942323&r2=942324&view=diff
==============================================================================
--- synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators/AndEvaluator.java (original)
+++ synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators/AndEvaluator.java Sat May 8 07:03:37 2010
@@ -21,7 +21,9 @@ package org.apache.synapse.commons.evalu
/**
* This encapsulates two or more boolean conditions. This acts as the "and"
- * boolean operator.
+ * boolean operator. This evaluates all the boolean expressions and return
+ * the Boolean AND of those expressions.</p>
+ *
* <pre>
* <and>
* two or more evaluators
Modified: synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators/Condition.java
URL: http://svn.apache.org/viewvc/synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators/Condition.java?rev=942324&r1=942323&r2=942324&view=diff
==============================================================================
--- synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators/Condition.java (original)
+++ synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators/Condition.java Sat May 8 07:03:37 2010
@@ -20,8 +20,7 @@
package org.apache.synapse.commons.evaluators;
/**
- * Encapsulates a condition. Every condition has a priority
- * and a boolean expression.
+ * Encapsulates a condition. Every condition has a priority and a boolean expression.
*/
public class Condition {
private int priority = 0;
Modified: synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators/EqualEvaluator.java
URL: http://svn.apache.org/viewvc/synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators/EqualEvaluator.java?rev=942324&r1=942323&r2=942324&view=diff
==============================================================================
--- synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators/EqualEvaluator.java (original)
+++ synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators/EqualEvaluator.java Sat May 8 07:03:37 2010
@@ -26,7 +26,7 @@ import java.io.UnsupportedEncodingExcept
/**
* Try to see weather a part of the HTTP request is equal to the value provided.
- * If the values are equal retun true
+ * If the values are equal retun true.</p>
* <pre>
* <equal type="header | param | url" source="" value=""/>
* </pre>
Modified: synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators/EvaluatorException.java
URL: http://svn.apache.org/viewvc/synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators/EvaluatorException.java?rev=942324&r1=942323&r2=942324&view=diff
==============================================================================
--- synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators/EvaluatorException.java (original)
+++ synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators/EvaluatorException.java Sat May 8 07:03:37 2010
@@ -20,6 +20,10 @@
package org.apache.synapse.commons.evaluators;
+/**
+ * An Exception used by Evaluators to signal configuration errors as
+ * well as execution errors.
+ */
public class EvaluatorException extends Exception {
public EvaluatorException(String message, Throwable cause) {
Modified: synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators/MatchEvaluator.java
URL: http://svn.apache.org/viewvc/synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators/MatchEvaluator.java?rev=942324&r1=942323&r2=942324&view=diff
==============================================================================
--- synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators/MatchEvaluator.java (original)
+++ synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators/MatchEvaluator.java Sat May 8 07:03:37 2010
@@ -27,13 +27,13 @@ import java.util.regex.Matcher;
import java.io.UnsupportedEncodingException;
/**
- * This evaluator uses regular expressions to match a given HTTP request.
+ * This evaluator uses regular expressions to match a given HTTP request.</p>
*
* <pre>
* <match type="header | param | url" source="" regex=""/>
* </pre>
- *
- * The source is used to extract the HTTP header or URL param
+ * <p>
+ * The source is used to extract the HTTP header or URL param</p>
*/
@SuppressWarnings({"UnusedDeclaration"})
public class MatchEvaluator implements Evaluator {
Modified: synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators/NotEvaluator.java
URL: http://svn.apache.org/viewvc/synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators/NotEvaluator.java?rev=942324&r1=942323&r2=942324&view=diff
==============================================================================
--- synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators/NotEvaluator.java (original)
+++ synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators/NotEvaluator.java Sat May 8 07:03:37 2010
@@ -20,7 +20,8 @@
package org.apache.synapse.commons.evaluators;
/**
- * This encapsulates boolean condition. This acts as not boolean operator.
+ * This encapsulates a boolean expression. This acts as not boolean operator.
+ * It executes the boolean expression inside and return the NOT of this expression.</p>
*
* <pre>
* <not>
Modified: synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators/OrEvaluator.java
URL: http://svn.apache.org/viewvc/synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators/OrEvaluator.java?rev=942324&r1=942323&r2=942324&view=diff
==============================================================================
--- synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators/OrEvaluator.java (original)
+++ synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators/OrEvaluator.java Sat May 8 07:03:37 2010
@@ -20,8 +20,9 @@
package org.apache.synapse.commons.evaluators;
/**
- * This encapsulates two or more boolean conditions. This acts as the "or"
- * boolean operator.
+ * This encapsulates two or more boolean expressions. This acts as the "or"
+ * boolean operator. It executes all the boolean expressions and apply the boolean
+ * OR operator and return the result of this boolean operation.</p>
*
* <pre>
* <or>
Modified: synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators/config/AndFactory.java
URL: http://svn.apache.org/viewvc/synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators/config/AndFactory.java?rev=942324&r1=942323&r2=942324&view=diff
==============================================================================
--- synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators/config/AndFactory.java (original)
+++ synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators/config/AndFactory.java Sat May 8 07:03:37 2010
@@ -30,6 +30,16 @@ import java.util.Iterator;
import java.util.List;
import java.util.ArrayList;
+/**
+ * <p>This factory creates a <code>AndEvaluator</code>. This factory expects the
+ * following XML configuration to create the AndEvaluator.</p>
+ * <pre>
+ * <and>
+ * two or more evaluators
+ * <and>
+ * </pre>
+ */
+
public class AndFactory implements EvaluatorFactory {
private Log log = LogFactory.getLog(AndFactory.class);
Modified: synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators/config/ConditionFactory.java
URL: http://svn.apache.org/viewvc/synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators/config/ConditionFactory.java?rev=942324&r1=942323&r2=942324&view=diff
==============================================================================
--- synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators/config/ConditionFactory.java (original)
+++ synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators/config/ConditionFactory.java Sat May 8 07:03:37 2010
@@ -30,6 +30,13 @@ import org.apache.commons.logging.Log;
import javax.xml.namespace.QName;
+/**
+ * This factory creates a <code>Condition</code> using the following XML configuration.</p>
+ * <pre>
+ * <condition priority="priority value as an integer">
+ * one evaluator, this evaluator can contain other evaluators
+ * </condition></pre>
+ */
public class ConditionFactory {
private Log log = LogFactory.getLog(ConditionFactory.class);
Modified: synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators/config/EqualFactory.java
URL: http://svn.apache.org/viewvc/synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators/config/EqualFactory.java?rev=942324&r1=942323&r2=942324&view=diff
==============================================================================
--- synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators/config/EqualFactory.java (original)
+++ synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators/config/EqualFactory.java Sat May 8 07:03:37 2010
@@ -30,6 +30,13 @@ import org.apache.commons.logging.LogFac
import javax.xml.namespace.QName;
+/**
+ * <p> This factory creates a <code>EqualEvaluator</code>. This factory expects the
+ * following XML configuration.</p>
+ * <pre>
+ * <equal type="header | param | url" source="" value=""/>
+ * </pre>
+ */
public class EqualFactory implements EvaluatorFactory {
private Log log = LogFactory.getLog(EqualFactory.class);
Modified: synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators/config/EvaluatorFactory.java
URL: http://svn.apache.org/viewvc/synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators/config/EvaluatorFactory.java?rev=942324&r1=942323&r2=942324&view=diff
==============================================================================
--- synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators/config/EvaluatorFactory.java (original)
+++ synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators/config/EvaluatorFactory.java Sat May 8 07:03:37 2010
@@ -25,7 +25,7 @@ import org.apache.synapse.commons.evalua
import org.apache.axiom.om.OMElement;
/**
- * This should be implemented by all the Factories creating an evaluators.
+ * This should be implemented by the Factories creating evaluators.
*/
public interface EvaluatorFactory {
Modified: synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators/config/EvaluatorFactoryFinder.java
URL: http://svn.apache.org/viewvc/synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators/config/EvaluatorFactoryFinder.java?rev=942324&r1=942323&r2=942324&view=diff
==============================================================================
--- synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators/config/EvaluatorFactoryFinder.java (original)
+++ synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators/config/EvaluatorFactoryFinder.java Sat May 8 07:03:37 2010
@@ -29,8 +29,12 @@ import org.apache.synapse.commons.evalua
import java.util.Map;
import java.util.HashMap;
+/**
+ * Factories for Evaluators are found using the evaluator name. This class stores
+ * information about Evaluator Factories and their corresponding names. This class
+ * is a Singleton class.
+ */
public class EvaluatorFactoryFinder {
-
private static final Log log = LogFactory.getLog(EvaluatorFactoryFinder.class);
private static final EvaluatorFactoryFinder finder = new EvaluatorFactoryFinder();
@@ -45,14 +49,30 @@ public class EvaluatorFactoryFinder {
factories.put(EvaluatorConstants.EQUAL, new EqualFactory());
}
+ /**
+ * Return and instance of the <code>EvaluatorFactoryFinder</code>.
+ * @return the EvaluatorFactoryFinder singleton
+ */
public static EvaluatorFactoryFinder getInstance() {
return finder;
}
+ /**
+ * Retun an <code>EvaluatorFactory</code> for a given Evaluator name.
+ * @param name name of the Evaluator
+ * @return an EvaluatorFactory
+ */
public EvaluatorFactory findEvaluatorFactory(String name) {
return factories.get(name);
}
+ /**
+ * Retun an <code>EvaluatorFactory</code> for a given Evaluator name.
+ * @param elem A XML element containing the evaluator configuration
+ * @return an Evaluator
+ * @throws org.apache.synapse.commons.evaluators.EvaluatorException if it cannot find
+ * a corresponding factory for creating an evaluator
+ */
public Evaluator getEvaluator(OMElement elem) throws EvaluatorException {
EvaluatorFactory fac = findEvaluatorFactory(elem.getLocalName());
@@ -69,5 +89,4 @@ public class EvaluatorFactoryFinder {
log.error(message);
throw new EvaluatorException(message);
}
-
}
Modified: synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators/config/MatchFactory.java
URL: http://svn.apache.org/viewvc/synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators/config/MatchFactory.java?rev=942324&r1=942323&r2=942324&view=diff
==============================================================================
--- synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators/config/MatchFactory.java (original)
+++ synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators/config/MatchFactory.java Sat May 8 07:03:37 2010
@@ -32,6 +32,13 @@ import org.apache.commons.logging.LogFac
import javax.xml.namespace.QName;
import java.util.regex.Pattern;
+/**
+ * This Factory creates a <code>MatchEvaluator</code> using the following XML configuration.</p>
+ *
+ * <pre>
+ * <match type="header | param | url" source="" regex=""/>
+ * </pre>
+ */
public class MatchFactory implements EvaluatorFactory {
private Log log = LogFactory.getLog(MatchFactory.class);
Modified: synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators/config/NotFactory.java
URL: http://svn.apache.org/viewvc/synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators/config/NotFactory.java?rev=942324&r1=942323&r2=942324&view=diff
==============================================================================
--- synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators/config/NotFactory.java (original)
+++ synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators/config/NotFactory.java Sat May 8 07:03:37 2010
@@ -27,7 +27,15 @@ import org.apache.axiom.om.OMElement;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
-
+/**
+ * This Factory creates a <code>NotEvaluator</code> from the following XML configuration.</p>
+ *
+ * <pre>
+ * <not>
+ * one evaluator
+ * </not>
+ * </pre>
+ */
public class NotFactory implements EvaluatorFactory {
private Log log = LogFactory.getLog(NotFactory.class);
Modified: synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators/config/OrFactory.java
URL: http://svn.apache.org/viewvc/synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators/config/OrFactory.java?rev=942324&r1=942323&r2=942324&view=diff
==============================================================================
--- synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators/config/OrFactory.java (original)
+++ synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/evaluators/config/OrFactory.java Sat May 8 07:03:37 2010
@@ -31,6 +31,15 @@ import java.util.Iterator;
import java.util.List;
import java.util.ArrayList;
+/**
+ * This factory creates a <code>OrFactory</code> using the following XML configuration.</p>
+ *
+ * <pre>
+ * <or>
+ * two or more evaluators
+ * </or>
+ * </pre>
+ */
public class OrFactory implements EvaluatorFactory {
private Log log = LogFactory.getLog(OrFactory.class);