META-INF.mule-httpn.xsd Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of mule-module-http Show documentation
Show all versions of mule-module-http Show documentation
Provides components for exposing and consuming HTTP services
Mule Utilities for HTTP Services.
HTTP
HTTP Module
Listener for incoming HTTP requests.
Contains the definition of all the parameters that should be sent in the response (headers, status code, response phrase).
Contains the definition of all the parameters that should be sent in the response (headers, status code, response phrase).
Path were to listen for incoming request.
Comma separated list of allowed HTTP methods by this listener. To allow all methods do not defined the attribute.
A reference to the configuration element for this listener. If no reference is provided,
a default configuration will be created.
Defines if the response should be sent using streaming or not. If this attribute is not present,
the behavior will depend on the type of the payload (it will stream only for InputStream). If set
to true, it will always stream. If set to false, it will never stream. As streaming is done the response
will be sent user Transfer-Encoding: chunked.
By default, the request will be parsed (for example, a multi part request will be mapped as a
Mule message with null payload and inbound attachments with each part). If this property is set to false,
no parsing will be done, and the payload will always contain the raw contents of the HTTP request.
Grouping configuration for a set of listener elements.
Identifies the configuration in the registry, so that it can be referenced by the request message processor.
Protocol to use for communication. Valid values are HTTP and HTTPS. Default value is HTTP. When using HTTPS the
HTTP communication is going to be secured using TLS / SSL. If HTTPS was configured as protocol then the
user needs to configure at least the keystore in the tls:context child element of this listener-config.
Host where the requests will be sent.
Port where the requests will be received. If the protocol attribute is HTTP (default) then the default value is 80, if the protocol
attribute is HTTPS then the default value is 443.
Base path to use for all requests that reference this config.
Reference to a TLS config element. This will enable HTTPS for this config.
By default, the request will be parsed (for example, a multi part request will be mapped as a
Mule message with null payload and inbound attachments with each part). If this property is set to false,
no parsing will be done, and the payload will always contain the raw contents of the HTTP request.
The number of milliseconds that a connection can remain idle before it is closed.
The value of this attribute is only used when persistent connections are enabled.
If false, each connection will be closed after the first request is completed.
HTTP response
Allows to compose a request-builder.
Name of a response-builder.
Adds a header to the response.
Adds many headers to the response based on expressions.
Component that consumes an HTTP service.
Contains the definition of all the parameters that should be sent in the request (uri params,
query params and headers).
Configures error handling of the response based on the status code.
Status codes that will be considered as successful. Other status codes in the response will
cause the component to throw an exception.
Configures error handling of the response based on the status code.
Status codes that will be considered as failures. Responses with these status codes will
cause the component to throw an exception.
Path where the request will be sent.
The HTTP method for the request.
A reference to the configuration element for this requester. If no reference is provided,
a default configuration will be created.
The expression used to obtain the body that will be sent in the request. Default is
empty, so the payload will be used as the body.
The enricher expression used to enrich the current message with the body
of the response. Default is "#[payload]", so after processing the response, the contents
of its body will be set as payload of the message.
Identifies the builder so that other elements can reference it.
Allows to compose a request-builder.
Name of a request-builder.
Adds a query parameter to the request.
The name of the query parameter.
The value of the query parameter.
Adds many query parameters to the request based on a map.
A MEL expression that should return the parameters to send, the keys
are the names of the parameters.
Adds a URI parameter to the request.
The name of the URI parameter to send. The path should contain
a placeholder for this name with the syntax "{name}".
The value of the URI parameter.
Adds many URI parameters to the request based on a map.
MEL expression that should return a map with the parameters. The
keys are the names of the parameters, and the path of the request
should contain a placeholder for each of these.
Adds a header to the request.
Adds many headers to the request.
Specifies a RAML configuration file for the API that is being consumed.
The location of the RAML file.
Reusable configuration element for outbound connections through a proxy.
A proxy element must define a host name and a port attributes, and optionally can define a username
and a password.
Reusable configuration element for outbound connections through a proxy.
A proxy element must define a host name and a port attributes, and optionally can define a username
and a password.
Protocol to use for communication. Valid values are HTTP and HTTPS. Default value is HTTP. When using HTTPS the
HTTP communication is going to be secured using TLS / SSL. If HTTPS was configured as protocol then the
user can customize the tls/ssl configuration by defining the tls:context child element of this listener-config.
If not tls:context is defined then the default JVM certificates are going to be used to establish communication.
Identifies the configuration in the registry, so that it can be referenced by the request message processor.
Base path to use for all requests that reference this config.
Reference to a TLS context element. This will enable HTTPS for this config.
Reference to a TCP Client Socket properties element.
Reference to a proxy context element.
The maximum number of outbound connections that will be kept open at the same time.
By default the number of connections is unlimited.
The number of milliseconds that a connection can remain idle before it is closed.
The value of this attribute is only used when persistent connections are enabled.
If false, each connection will be closed after the first request is completed.
If true, cookies received in HTTP responses will be stored, and sent in subsequent HTTP requests.
Specifies whether to follow redirects or not. Default value is true.
Host where the requests will be sent.
Port where the requests will be sent. If the protocol attribute is HTTP (default) then the default value is 80, if the protocol
attribute is HTTPS then the default value is 443.
By default, the response will be parsed (for example, a multi part response will be mapped as a
Mule message with null payload and inbound attachments with each part). If this property is set to false,
no parsing will be done, and the payload will always contain the raw contents of the HTTP response.
Defines if the request should be sent using streaming or not. If this attribute is not present,
the behavior will depend on the type of the payload (it will stream only for InputStream). If set
to true, it will always stream. If set to false, it will never stream. As streaming is done the request
will be sent user Transfer-Encoding: chunked.
Defines if the request should contain a body or not. If AUTO, it will depend on the method (GET,
HEAD and OPTIONS will not send a body).
Maximum time that the request element will block the execution of the flow waiting for the HTTP response.
If this value is not present, the default response timeout from the Mule configuration will be used.
A security manager is a container for security providers. More than one security manager may be configured; each contains providers from a particular module and has that module type. This element is abstract - a security-related module or transport will provide a suitable implementation.
An empty holder that can be extended by modules that want to provide http request authentication.
Configures basic authentication for the requests.
The username to authenticate.
The password to authenticate.
Configures if authentication should be preemptive or not. Preemptive authentication will send
the authentication header in the first request, instead of waiting for a 401 response code to send it.
Configures digest authentication for the requests.
The username to authenticate.
The password to authenticate.
Configures NTLM authentication for the requests.
The username to authenticate.
The password to authenticate.
The domain to authenticate.
The workstation to authenticate.
The name of the header.
The value of the header.
MEL expression that should return a map with the headers to add.
The keys of the map are the names of the headers.
Reusable configuration element for outbound connections through a proxy.
A proxy element must define a host name and a port attributes, and optionally can define a username
and a password.
Identifies the proxy configuration in the registry, so that it can be referenced by the request config.
Reusable configuration element for outbound connections through a proxy.
A proxy element must define a host name and a port attributes, and optionally can define a username
and a password.
Identifies the proxy configuration in the registry, so that it can be referenced by the request config.
HTTP global configuration
Backwards Compatabilty Flag: Since Mule 3.6, default HTTP URIs are resolved with the new HTTP connector (for example when using MuleClient). If set to true, this behavior is changed so that the HTTP transport is used.
Plain HTTP protocol with no encryption (HTTPS / SSL/ TLS) configured
HTTP protocol used with encryption (HTTPS / SSL / TLS).
© 2015 - 2025 Weber Informatics LLC | Privacy Policy