Author: gertv
Date: Tue Dec 7 19:25:49 2010
New Revision: 1043170
URL: http://svn.apache.org/viewvc?rev=1043170&view=rev
Log:
Add better javadocs to improve generated wiki/xsd documentation
Modified:
servicemix/components/engines/servicemix-validation/trunk/pom.xml
servicemix/components/engines/servicemix-validation/trunk/src/main/java/org/apache/servicemix/validation/ValidationEndpoint.java
Modified: servicemix/components/engines/servicemix-validation/trunk/pom.xml
URL:
http://svn.apache.org/viewvc/servicemix/components/engines/servicemix-validation/trunk/pom.xml?rev=1043170&r1=1043169&r2=1043170&view=diff
==============================================================================
--- servicemix/components/engines/servicemix-validation/trunk/pom.xml (original)
+++ servicemix/components/engines/servicemix-validation/trunk/pom.xml Tue Dec
7 19:25:49 2010
@@ -102,6 +102,13 @@
</exclusion>
</exclusions>
</dependency>
+
+ <!-- documentation -->
+ <dependency>
+ <groupId>org.apache.servicemix</groupId>
+ <artifactId>servicemix-common</artifactId>
+ <classifier>sources</classifier>
+ </dependency>
</dependencies>
<build>
Modified:
servicemix/components/engines/servicemix-validation/trunk/src/main/java/org/apache/servicemix/validation/ValidationEndpoint.java
URL:
http://svn.apache.org/viewvc/servicemix/components/engines/servicemix-validation/trunk/src/main/java/org/apache/servicemix/validation/ValidationEndpoint.java?rev=1043170&r1=1043169&r2=1043170&view=diff
==============================================================================
---
servicemix/components/engines/servicemix-validation/trunk/src/main/java/org/apache/servicemix/validation/ValidationEndpoint.java
(original)
+++
servicemix/components/engines/servicemix-validation/trunk/src/main/java/org/apache/servicemix/validation/ValidationEndpoint.java
Tue Dec 7 19:25:49 2010
@@ -349,6 +349,17 @@ public class ValidationEndpoint extends
return handlingErrorMethod;
}
+ /**
+ * Configure the way errors are being handled. Default value is
<code>FAULT_JBI</code>.
+ * <dl>
+ * <dt><code>FAULT_JBI</code><dt>
+ * <dd>A validation error will result in a JBI exception</dd>
+ * <dt><code>FAULT_FLOW</code></dt>
+ * <dd>Validation errors will be sent back in XML format as the 'out' or
'fault' message</dd>
+ * </dl>
+ *
+ * @param handlingErrorMethod
+ */
public void setHandlingErrorMethod(String handlingErrorMethod) {
this.handlingErrorMethod = handlingErrorMethod;
}
@@ -357,6 +368,11 @@ public class ValidationEndpoint extends
return schema;
}
+ /**
+ * Configure the Schema instance used for validating the messages.
+ *
+ * @param schema
+ */
public void setSchema(Schema schema) {
this.schema = schema;
}
@@ -365,6 +381,11 @@ public class ValidationEndpoint extends
return schemaLanguage;
}
+ /**
+ * Configure the schema language used for validation. Defaults to
<code>http://www.w3.org/2001/XMLSchema</code>
+ *
+ * @param schemaLanguage
+ */
public void setSchemaLanguage(String schemaLanguage) {
this.schemaLanguage = schemaLanguage;
}
@@ -373,6 +394,11 @@ public class ValidationEndpoint extends
return schemaSource;
}
+ /**
+ * Configure the XML Source defining the schema used for validating the
messages.
+ *
+ * @param schemaSource
+ */
public void setSchemaSource(Source schemaSource) {
this.schemaSource = schemaSource;
}
@@ -381,6 +407,11 @@ public class ValidationEndpoint extends
return schemaResource;
}
+ /**
+ * Configure a Spring Resource for retrieving the schema used for
validating the messages.
+ *
+ * @param schemaResource
+ */
public void setSchemaResource(Resource schemaResource) {
this.schemaResource = schemaResource;
}
@@ -388,7 +419,13 @@ public class ValidationEndpoint extends
public Resource getNoNamespaceSchemaResource() {
return noNamespaceSchemaResource;
}
-
+
+ /**
+ * Configure a Spring resource for retrieving the schema that is used for
validating messages that don't carry
+ * a namespace.
+ *
+ * @param schemaResource
+ */
public void setNoNamespaceSchemaResource(Resource schemaResource) {
this.noNamespaceSchemaResource = schemaResource;
}
@@ -397,6 +434,12 @@ public class ValidationEndpoint extends
return errorHandlerFactory;
}
+ /**
+ * Configure the {...@link
org.apache.servicemix.validation.handler.MessageAwareErrorHandlerFactory} used
for handling validation errors.
+ * Defaults to {...@link
org.apache.servicemix.validation.handler.CountingErrorHandlerFactory}, which
just counts the number of warnings, errors and fatal errors.
+ *
+ * @param errorHandlerFactory
+ */
public void setErrorHandlerFactory(
MessageAwareErrorHandlerFactory errorHandlerFactory) {
this.errorHandlerFactory = errorHandlerFactory;
