XML RPC

XML RPC

Scheme: xmlrpc
Syntax: xmlrpc:address
Description: The xmlrpc component is used for sending messages to a XML RPC service.
Deprecated:false
ProducerOnly:true
Async:false
Maven: org.apache.camel/camel-xmlrpc/2.18.1.redhat-000005

The xmlrpc component is used for sending messages to a XML RPC service.

Name Kind Group Required Default Type Enum Description
address path producer true java.lang.String The server url
bridgeErrorHandler parameter consumer boolean Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN/ERROR level and ignored.
exceptionHandler parameter consumer (advanced) org.apache.camel.spi.ExceptionHandler To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions, that will be logged at WARN/ERROR level and ignored.
exchangePattern parameter consumer (advanced) org.apache.camel.ExchangePattern InOnly
RobustInOnly
InOut
InOptionalOut
OutOnly
RobustOutOnly
OutIn
OutOptionalIn
Sets the exchange pattern when the consumer creates an exchange.
basicEncoding parameter producer java.lang.String Sets the encoding for basic authentication, null means UTF-8 is chosen.
connectionTimeout parameter producer int Set the connection timeout in milliseconds, 0 is to disable it
contentLengthOptional parameter producer boolean Whether a "Content-Length" header may be omitted. The XML-RPC specification demands, that such a header be present.
defaultMethodName parameter producer java.lang.String The method name which would be used for the xmlrpc requests by default, if the Message header CamelXmlRpcMethodName is not set.
enabledForExceptions parameter producer boolean 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.
enabledForExtensions parameter producer boolean Whether extensions are enabled. By default, the client or server is strictly compliant to the XML-RPC specification and extensions are disabled.
encoding parameter producer java.lang.String Sets the requests encoding, null means UTF-8 is chosen.
gzipCompressing parameter producer boolean Whether gzip compression is being used for transmitting the request.
gzipRequesting parameter producer boolean Whether gzip compression is being used for transmitting the request.
replyTimeout parameter producer int Set the reply timeout in milliseconds, 0 is to disable it.
clientConfig parameter advanced org.apache.xmlrpc.client.XmlRpcClientConfigImpl To use the given XmlRpcClientConfigImpl as configuration for the client.
clientConfigurer parameter advanced org.apache.camel.component.xmlrpc.XmlRpcClientConfigurer To use a custom XmlRpcClientConfigurer to configure the client
synchronous parameter advanced false boolean Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported).
timeZone parameter advanced java.util.TimeZone The timezone, which is used to interpret date/time. Defaults to {@link TimeZone#getDefault()}.
userAgent parameter advanced java.lang.String The http user agent header to set when doing xmlrpc requests
xmlRpcServer parameter advanced org.apache.xmlrpc.common.XmlRpcRequestProcessor To use a custom XmlRpcRequestProcessor as server.
basicPassword parameter security java.lang.String The password for basic authentication.
basicUserName parameter security java.lang.String The user name for basic authentication.