HTTP Connector Documentation Reference

Connector to handle and perform HTTP requests

Configurations

Listener Config

Parameters

Name	Type	Description	Default Value	Required
Name	String	The name of this configuration. With this name can be later referenced.		x
Connection	Listener Connection	The connection types that can be provided to this configuration.		x
Base Path	String
Parse Request	Boolean		true
Interpret Request Errors	Boolean		false

Name

Type

Description

Default Value

Required

Name

String

The name of this configuration. With this name can be later referenced.

Connection

Listener Connection

The connection types that can be provided to this configuration.

Base Path

String

Parse Request

Boolean

true

Interpret Request Errors

Boolean

false

Connection Types

Listener Connection

Parameters

Name	Type	Description	Default Value	Required
TLS Configuration	Tls
Protocol	Enumeration, one of: HTTP HTTPS		HTTP
Host	String			x
Port	Number			x
Use Persistent Connections	Boolean		true
Connection Idle Timeout	Number		30000
Reconnection Strategy	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors
Disable Validation	Boolean	Disables connection validation

Name

Type

Description

Default Value

Required

TLS Configuration

Tls

Protocol

Enumeration, one of:

HTTP
HTTPS

HTTP

Host

String

Port

Number

Use Persistent Connections

Boolean

true

Connection Idle Timeout

Number

30000

Reconnection Strategy

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors

Disable Validation

Boolean

Disables connection validation

Associated Sources

Listener

Request Config

Parameters

Name	Type	Description	Default Value	Required
Name	String	The name of this configuration. With this name can be later referenced.		x
Connection	Request Connection	The connection types that can be provided to this configuration.		x
Api Configuration	Raml Api Configuration
Follow Redirects	Boolean		true
Send Body Mode	Enumeration, one of: ALWAYS AUTO NEVER		AUTO
Request Streaming Mode	Enumeration, one of: AUTO ALWAYS NEVER		AUTO
Enable Cookies	Boolean		true
Parse Response	Boolean		true
Response Timeout	Number
Base Path	String		/

Name

Type

Description

Default Value

Required

Name

String

The name of this configuration. With this name can be later referenced.

Connection

Request Connection

The connection types that can be provided to this configuration.

Api Configuration

Raml Api Configuration

Follow Redirects

Boolean

true

Send Body Mode

Enumeration, one of:

ALWAYS
AUTO
NEVER

AUTO

Request Streaming Mode

Enumeration, one of:

AUTO
ALWAYS
NEVER

AUTO

Enable Cookies

Boolean

true

Parse Response

Boolean

true

Response Timeout

Number

Base Path

String

Connection Types

Request Connection

Parameters

Name	Type	Description	Default Value
Proxy Config	One of: Proxy Ntlm Proxy
Authentication	One of: Basic Authentication Digest Authentication Ntlm Authentication
TLS Configuration	Tls
Protocol	Enumeration, one of: HTTP HTTPS		HTTP
Host	String
Port	Number
Use Persistent Connections	Boolean		true
Max Connections	Number		-1
Connection Idle Timeout	Number		30000
Client Socket Properties	Tcp Client Socket Properties
Reconnection Strategy	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors
Disable Validation	Boolean	Disables connection validation

Name

Type

Description

Default Value

Required

Proxy Config

One of:

Proxy
Ntlm Proxy

Authentication

One of:

Basic Authentication
Digest Authentication
Ntlm Authentication

TLS Configuration

Tls

Protocol

Enumeration, one of:

HTTP
HTTPS

HTTP

Host

String

Port

Number

Use Persistent Connections

Boolean

true

Max Connections

Number

-1

Connection Idle Timeout

Number

30000

Client Socket Properties

Tcp Client Socket Properties

Reconnection Strategy

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors

Disable Validation

Boolean

Disables connection validation

Associated Operations

Request

Operations

Request

<httpn:request>

Parameters

Name

Type

Description

Default Value

Required

Configuration

String

The name of the configuration to use.

Path

String

Method

String

GET

Body

Any

#[payload]

Headers

Object

URI Parameters

Object

Query Parameters

Object

Host

String

Port

Number

Follow Redirects

Boolean

Send Body Mode

Enumeration, one of:

ALWAYS
AUTO
NEVER

Request Streaming Mode

Enumeration, one of:

AUTO
ALWAYS
NEVER

Parse Response

Boolean

Response Timeout

Number

Output Type

Enumeration, one of:

STREAM
MULTIPART
FORM
ANY

ANY

Target Variable

String

The name of a variable on which the operation's output will be placed

Response Validator

One of:

Success Status Code Validator
Failure Status Code Validator

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations.

Request Config

Throws

HTTPN:CONNECTIVITY
HTTPN:METHOD_NOT_ALLOWED
HTTPN:TRANSFORMATION
HTTPN:NOT_FOUND
HTTPN:PARSING
HTTPN:SERVICE_UNAVAILABLE
HTTPN:SECURITY
HTTPN:RESPONSE_VALIDATION
HTTPN:BAD_REQUEST
HTTPN:UNAUTHORIZED
HTTPN:INTERNAL_SERVER_ERROR
HTTPN:UNSUPPORTED_MEDIA_TYPE
HTTPN:RETRY_EXHAUSTED
HTTPN:TOO_MANY_REQUESTS
HTTPN:FORBIDDEN
HTTPN:TIMEOUT
HTTPN:NOT_ACCEPTABLE

Sources

Listener

<httpn:listener>

Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
Path	String			x
Allowed Methods	String
Response Streaming Mode	Enumeration, one of: AUTO ALWAYS NEVER		AUTO
Redelivery Policy	Redelivery Policy	Defines a policy for processing the redelivery of the same message
Parse Request	Boolean
Interpret Request Errors	Boolean
Reconnection Strategy	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors
Response	Http Listener Response Builder
Error Response	Http Listener Response Builder

Name

Type

Description

Default Value

Required

Configuration

String

The name of the configuration to use.

Path

String

Allowed Methods

String

Response Streaming Mode

Enumeration, one of:

AUTO
ALWAYS
NEVER

AUTO

Redelivery Policy

Defines a policy for processing the redelivery of the same message

Parse Request

Boolean

Interpret Request Errors

Boolean

Reconnection Strategy

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors

Response

Http Listener Response Builder

Error Response

Http Listener Response Builder

Output

Type

Any

Attributes Type

Http Request Attributes

For Configurations.

Listener Config

Types

Tls

Field	Type
Enabled Protocols	String
Enabled Cipher Suites	String
Trust Store	Trust Store
Key Store	Key Store

Field

Type

Enabled Protocols

String

Enabled Cipher Suites

String

Trust Store

Key Store

Trust Store

Field	Type
Path	String
Password	String
Type	Enumeration, one of: jks jceks pkcs12 String
Algorithm	String
Insecure	Boolean

Field

Type

Path

String

Password

String

Type

Enumeration, one of:
- jks
- jceks
- pkcs12
String

Algorithm

String

Insecure

Boolean

Key Store

Field	Type
Path	String
Type	Enumeration, one of: jks jceks pkcs12 String
Alias	String
Key Password	String
Password	String
Algorithm	String

Field

Type

Path

String

Type

Enumeration, one of:
- jks
- jceks
- pkcs12
String

Alias

String

Key Password

String

Password

String

Algorithm

String

Reconnect

Field	Type
Frequency	Number
Count	Number
Blocking	Boolean

Field

Type

Frequency

Number

Count

Number

Blocking

Boolean

Reconnect Forever

Field	Type
Frequency	Number

Field

Type

Frequency

Number

Http Request Attributes

Field	Type
Client Certificate	Any
Headers	Object
Listener Path	String
Method	String
Query Params	Object
Query String	String
Relative Path	String
Remote Address	String
Request Path	String
Request Uri	String
Scheme	String
Uri Params	Object
Version	String

Field

Type

Client Certificate

Any

Headers

Object

Listener Path

String

Method

String

Query Params

Object

Query String

String

Relative Path

String

Remote Address

String

Request Path

String

Request Uri

String

Scheme

String

Uri Params

Object

Version

String

Redelivery Policy

Field	Type
Max Redelivery Count	Number
Use Secure Hash	Boolean
Message Digest Algorithm	String
Id Expression	String
Object Store Ref	String

Field

Type

Max Redelivery Count

Number

Use Secure Hash

Boolean

Message Digest Algorithm

String

Id Expression

String

Object Store Ref

String

Http Listener Response Builder

Field	Type
Status Code	Number
Reason Phrase	String
Body	Any
Headers	Object

Field

Type

Status Code

Number

Reason Phrase

String

Body

Any

Headers

Object

Tcp Client Socket Properties

Field	Type
Connection Timeout	Number
Send Tcp No Delay	Boolean
Linger	Number
Keep Alive	Boolean
Fail On Unresolved Host	Boolean
Send Buffer Size	Number
Receive Buffer Size	Number
Client Timeout	Number
Reuse Address	Boolean

Field

Type

Connection Timeout

Number

Send Tcp No Delay

Boolean

Linger

Number

Keep Alive

Boolean

Fail On Unresolved Host

Boolean

Send Buffer Size

Number

Receive Buffer Size

Number

Client Timeout

Number

Reuse Address

Boolean

Raml Api Configuration

Field	Type
Location	String

Field

Type

Location

String

Http Response Attributes

Field	Type
Headers	Object
Reason Phrase	String
Status Code	Number

Field

Type

Headers

Object

Reason Phrase

String

Status Code

Number

Basic Authentication

Field	Type
Preemptive	Boolean
Username	String
Password	String

Field

Type

Preemptive

Boolean

Username

String

Password

String

Digest Authentication

Field	Type
Username	String
Password	String

Field

Type

Username

String

Password

String

Ntlm Authentication

Field	Type
Domain	String
Workstation	String
Username	String
Password	String

Field

Type

Domain

String

Workstation

String

Username

String

Password

String

Proxy

Field	Type
Host	String
Port	Number
Username	String
Password	String

Field

Type

Host

String

Port

Number

Username

String

Password

String

Ntlm Proxy

Field	Type
Ntlm Domain	String
Host	String
Port	Number
Username	String
Password	String

Field

Type

Ntlm Domain

String

Host

String

Port

Number

Username

String

Password

String

Success Status Code Validator

Field	Type
Values	String

Field

Type

Values

String

Failure Status Code Validator

Field	Type
Values	String

Field

Type

Values

String