org.apache.camel.component.xmlrpc

Class XmlRpcEndpoint

java.lang.Object

org.apache.camel.support.ServiceSupport

org.apache.camel.impl.DefaultEndpoint

org.apache.camel.component.xmlrpc.XmlRpcEndpoint

All Implemented Interfaces:

CamelContextAware, Endpoint, IsSingleton, Service, ShutdownableService, HasId, StatefulService, SuspendableService

@UriEndpoint(scheme="xmlrpc",
             title="XML RPC",
             syntax="xmlrpc:address",
             producerOnly=true,
             label="transformation")
public class XmlRpcEndpoint
extends DefaultEndpoint

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

Field Summary

Fields inherited from class org.apache.camel.support.ServiceSupport

shutdown, shuttingdown, started, starting, stopped, stopping, suspended, suspending

Constructor Summary

Constructors

Constructor and Description
XmlRpcEndpoint()
XmlRpcEndpoint(String uri, XmlRpcComponent component, String address)

Method Summary

Modifier and Type	Method and Description
org.apache.xmlrpc.client.XmlRpcClient	createClient()
Consumer	createConsumer(Processor processor) Creates a new Event Driven Consumer which consumes messages from the endpoint using the given processor
Producer	createProducer() Creates a new producer which is used send messages into the endpoint
protected void	doStart() Implementations override this method to support customized start/stop.
String	getAddress()
org.apache.xmlrpc.client.XmlRpcClientConfigImpl	getClientConfig()
XmlRpcClientConfigurer	getClientConfigurer()
XmlRpcConfiguration	getConfiguration()
String	getDefaultMethodName()
boolean	isSingleton() Whether this class supports being singleton or not.
void	setAddress(String address) The server url
void	setClientConfig(org.apache.xmlrpc.client.XmlRpcClientConfigImpl config) To use the given XmlRpcClientConfigImpl as configuration for the client.
void	setClientConfigurer(XmlRpcClientConfigurer configurer) To use a custom XmlRpcClientConfigurer to configure the client
void	setConfiguration(XmlRpcConfiguration configuration)
void	setDefaultMethodName(String defaultMethodName) The method name which would be used for the xmlrpc requests by default, if the Message header CamelXmlRpcMethodName is not set.

Methods inherited from class org.apache.camel.impl.DefaultEndpoint

configureConsumer, configurePollingConsumer, configureProperties, createEndpointConfiguration, createEndpointUri, createExchange, createExchange, createExchange, createPollingConsumer, doStop, equals, getCamelContext, getComponent, getConsumerProperties, getEndpointConfiguration, getEndpointKey, getEndpointUri, getExceptionHandler, getExchangePattern, getId, getPollingConsumerBlockTimeout, getPollingConsumerQueueSize, hashCode, isBridgeErrorHandler, isLenientProperties, isPollingConsumerBlockWhenFull, isSynchronous, setBridgeErrorHandler, setCamelContext, setConsumerProperties, setEndpointConfiguration, setEndpointUri, setEndpointUriIfNotSpecified, setExceptionHandler, setExchangePattern, setPollingConsumerBlockTimeout, setPollingConsumerBlockWhenFull, setPollingConsumerQueueSize, setProperties, setSynchronous, toString

Methods inherited from class org.apache.camel.support.ServiceSupport

doResume, doShutdown, doSuspend, getStatus, getVersion, isRunAllowed, isStarted, isStarting, isStopped, isStopping, isStoppingOrStopped, isSuspended, isSuspending, isSuspendingOrSuspended, resume, shutdown, start, stop, suspend

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.camel.Service

start, stop

Constructor Detail

XmlRpcEndpoint

public XmlRpcEndpoint()

XmlRpcEndpoint

public XmlRpcEndpoint(String uri,
                      XmlRpcComponent component,
                      String address)

Method Detail

createProducer

public Producer createProducer()
                        throws Exception

Description copied from interface: Endpoint

Creates a new producer which is used send messages into the endpoint

Returns:

a newly created producer

Throws:

Exception - can be thrown

createConsumer

public Consumer createConsumer(Processor processor)
                        throws Exception

Description copied from interface: Endpoint

Creates a new Event Driven Consumer which consumes messages from the endpoint using the given processor

Parameters:

processor - the given processor

Returns:

a newly created consumer

Throws:

Exception - can be thrown

isSingleton

public boolean isSingleton()

Description copied from interface: IsSingleton

Whether this class supports being singleton or not.

Returns:

true to be a single shared instance, false to create new instances.

createClient

public org.apache.xmlrpc.client.XmlRpcClient createClient()
                                                   throws MalformedURLException

Throws:

MalformedURLException

getAddress

public String getAddress()

setAddress

public void setAddress(String address)

The server url

getClientConfigurer

public XmlRpcClientConfigurer getClientConfigurer()

setClientConfigurer

public void setClientConfigurer(XmlRpcClientConfigurer configurer)

To use a custom XmlRpcClientConfigurer to configure the client

setClientConfig

public void setClientConfig(org.apache.xmlrpc.client.XmlRpcClientConfigImpl config)

To use the given XmlRpcClientConfigImpl as configuration for the client.

getClientConfig

public org.apache.xmlrpc.client.XmlRpcClientConfigImpl getClientConfig()

getDefaultMethodName

public String getDefaultMethodName()

setDefaultMethodName

public void setDefaultMethodName(String defaultMethodName)

The method name which would be used for the xmlrpc requests by default, if the Message header CamelXmlRpcMethodName is not set.

getConfiguration

public XmlRpcConfiguration getConfiguration()

setConfiguration

public void setConfiguration(XmlRpcConfiguration configuration)

doStart

protected void doStart()
                throws Exception

Description copied from class: ServiceSupport

Implementations override this method to support customized start/stop.

Important: See ServiceSupport.doStop() for more details.

Overrides:

doStart in class DefaultEndpoint

Throws:

Exception

See Also:

ServiceSupport.doStop()