org.mule.runtime.core.api.client

Interface MuleClient

All Known Implementing Classes:

DefaultLocalMuleClient

public interface MuleClient

Provides methods for performing send, dispatch and request operations programmatically.

Method Summary

Modifier and Type	Method and Description
void	dispatch(String url, org.mule.runtime.api.message.Message message) Dispatches an event asynchronously to a endpointUri via a Mule server.
void	dispatch(String url, org.mule.runtime.api.message.Message message, OperationOptions operationOptions) Dispatches an event asynchronously to a endpointUri via a Mule server.
void	dispatch(String url, Object payload, Map<String,Serializable> messageProperties) Deprecated. use dispatch(String, Message) instead Dispatches an event asynchronously to a endpointUri via a Mule server. The URL determines where to dispatch the event to.
Either<org.mule.runtime.api.message.Error,Optional<org.mule.runtime.api.message.Message>>	request(String url, long timeout) Will receive an event from an endpointUri determined by the URL.
Either<org.mule.runtime.api.message.Error,org.mule.runtime.api.message.Message>	send(String url, org.mule.runtime.api.message.Message message) Sends an event synchronously to a endpointUri via a Mule server and a resulting message is returned.
Either<org.mule.runtime.api.message.Error,org.mule.runtime.api.message.Message>	send(String url, org.mule.runtime.api.message.Message message, long timeout) Deprecated. use send(String, Message, OperationOptions) instead Sends an event synchronously to a endpointUri via a mule server and a resulting message is returned.
Either<org.mule.runtime.api.message.Error,org.mule.runtime.api.message.Message>	send(String url, org.mule.runtime.api.message.Message message, OperationOptions operationOptions) Sends an event synchronously to a endpointUri via a Mule server and a resulting message is returned.
Either<org.mule.runtime.api.message.Error,org.mule.runtime.api.message.Message>	send(String url, Object payload, Map<String,Serializable> messageProperties) Deprecated. use send(String, Message) instead Sends an event synchronously to a endpointUri via a Mule server and a resulting message is returned.
Either<org.mule.runtime.api.message.Error,org.mule.runtime.api.message.Message>	send(String url, Object payload, Map<String,Serializable> messageProperties, long timeout) Deprecated. use send(String, Message, OperationOptions) Sends an event synchronously to a endpointUri via a mule server and a resulting message is returned.

Method Detail

dispatch

@Deprecated
void dispatch(String url,
                          Object payload,
                          Map<String,Serializable> messageProperties)
                   throws org.mule.runtime.api.exception.MuleException

Deprecated. use dispatch(String, Message) instead Dispatches an event asynchronously to a endpointUri via a Mule server. The URL determines where to dispatch the event to.

Parameters:

url - the Mule URL used to determine the destination and transport of the message

payload - the object that is the payload of the event

messageProperties - any properties to be associated with the payload. In the case of JMS you could set the JMSReplyTo property in these properties.

Throws:

org.mule.api.MuleException

org.mule.runtime.api.exception.MuleException

dispatch

void dispatch(String url,
              org.mule.runtime.api.message.Message message)
       throws org.mule.runtime.api.exception.MuleException

Dispatches an event asynchronously to a endpointUri via a Mule server. The URL determines where to dispatch the event to.

Parameters:

url - the Mule URL used to determine the destination and transport of the message

message - the message to send

Throws:

org.mule.api.MuleException

org.mule.runtime.api.exception.MuleException

dispatch

void dispatch(String url,
              org.mule.runtime.api.message.Message message,
              OperationOptions operationOptions)
       throws org.mule.runtime.api.exception.MuleException

Dispatches an event asynchronously to a endpointUri via a Mule server. The URL determines where to dispatch the event to.

Parameters:

url - the Mule URL used to determine the destination and transport of the message

message - the message to send

operationOptions - the options to configure the operation

Throws:

org.mule.api.MuleException

org.mule.runtime.api.exception.MuleException

send

@Deprecated
Either<org.mule.runtime.api.message.Error,org.mule.runtime.api.message.Message> send(String url,
                                                                                                 Object payload,
                                                                                                 Map<String,Serializable> messageProperties)
                                                                                          throws org.mule.runtime.api.exception.MuleException

Deprecated. use send(String, Message) instead Sends an event synchronously to a endpointUri via a Mule server and a resulting message is returned.

Parameters:

url - the Mule URL used to determine the destination and transport of the message

payload - the object that is the payload of the event

messageProperties - any properties to be associated with the payload. In the case of Jms you could set the JMSReplyTo property in these properties.

Returns:

A return message, this could be null if the the components invoked explicitly sets a return as null.

Throws:

org.mule.api.MuleException

org.mule.runtime.api.exception.MuleException

send

Either<org.mule.runtime.api.message.Error,org.mule.runtime.api.message.Message> send(String url,
                                                                                     org.mule.runtime.api.message.Message message)
                                                                              throws org.mule.runtime.api.exception.MuleException

Sends an event synchronously to a endpointUri via a Mule server and a resulting message is returned.

Parameters:

url - the Mule URL used to determine the destination and transport of the message

message - the Message for the event

Returns:

A return message, this could be null if the the components invoked explicitly sets a return as null.

Throws:

org.mule.api.MuleException

org.mule.runtime.api.exception.MuleException

send

Either<org.mule.runtime.api.message.Error,org.mule.runtime.api.message.Message> send(String url,
                                                                                     org.mule.runtime.api.message.Message message,
                                                                                     OperationOptions operationOptions)
                                                                              throws org.mule.runtime.api.exception.MuleException

Sends an event synchronously to a endpointUri via a Mule server and a resulting message is returned.

Parameters:

url - the Mule URL used to determine the destination and transport of the message

message - the Message for the event

operationOptions - the options to configure the operation

Returns:

A return message, this could be null if the the components invoked explicitly sets a return as null.

Throws:

org.mule.api.MuleException

org.mule.runtime.api.exception.MuleException

send

@Deprecated
Either<org.mule.runtime.api.message.Error,org.mule.runtime.api.message.Message> send(String url,
                                                                                                 Object payload,
                                                                                                 Map<String,Serializable> messageProperties,
                                                                                                 long timeout)
                                                                                          throws org.mule.runtime.api.exception.MuleException

Deprecated. use send(String, Message, OperationOptions) Sends an event synchronously to a endpointUri via a mule server and a resulting message is returned.

Parameters:

url - the Mule URL used to determine the destination and transport of the message

payload - the object that is the payload of the event

messageProperties - any properties to be associated with the payload. In the case of Jms you could set the JMSReplyTo property in these properties.

timeout - The time in milliseconds the the call should block waiting for a response

Returns:

A return message, this could be null if the the components invoked explicitly sets a return as null.

Throws:

org.mule.api.MuleException

org.mule.runtime.api.exception.MuleException

send

@Deprecated
Either<org.mule.runtime.api.message.Error,org.mule.runtime.api.message.Message> send(String url,
                                                                                                 org.mule.runtime.api.message.Message message,
                                                                                                 long timeout)
                                                                                          throws org.mule.runtime.api.exception.MuleException

Deprecated. use send(String, Message, OperationOptions) instead Sends an event synchronously to a endpointUri via a mule server and a resulting message is returned.

Parameters:

url - the Mule URL used to determine the destination and transport of the message

message - The message to send

timeout - The time in milliseconds the the call should block waiting for a response

Returns:

A return message, this could be null if the the components invoked explicitly sets a return as null.

Throws:

org.mule.api.MuleException

org.mule.runtime.api.exception.MuleException

request

Either<org.mule.runtime.api.message.Error,Optional<org.mule.runtime.api.message.Message>> request(String url,
                                                                                                  long timeout)
                                                                                           throws org.mule.runtime.api.exception.MuleException

Will receive an event from an endpointUri determined by the URL.

Parameters:

url - the Mule URL used to determine the destination and transport of the message

timeout - how long to block waiting to receive the event, if set to 0 the receive will not wait at all and if set to -1 the receive will wait forever

Returns:

the message received or null if no message was received

Throws:

org.mule.api.MuleException

org.mule.runtime.api.exception.MuleException