Add component documentation.
Project: http://git-wip-us.apache.org/repos/asf/camel/repo Commit: http://git-wip-us.apache.org/repos/asf/camel/commit/df47d5e9 Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/df47d5e9 Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/df47d5e9 Branch: refs/heads/master Commit: df47d5e9824929b357b2a50968038c983cf70ae7 Parents: 4a861b0 Author: Claus Ibsen <davscl...@apache.org> Authored: Mon May 4 15:00:24 2015 +0200 Committer: Claus Ibsen <davscl...@apache.org> Committed: Mon May 4 15:00:24 2015 +0200 ---------------------------------------------------------------------- .../component/xmlrpc/XmlRpcConfiguration.java | 44 ++++++++++++++++++++ .../camel/component/xmlrpc/XmlRpcEndpoint.java | 11 ++++- 2 files changed, 54 insertions(+), 1 deletion(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/camel/blob/df47d5e9/components/camel-xmlrpc/src/main/java/org/apache/camel/component/xmlrpc/XmlRpcConfiguration.java ---------------------------------------------------------------------- diff --git a/components/camel-xmlrpc/src/main/java/org/apache/camel/component/xmlrpc/XmlRpcConfiguration.java b/components/camel-xmlrpc/src/main/java/org/apache/camel/component/xmlrpc/XmlRpcConfiguration.java index 40c93c6..28ec98c 100644 --- a/components/camel-xmlrpc/src/main/java/org/apache/camel/component/xmlrpc/XmlRpcConfiguration.java +++ b/components/camel-xmlrpc/src/main/java/org/apache/camel/component/xmlrpc/XmlRpcConfiguration.java @@ -58,6 +58,9 @@ public class XmlRpcConfiguration { return enabledForExtensions; } + /** + * Whether extensions are enabled. By default, the client or server is strictly compliant to the XML-RPC specification and extensions are disabled. + */ public void setEnabledForExtensions(boolean enabledForExtensions) { this.enabledForExtensions = enabledForExtensions; } @@ -66,6 +69,9 @@ public class XmlRpcConfiguration { return contentLengthOptional; } + /** + * Whether a "Content-Length" header may be omitted. The XML-RPC specification demands, that such a header be present. + */ public void setContentLengthOptional(boolean contentLengthOptional) { this.contentLengthOptional = contentLengthOptional; } @@ -74,6 +80,9 @@ public class XmlRpcConfiguration { return basicEncoding; } + /** + * Sets the encoding for basic authentication, null means UTF-8 is chosen. + */ public void setBasicEncoding(String basicEncoding) { this.basicEncoding = basicEncoding; } @@ -82,6 +91,9 @@ public class XmlRpcConfiguration { return encoding; } + /** + * Sets the requests encoding, null means UTF-8 is chosen. + */ public void setEncoding(String encoding) { this.encoding = encoding; } @@ -90,6 +102,10 @@ public class XmlRpcConfiguration { return timeZone; } + /** + * The timezone, which is used to interpret date/time. + * Defaults to {@link TimeZone#getDefault()}. + */ public void setTimeZone(TimeZone timeZone) { this.timeZone = timeZone; } @@ -98,6 +114,9 @@ public class XmlRpcConfiguration { return gzipCompressing; } + /** + * Whether gzip compression is being used for transmitting the request. + */ public void setGzipCompressing(boolean gzipCompressing) { this.gzipCompressing = gzipCompressing; } @@ -106,6 +125,9 @@ public class XmlRpcConfiguration { return gzipRequesting; } + /** + * Whether gzip compression is being used for transmitting the request. + */ public void setGzipRequesting(boolean gzipRequesting) { this.gzipRequesting = gzipRequesting; } @@ -114,6 +136,9 @@ public class XmlRpcConfiguration { return basicUserName; } + /** + * The user name for basic authentication. + */ public void setBasicUserName(String basicUserName) { this.basicUserName = basicUserName; } @@ -122,6 +147,9 @@ public class XmlRpcConfiguration { return basicPassword; } + /** + * The password for basic authentication. + */ public void setBasicPassword(String basicPassword) { this.basicPassword = basicPassword; } @@ -130,6 +158,9 @@ public class XmlRpcConfiguration { return connectionTimeout; } + /** + * Set the connection timeout in milliseconds, 0 is to disable it + */ public void setConnectionTimeout(int connectionTimeout) { this.connectionTimeout = connectionTimeout; } @@ -138,6 +169,9 @@ public class XmlRpcConfiguration { return replyTimeout; } + /** + * Set the reply timeout in milliseconds, 0 is to disable it. + */ public void setReplyTimeout(int replyTimeout) { this.replyTimeout = replyTimeout; } @@ -146,6 +180,10 @@ public class XmlRpcConfiguration { return enabledForExceptions; } + /** + * Whether the response should contain a "faultCause" element in case of errors. + * The "faultCause" is an exception, which the server has trapped and written into a byte stream as a serializable object. + */ public void setEnabledForExceptions(boolean enabledForExceptions) { this.enabledForExceptions = enabledForExceptions; } @@ -154,6 +192,9 @@ public class XmlRpcConfiguration { return xmlRpcServer; } + /** + * To use a custom XmlRpcRequestProcessor as server. + */ public void setXmlRpcServer(XmlRpcRequestProcessor xmlRpcServer) { this.xmlRpcServer = xmlRpcServer; } @@ -162,6 +203,9 @@ public class XmlRpcConfiguration { return userAgent; } + /** + * The http user agent header to set when doing xmlrpc requests + */ public void setUserAgent(String userAgent) { this.userAgent = userAgent; } http://git-wip-us.apache.org/repos/asf/camel/blob/df47d5e9/components/camel-xmlrpc/src/main/java/org/apache/camel/component/xmlrpc/XmlRpcEndpoint.java ---------------------------------------------------------------------- diff --git a/components/camel-xmlrpc/src/main/java/org/apache/camel/component/xmlrpc/XmlRpcEndpoint.java b/components/camel-xmlrpc/src/main/java/org/apache/camel/component/xmlrpc/XmlRpcEndpoint.java index 6868a39..0576d0f 100644 --- a/components/camel-xmlrpc/src/main/java/org/apache/camel/component/xmlrpc/XmlRpcEndpoint.java +++ b/components/camel-xmlrpc/src/main/java/org/apache/camel/component/xmlrpc/XmlRpcEndpoint.java @@ -104,10 +104,16 @@ public class XmlRpcEndpoint extends DefaultEndpoint { return clientConfigurer; } + /** + * To use a custom XmlRpcClientConfigurer to configure the client + */ public void setClientConfigurer(XmlRpcClientConfigurer configurer) { this.clientConfigurer = configurer; } - + + /** + * To use the given XmlRpcClientConfigImpl as configuration for the client. + */ public void setClientConfig(XmlRpcClientConfigImpl config) { this.clientConfig = config; } @@ -120,6 +126,9 @@ public class XmlRpcEndpoint extends DefaultEndpoint { return defaultMethodName; } + /** + * The method name which would be used for the xmlrpc requests by default, if the Message header CamelXmlRpcMethodName is not set. + */ public void setDefaultMethodName(String defaultMethodName) { this.defaultMethodName = defaultMethodName; }
