camel-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From davscl...@apache.org
Subject [1/3] camel git commit: CAMEL-8195: Add javadoc to model classes so we have EIP documentation out of the box
Date Mon, 19 Jan 2015 15:25:18 GMT
Repository: camel
Updated Branches:
  refs/heads/master 4e58755f6 -> 2aa1570b9


CAMEL-8195: Add javadoc to model classes so we have EIP documentation out of the box


Project: http://git-wip-us.apache.org/repos/asf/camel/repo
Commit: http://git-wip-us.apache.org/repos/asf/camel/commit/2aa1570b
Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/2aa1570b
Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/2aa1570b

Branch: refs/heads/master
Commit: 2aa1570b973e1efa6bd26793e7f438c9c75b32ec
Parents: d369b5f
Author: Claus Ibsen <davsclaus@apache.org>
Authored: Mon Jan 19 16:23:16 2015 +0100
Committer: Claus Ibsen <davsclaus@apache.org>
Committed: Mon Jan 19 16:25:09 2015 +0100

----------------------------------------------------------------------
 .../model/dataformat/CastorDataFormat.java      | 19 +++++++++++
 .../model/dataformat/CryptoDataFormat.java      | 33 ++++++++++++++++++++
 2 files changed, 52 insertions(+)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/camel/blob/2aa1570b/camel-core/src/main/java/org/apache/camel/model/dataformat/CastorDataFormat.java
----------------------------------------------------------------------
diff --git a/camel-core/src/main/java/org/apache/camel/model/dataformat/CastorDataFormat.java
b/camel-core/src/main/java/org/apache/camel/model/dataformat/CastorDataFormat.java
index 70afce8..0d03e36 100644
--- a/camel-core/src/main/java/org/apache/camel/model/dataformat/CastorDataFormat.java
+++ b/camel-core/src/main/java/org/apache/camel/model/dataformat/CastorDataFormat.java
@@ -59,6 +59,11 @@ public class CastorDataFormat extends DataFormatDefinition {
         return validation;
     }
 
+    /**
+     * Whether validation is turned on or off.
+     * <p/>
+     * Is by default true.
+     */
     public void setValidation(Boolean validation) {
         this.validation = validation;
     }
@@ -67,6 +72,9 @@ public class CastorDataFormat extends DataFormatDefinition {
         return mappingFile;
     }
 
+    /**
+     * Path to a Castor mapping file to load from the classpath.
+     */
     public void setMappingFile(String mappingFile) {
         this.mappingFile = mappingFile;
     }
@@ -75,6 +83,9 @@ public class CastorDataFormat extends DataFormatDefinition {
         return packages;
     }
 
+    /**
+     * Add additional packages to Castor XmlContext
+     */
     public void setPackages(String[] packages) {
         this.packages = packages;
     }
@@ -83,6 +94,9 @@ public class CastorDataFormat extends DataFormatDefinition {
         return classes;
     }
 
+    /**
+     * Add additional class names to Castor XmlContext
+     */
     public void setClasses(String[] classes) {
         this.classes = classes;
     }
@@ -91,6 +105,11 @@ public class CastorDataFormat extends DataFormatDefinition {
         return encoding;
     }
 
+    /**
+     * Encoding to use when marshalling an Object to XML.
+     * <p/>
+     * Is by default UTF-8
+     */
     public void setEncoding(String encoding) {
         this.encoding = encoding;
     }

http://git-wip-us.apache.org/repos/asf/camel/blob/2aa1570b/camel-core/src/main/java/org/apache/camel/model/dataformat/CryptoDataFormat.java
----------------------------------------------------------------------
diff --git a/camel-core/src/main/java/org/apache/camel/model/dataformat/CryptoDataFormat.java
b/camel-core/src/main/java/org/apache/camel/model/dataformat/CryptoDataFormat.java
index 6d55acb..327da9a 100644
--- a/camel-core/src/main/java/org/apache/camel/model/dataformat/CryptoDataFormat.java
+++ b/camel-core/src/main/java/org/apache/camel/model/dataformat/CryptoDataFormat.java
@@ -115,6 +115,11 @@ public class CryptoDataFormat extends DataFormatDefinition {
         return algorithm;
     }
 
+    /**
+     * The JCE algorithm name indicating the cryptographic algorithm that will be used.
+     * <p/>
+     * Is by default DES/CBC/PKCS5Padding.
+     */
     public void setAlgorithm(String algorithm) {
         this.algorithm = algorithm;
     }
@@ -123,6 +128,9 @@ public class CryptoDataFormat extends DataFormatDefinition {
         return cryptoProvider;
     }
 
+    /**
+     * The name of the JCE Security Provider that should be used.
+     */
     public void setCryptoProvider(String cryptoProvider) {
         this.cryptoProvider = cryptoProvider;
     }
@@ -131,6 +139,9 @@ public class CryptoDataFormat extends DataFormatDefinition {
         return keyRef;
     }
 
+    /**
+     * Refers to the secret key to lookup from the register to use.
+     */
     public void setKeyRef(String keyRef) {
         this.keyRef = keyRef;
     }
@@ -139,6 +150,9 @@ public class CryptoDataFormat extends DataFormatDefinition {
         return initVectorRef;
     }
 
+    /**
+     * Refers to a byte array containing the Initialization Vector that will be used to initialize
the Cipher.
+     */
     public void setInitVectorRef(String initVectorRef) {
         this.initVectorRef = initVectorRef;
     }
@@ -147,6 +161,11 @@ public class CryptoDataFormat extends DataFormatDefinition {
         return algorithmParameterRef;
     }
 
+    /**
+     * A JCE AlgorithmParameterSpec used to initialize the Cipher.
+     * <p/>
+     * Will lookup the type using the given name as a {@link java.security.spec.AlgorithmParameterSpec}
type.
+     */
     public void setAlgorithmParameterRef(String algorithmParameterRef) {
         this.algorithmParameterRef = algorithmParameterRef;
     }
@@ -155,6 +174,9 @@ public class CryptoDataFormat extends DataFormatDefinition {
         return buffersize;
     }
 
+    /**
+     * The size of the buffer used in the signature process.
+     */
     public void setBuffersize(Integer buffersize) {
         this.buffersize = buffersize;
     }
@@ -163,6 +185,9 @@ public class CryptoDataFormat extends DataFormatDefinition {
         return macAlgorithm;
     }
 
+    /**
+     * The JCE algorithm name indicating the Message Authentication algorithm.
+     */
     public void setMacAlgorithm(String macAlgorithm) {
         this.macAlgorithm = macAlgorithm;
     }
@@ -171,6 +196,9 @@ public class CryptoDataFormat extends DataFormatDefinition {
         return shouldAppendHMAC;
     }
 
+    /**
+     * Flag indicating that a Message Authentication Code should be calculated and appended
to the encrypted data.
+     */
     public void setShouldAppendHMAC(Boolean shouldAppendHMAC) {
         this.shouldAppendHMAC = shouldAppendHMAC;
     }
@@ -179,6 +207,11 @@ public class CryptoDataFormat extends DataFormatDefinition {
         return inline;
     }
 
+    /**
+     * Flag indicating that the configured IV should be inlined into the encrypted data stream.
+     * <p/>
+     * Is by default false.
+     */
     public void setInline(Boolean inline) {
         this.inline = inline;
     }


Mime
View raw message