Technical Guide Reference Guide Frequently Asked Questions Tutorials
Show menu

HTTP Listener

HTTP Listener

An HTTP listener consumes an HTTP request and offers its content as a ConnectMessage.

This listener is a request/response consumer, which means that a response must be returned.

This can happen through a host:port/context-path/ combination. For every combination, a separate server context is started. 
Listeners with the same host:port/context combination will use the same server context. The HTTP server will be generated and configured automatically.

When a Message reply component is configured at the end of the flow, the result from the service is sent back to the HTTP invoker.

Also, thrown exceptions will be sent back to the HTTP invoker, instead of being caught by the exception handling mechanism.

In the table below, you will find an explanation of these properties. All attributes with a ‘*’ are mandatory.

Attribute

Description

Name*

By default, we fill this out with the technical ‘tag’, followed by a serial number. Changing the name is optional.

Enabled

Set this value to true, if you want this consumer to be enabled.

Consumer Autostart

 Consumer will be started at startup of the interface.

Hostname

 Hostname used to create the endpoint. The default is the ConnectAgent host.

Port

Port number. The default is the ConnectAgent port.

Context Path

 Path on which to open webservice endpoint. A custom Context Path should always start with a forward slash (/). So for instance: "/CustomPath".

Method

Specify which HTTP Methods are allowed (GET/POST/HEAD/OPTIONS/PUT/PATCH/DELETE/TRACE). You may also use a comma separated list.

Input can be done by clicking in the lower part of the box. A drop down menu will appear and you can select, or type your selection:

MessagePart Name

 Name of the MessagePart in a ConnectMessage where the content of the request is being stored.

Response Timeout

 Time in milliseconds to wait before time-out.

Mapped Request Headers

A comma separated list of headers to be mapped from HTTP request to the ConnectMessage.

Mapped Response Headers

A comma separated list of headers to be mapped from the ConnectMessage to the HTTP response.
Non-Standard HTTP Header Prefix

 

Specify the prefix used to transfer non-standard HTTP Headers. Defaults to 'X-'

Expected Content Type

Specify which content-type may be expected to be correctly mapped to a useable format. This will override default content-type mapping.

Use Form URL Encoded

Switch to enable or disable receiving applicaton/x-www-form-urlencoded or application/form-data (multipart) messages. When enabled the form url encoded message will be transformed into one or more ConnectMessageParts.

Enable SSL

Enables SSL Connector. When set to true, the keystore value and alias value should be set. Otherwise the defaults will be used.

The default port will be changed to the default ConnectAgent SSL port or the port you defined yourself.

Authentication Realm

 Provide an Authentication file from Resources to specify configured Authentication for selected Scheme. See chapter on Providing Authentication for HTTP/WS Listeners. For more information, follow this link.

Authentication Scheme

 Select desired Authentication Schema (NONE, BASIC, JDBC, LDAP). See chapter on Providing Authentication for HTTP/WS Listeners. For more information, follow this link.

Prefix For Mapped GET Parameters

 Prefix used for mapping HTTP GET Parameters to the ConnectMessage Properties. Defaults to 'http_param_'

Description

 Description of the specific consumer. This is for documentation purposes.

Enable SSL

When you enable SSL, you need to add some extra information. This will look like this:

Attribute

 Description

Certificate Alias in Keystore

 Set the certificate alias for the selected certificate. Should exist in defined keystore. Defaults to internal self-signed certificate.

Key Password

 Password for the certificate key. Defaults to the internal keystore.

Keystore Location

 The location of the keystore. Should be a path to the keystore JKS file. Defaults to the internal keystore.

Keystore Password

 Password of the keystore. Defaults to the internal keystore.