org.mule.modules

mule-module-requester

config

Namespace	http://www.mulesoft.org/schema/mule/mulerequester
Schema Location	http://www.mulesoft.org/schema/mule/mulerequester/current/mule-mulerequester.xsd (View Schema)
Schema Version	1.0-SNAPSHOT
Minimum Mule Version	3.2

Module Overview

Generic module

Summary

Configuration
<mulerequester:config> Configure an instance of this module

Message Processors
<mulerequester:request> Request a resource from an address or endpoint.

Configuration

To use the this module within a flow the namespace to the module must be included. The resulting flow will look similar to the following:

<mule xmlns="http://www.mulesoft.org/schema/mule/core"
      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
      xmlns:mulerequester="http://www.mulesoft.org/schema/mule/mulerequester"
      xsi:schemaLocation="
               http://www.mulesoft.org/schema/mule/core
               http://www.mulesoft.org/schema/mule/core/current/mule.xsd
               http://www.mulesoft.org/schema/mule/mulerequester
               http://www.mulesoft.org/schema/mule/mulerequester/current/mule-mulerequester.xsd">

      <!-- here goes your flows and configuration elements -->

</mule>

Message Processors

<mulerequester:request>

Request a resource from an address or endpoint.
To make the request using the address, use the format "protocol://address". E.g.: "file://path/to/file".
Otherwise, you can use a global endpoint name. E.g.: "fileEndpoint".

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
resource		The address of the resource or the global endpoint name	String	/	UTF-8
timeout	1000	Optional. The timeout to wait for when requesting the resource	long	/
returnClass		Optional. The return class to which this processor will transform the payload from the requested resource	String	/	UTF-8
throwExceptionOnTimeout		Optional. Whether to throw an exception or not if no message is received in the configured timeout	Boolean	/

Returns

Return Type	Description
Object	the payload from the requested resource

Exception Payloads

Payload Class	Description
MuleException	Some exception