Verato UMPI Connector Module Reference

  • UMPI
  • Connector

Configurations

Config 

Parameters

(scroll down)

Name Type Description Default Value Required

Name

String

The name for this configuration. Connectors reference the configuration with this name.

x  

Connection

Basic Auth Secure Scheme Connection Provider

The connection types that can be provided to this configuration.

x  

Response Timeout

Number

The timeout for request to the remote service.

1

 

Response Timeout Unit

Enumeration, one of:

NANOSECONDS

MICROSECONDS

MILLISECONDS

SECONDS

MINUTES

HOURS

DAYS

A time unit which qualifies the Response Timeout}

MINUTES

 

Streaming Type

Enumeration, one of:

AUTO

ALWAYS

NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

AUTO

 

Name

String

The identifier of this element used to reference it in other components

x  

Expiration Policy

Expiration Policy

Configures the minimum amount of time that a dynamic configuration instance can remain idle before the runtime considers it eligible for expiration. This does not mean that the platform will expire the instance at the exact moment that it becomes eligible. The runtime will actually purge the instances when it sees it fit.

 

Connection Types

Basic Auth Secure Scheme Connection Provider

Parameters

Name Type Description Default Value Required

Default Headers

Array of Default Header

 

Query Parameters

Array of Default Query Param

 

Connection Timeout

Number

The timeout for establishing connections to the remote service

30

 

Connection Timeout Unit

Enumeration, one of:

NANOSECONDS

MICROSECONDS

MILLISECONDS

SECONDS

MINUTES

HOURS

DAYS

A time unit which qualifies the Connection Timeout

SECONDS

 

Use Persistent Connections

Boolean

If false, each connection will be closed after the first request is completed.

true

 

Max Connections

Number

The maximum number of outbound connections that will be kept open at the same time

-1

 

Connection Idle Timeout

Number

A timeout for how long a connection can remain idle before it is closed

30

 

Connection Idle Timeout Unit

Enumeration, one of:

NANOSECONDS

MICROSECONDS

MILLISECONDS

SECONDS

MINUTES

HOURS

DAYS

A time unit which qualifies the connection Idle Timeout

SECONDS

 

Proxy Config

Proxy

Reusable configuration element for outbound connections through a proxy

 

Stream Response

Boolean

Whether or not received responses should be streamed

false

 

Response Buffer Size

Number

The space in bytes for the buffer where the HTTP response will be stored.

-1

 

Username

String

The username to authenticate the requests

 

Password

String

The password to authenticate the requests

 

Base Uri

String

Parameter base URI, each instance/tenant gets its own

https://<hostname>:<port>/link-ws/svc

 

Protocol

Enumeration, one of:

HTTP

HTTPS

Protocol to use for communication. Valid values are HTTP and HTTPS

HTTP

 

TLS Configuration

Tls

 

Reconnection

Reconnection

When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment will fail if the test doesn’t pass after exhausting the associated reconnection strategy

 

Associated Operations

Operations

Create Data Source

<verato-umpi:create-create-data-source>

Create Data Sources for link This operation makes an HTTP POST request to the /createDataSource endpoint

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x  

Content

Binary

the content to use

#[payload]

 

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

 

Streaming Strategy

· Repeatable In Memory Stream

· Repeatable File Store Stream

non-repeatable-stream

Configure if repeatable streams should be used and their behaviour

 

Custom Query Parameters

Object

 

Custom Headers

Object

 

Response Timeout

Number

The timeout for request to the remote service.

 

Response Timeout Unit

Enumeration, one of:

NANOSECONDS

MICROSECONDS

MILLISECONDS

SECONDS

MINUTES

HOURS

DAYS

A time unit which qualifies the Response Timeout}

 

Streaming Type

Enumeration, one of:

AUTO

ALWAYS

NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

 

Target Variable

String

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

 

Target Value

String

An expression that will be evaluated against the operation’s output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

Reconnect

Reconnect Forever

A retry strategy in case of connectivity errors

 

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • VERATO-UMPI:BAD_REQUEST
  • VERATO-UMPI:CLIENT_ERROR
  • VERATO-UMPI:CONNECTIVITY
  • VERATO-UMPI:INTERNAL_SERVER_ERROR
  • VERATO-UMPI:NOT_ACCEPTABLE
  • VERATO-UMPI:NOT_FOUND
  • VERATO-UMPI:RETRY_EXHAUSTED
  • VERATO-UMPI:SERVER_ERROR
  • VERATO-UMPI:SERVICE_UNAVAILABLE
  • VERATO-UMPI:TIMEOUT
  • VERATO-UMPI:TOO_MANY_REQUESTS
  • VERATO-UMPI:UNAUTHORIZED
  • VERATO-UMPI:UNSUPPORTED_MEDIA_TYPE

Delete Source Identity

<verato-umpi:create-delete-source-identity>

Delete A Source This operation makes an HTTP POST request to the /deleteSourceIdentity endpoint

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x  

Content

Binary

the content to use

#[payload]

 

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

 

Streaming Strategy

· Repeatable In Memory Stream

· Repeatable File Store Stream

non-repeatable-stream

Configure if repeatable streams should be used and their behaviour

 

Custom Query Parameters

Object

 

Custom Headers

Object

 

Response Timeout

Number

The timeout for request to the remote service.

 

Response Timeout Unit

Enumeration, one of:

NANOSECONDS

MICROSECONDS

MILLISECONDS

SECONDS

MINUTES

HOURS

DAYS

A time unit which qualifies the Response Timeout}

 

Streaming Type

Enumeration, one of:

AUTO

ALWAYS

NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

 

Target Variable

String

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

 

Target Value

String

An expression that will be evaluated against the operation’s output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

Reconnect

Reconnect Forever

A retry strategy in case of connectivity errors

 

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • VERATO-UMPI:BAD_REQUEST
  • VERATO-UMPI:CLIENT_ERROR
  • VERATO-UMPI:CONNECTIVITY
  • VERATO-UMPI:INTERNAL_SERVER_ERROR
  • VERATO-UMPI:NOT_ACCEPTABLE
  • VERATO-UMPI:NOT_FOUND
  • VERATO-UMPI:RETRY_EXHAUSTED
  • VERATO-UMPI:SERVER_ERROR
  • VERATO-UMPI:SERVICE_UNAVAILABLE
  • VERATO-UMPI:TIMEOUT
  • VERATO-UMPI:TOO_MANY_REQUESTS
  • VERATO-UMPI:UNAUTHORIZED
  • VERATO-UMPI:UNSUPPORTED_MEDIA_TYPE

Demographics Query

<verato-umpi:create-demographics-query>

Query Using Demographic Information This operation makes an HTTP POST request to the /demographicsQuery endpoint

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x  

Content

Binary

the content to use

#[payload]

 

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

 

Streaming Strategy

· Repeatable In Memory Stream

· Repeatable File Store Stream

non-repeatable-stream

Configure if repeatable streams should be used and their behaviour

 

Custom Query Parameters

Object

 

Custom Headers

Object

 

Response Timeout

Number

The timeout for request to the remote service.

 

Response Timeout Unit

Enumeration, one of:

NANOSECONDS

MICROSECONDS

MILLISECONDS

SECONDS

MINUTES

HOURS

DAYS

A time unit which qualifies the Response Timeout}

 

Streaming Type

Enumeration, one of:

AUTO

ALWAYS

NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

 

Target Variable

String

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

 

Target Value

String

An expression that will be evaluated against the operation’s output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

Reconnect

Reconnect Forever

A retry strategy in case of connectivity errors

 

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • VERATO-UMPI:BAD_REQUEST
  • VERATO-UMPI:CLIENT_ERROR
  • VERATO-UMPI:CONNECTIVITY
  • VERATO-UMPI:INTERNAL_SERVER_ERROR
  • VERATO-UMPI:NOT_ACCEPTABLE
  • VERATO-UMPI:NOT_FOUND
  • VERATO-UMPI:RETRY_EXHAUSTED
  • VERATO-UMPI:SERVER_ERROR
  • VERATO-UMPI:SERVICE_UNAVAILABLE
  • VERATO-UMPI:TIMEOUT
  • VERATO-UMPI:TOO_MANY_REQUESTS
  • VERATO-UMPI:UNAUTHORIZED
  • VERATO-UMPI:UNSUPPORTED_MEDIA_TYPE

Demographics Search

<verato-umpi:create-demographics-search>

Search Using Demographic Information This operation makes an HTTP POST request to the /demographicsSearch endpoint

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x  

Content

Binary

the content to use

#[payload]

 

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

 

Streaming Strategy

· Repeatable In Memory Stream

· Repeatable File Store Stream

non-repeatable-stream

Configure if repeatable streams should be used and their behaviour

 

Custom Query Parameters

Object

 

Custom Headers

Object

 

Response Timeout

Number

The timeout for request to the remote service.

 

Response Timeout Unit

Enumeration, one of:

NANOSECONDS

MICROSECONDS

MILLISECONDS

SECONDS

MINUTES

HOURS

DAYS

A time unit which qualifies the Response Timeout}

 

Streaming Type

Enumeration, one of:

AUTO

ALWAYS

NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

 

Target Variable

String

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

 

Target Value

String

An expression that will be evaluated against the operation’s output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

Reconnect

Reconnect Forever

A retry strategy in case of connectivity errors

 

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • VERATO-UMPI:BAD_REQUEST
  • VERATO-UMPI:CLIENT_ERROR
  • VERATO-UMPI:CONNECTIVITY
  • VERATO-UMPI:INTERNAL_SERVER_ERROR
  • VERATO-UMPI:NOT_ACCEPTABLE
  • VERATO-UMPI:NOT_FOUND
  • VERATO-UMPI:RETRY_EXHAUSTED
  • VERATO-UMPI:SERVER_ERROR
  • VERATO-UMPI:SERVICE_UNAVAILABLE
  • VERATO-UMPI:TIMEOUT
  • VERATO-UMPI:TOO_MANY_REQUESTS
  • VERATO-UMPI:UNAUTHORIZED
  • VERATO-UMPI:UNSUPPORTED_MEDIA_TYPE

Identity Id Query

<verato-umpi:create-identity-id-query>

Query Using Link ID This operation makes an HTTP POST request to the /identityIdQuery endpoint

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x  

Content

Binary

the content to use

#[payload]

 

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

 

Streaming Strategy

· Repeatable In Memory Stream

· Repeatable File Store Stream

non-repeatable-stream

Configure if repeatable streams should be used and their behaviour

 

Custom Query Parameters

Object

 

Custom Headers

Object

 

Response Timeout

Number

The timeout for request to the remote service.

 

Response Timeout Unit

Enumeration, one of:

NANOSECONDS

MICROSECONDS

MILLISECONDS

SECONDS

MINUTES

HOURS

DAYS

A time unit which qualifies the Response Timeout}

 

Streaming Type

Enumeration, one of:

AUTO

ALWAYS

NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

 

Target Variable

String

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

 

Target Value

String

An expression that will be evaluated against the operation’s output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

Reconnect

Reconnect Forever

A retry strategy in case of connectivity errors

 

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • VERATO-UMPI:BAD_REQUEST
  • VERATO-UMPI:CLIENT_ERROR
  • VERATO-UMPI:CONNECTIVITY
  • VERATO-UMPI:INTERNAL_SERVER_ERROR
  • VERATO-UMPI:NOT_ACCEPTABLE
  • VERATO-UMPI:NOT_FOUND
  • VERATO-UMPI:RETRY_EXHAUSTED
  • VERATO-UMPI:SERVER_ERROR
  • VERATO-UMPI:SERVICE_UNAVAILABLE
  • VERATO-UMPI:TIMEOUT
  • VERATO-UMPI:TOO_MANY_REQUESTS
  • VERATO-UMPI:UNAUTHORIZED
  • VERATO-UMPI:UNSUPPORTED_MEDIA_TYPE

link Identities

<verato-umpi:create-link-identities>

Link two identities This operation makes an HTTP POST request to the /linkIdentities endpoint

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x  

Content

Binary

the content to use

#[payload]

 

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

 

Streaming Strategy

· Repeatable In Memory Stream

· Repeatable File Store Stream

non-repeatable-stream

Configure if repeatable streams should be used and their behaviour

 

Custom Query Parameters

Object

 

Custom Headers

Object

 

Response Timeout

Number

The timeout for request to the remote service.

 

Response Timeout Unit

Enumeration, one of:

NANOSECONDS

MICROSECONDS

MILLISECONDS

SECONDS

MINUTES

HOURS

DAYS

A time unit which qualifies the Response Timeout}

 

Streaming Type

Enumeration, one of:

AUTO

ALWAYS

NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

 

Target Variable

String

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

 

Target Value

String

An expression that will be evaluated against the operation’s output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

Reconnect

Reconnect Forever

A retry strategy in case of connectivity errors

 

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • VERATO-UMPI:BAD_REQUEST
  • VERATO-UMPI:CLIENT_ERROR
  • VERATO-UMPI:CONNECTIVITY
  • VERATO-UMPI:INTERNAL_SERVER_ERROR
  • VERATO-UMPI:NOT_ACCEPTABLE
  • VERATO-UMPI:NOT_FOUND
  • VERATO-UMPI:RETRY_EXHAUSTED
  • VERATO-UMPI:SERVER_ERROR
  • VERATO-UMPI:SERVICE_UNAVAILABLE
  • VERATO-UMPI:TIMEOUT
  • VERATO-UMPI:TOO_MANY_REQUESTS
  • VERATO-UMPI:UNAUTHORIZED
  • VERATO-UMPI:UNSUPPORTED_MEDIA_TYPE

Merge Identities

<verato-umpi:create-merge-identities>

Merge two identities This operation makes an HTTP POST request to the /mergeIdentities endpoint

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x  

Content

Binary

the content to use

#[payload]

 

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

 

Streaming Strategy

· Repeatable In Memory Stream

· Repeatable File Store Stream

non-repeatable-stream

Configure if repeatable streams should be used and their behaviour

 

Custom Query Parameters

Object

 

Custom Headers

Object

 

Response Timeout

Number

The timeout for request to the remote service.

 

Response Timeout Unit

Enumeration, one of:

NANOSECONDS

MICROSECONDS

MILLISECONDS

SECONDS

MINUTES

HOURS

DAYS

A time unit which qualifies the Response Timeout}

 

Streaming Type

Enumeration, one of:

AUTO

ALWAYS

NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

 

Target Variable

String

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

 

Target Value

String

An expression that will be evaluated against the operation’s output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

Reconnect

Reconnect Forever

A retry strategy in case of connectivity errors

 

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • VERATO-UMPI:BAD_REQUEST
  • VERATO-UMPI:CLIENT_ERROR
  • VERATO-UMPI:CONNECTIVITY
  • VERATO-UMPI:INTERNAL_SERVER_ERROR
  • VERATO-UMPI:NOT_ACCEPTABLE
  • VERATO-UMPI:NOT_FOUND
  • VERATO-UMPI:RETRY_EXHAUSTED
  • VERATO-UMPI:SERVER_ERROR
  • VERATO-UMPI:SERVICE_UNAVAILABLE
  • VERATO-UMPI:TIMEOUT
  • VERATO-UMPI:TOO_MANY_REQUESTS
  • VERATO-UMPI:UNAUTHORIZED
  • VERATO-UMPI:UNSUPPORTED_MEDIA_TYPE

Native Id Query

<verato-umpi:create-native-id-query>

Query Using Native ID This operation makes an HTTP POST request to the /nativeIdQuery endpoint

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x  

Content

Binary

the content to use

#[payload]

 

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

 

Streaming Strategy

· Repeatable In Memory Stream

· Repeatable File Store Stream

non-repeatable-stream

Configure if repeatable streams should be used and their behaviour

 

Custom Query Parameters

Object

 

Custom Headers

Object

 

Response Timeout

Number

The timeout for request to the remote service.

 

Response Timeout Unit

Enumeration, one of:

NANOSECONDS

MICROSECONDS

MILLISECONDS

SECONDS

MINUTES

HOURS

DAYS

A time unit which qualifies the Response Timeout}

 

Streaming Type

Enumeration, one of:

AUTO

ALWAYS

NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

 

Target Variable

String

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

 

Target Value

String

An expression that will be evaluated against the operation’s output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

Reconnect

Reconnect Forever

A retry strategy in case of connectivity errors

 

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • VERATO-UMPI:BAD_REQUEST
  • VERATO-UMPI:CLIENT_ERROR
  • VERATO-UMPI:CONNECTIVITY
  • VERATO-UMPI:INTERNAL_SERVER_ERROR
  • VERATO-UMPI:NOT_ACCEPTABLE
  • VERATO-UMPI:NOT_FOUND
  • VERATO-UMPI:RETRY_EXHAUSTED
  • VERATO-UMPI:SERVER_ERROR
  • VERATO-UMPI:SERVICE_UNAVAILABLE
  • VERATO-UMPI:TIMEOUT
  • VERATO-UMPI:TOO_MANY_REQUESTS
  • VERATO-UMPI:UNAUTHORIZED
  • VERATO-UMPI:UNSUPPORTED_MEDIA_TYPE

Post Identity

<verato-umpi:create-post-identity>

Add an Identity to the link stack This operation makes an HTTP POST request to the /postIdentity endpoint

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x  

Content

Binary

the content to use

#[payload]

 

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

 

Streaming Strategy

· Repeatable In Memory Stream

· Repeatable File Store Stream

non-repeatable-stream

Configure if repeatable streams should be used and their behaviour

 

Custom Query Parameters

Object

 

Custom Headers

Object

 

Response Timeout

Number

The timeout for request to the remote service.

 

Response Timeout Unit

Enumeration, one of:

NANOSECONDS

MICROSECONDS

MILLISECONDS

SECONDS

MINUTES

HOURS

DAYS

A time unit which qualifies the Response Timeout}

 

Streaming Type

Enumeration, one of:

AUTO

ALWAYS

NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

 

Target Variable

String

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

 

Target Value

String

An expression that will be evaluated against the operation’s output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

Reconnect

Reconnect Forever

A retry strategy in case of connectivity errors

 

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • VERATO-UMPI:BAD_REQUEST
  • VERATO-UMPI:CLIENT_ERROR
  • VERATO-UMPI:CONNECTIVITY
  • VERATO-UMPI:INTERNAL_SERVER_ERROR
  • VERATO-UMPI:NOT_ACCEPTABLE
  • VERATO-UMPI:NOT_FOUND
  • VERATO-UMPI:RETRY_EXHAUSTED
  • VERATO-UMPI:SERVER_ERROR
  • VERATO-UMPI:SERVICE_UNAVAILABLE
  • VERATO-UMPI:TIMEOUT
  • VERATO-UMPI:TOO_MANY_REQUESTS
  • VERATO-UMPI:UNAUTHORIZED
  • VERATO-UMPI:UNSUPPORTED_MEDIA_TYPE

Search Notifications

<verato-umpi:create-search-notifications>

Query Notifications This operation makes an HTTP POST request to the /searchNotifications endpoint

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x  

Content

Binary

the content to use

#[payload]

 

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

 

Streaming Strategy

· Repeatable In Memory Stream

· Repeatable File Store Stream

non-repeatable-stream

Configure if repeatable streams should be used and their behaviour

 

Custom Query Parameters

Object

 

Custom Headers

Object

 

Response Timeout

Number

The timeout for request to the remote service.

 

Response Timeout Unit

Enumeration, one of:

NANOSECONDS

MICROSECONDS

MILLISECONDS

SECONDS

MINUTES

HOURS

DAYS

A time unit which qualifies the Response Timeout}

 

Streaming Type

Enumeration, one of:

AUTO

ALWAYS

NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

 

Target Variable

String

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

 

Target Value

String

An expression that will be evaluated against the operation’s output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

Reconnect

Reconnect Forever

A retry strategy in case of connectivity errors

 

Output

Type

Any

Attributes Type

Http Response Attributes

Types

Default Header

Field

Type

Description

Default Value

Required

Key

String

   

x

Value

String

   

x

Default Query Param

Field

Type

Description

Default Value

Required

Key

String

   

x

Value

String

   

x

Proxy

Field

Type

Description

Default Value

Required

Host

String

   

x

Port

Number

   

x

Username

String

     

Password

String

     

Non Proxy Hosts

String

     

Tls

Field

Type

Description

Default Value

Required

Enabled Protocols

String

A comma separated list of protocols enabled for this context.

   

Enabled Cipher Suites

String

A comma separated list of cipher suites enabled for this context.

   

Trust Store

Trust Store

     

Key Store

Key Store

     

Revocation Check

·       Standard Revocation Check

·       Custom Ocsp Responder

·       Crl File

     

Trust Store

Field

Type

Description

Default Value

Required

Path

String

The location (which will be resolved relative to the current classpath and file system, if possible) of the trust store.

   

Password

String

The password used to protect the trust store.

   

Type

String

The type of store used.

   

Algorithm

String

The algorithm used by the trust store.

   

Insecure

Boolean

If true, no certificate validations will be performed, rendering connections vulnerable to attacks. Use at your own risk.

   

Key Store

Field

Type

Description

Default Value

Required

Path

String

The location (which will be resolved relative to the current classpath and file system, if possible) of the key store.

   

Type

String

The type of store used.

   

Alias

String

When the key store contains many private keys, this attribute indicates the alias of the key that should be used. If not defined, the first key in the file will be used by default.

   

Key Password

String

The password used to protect the private key.

   

Password

String

The password used to protect the key store.

   

Algorithm

String

The algorithm used by the key store.

   

Standard Revocation Check

Field

Type

Description

Default Value

Required

Only End Entities

Boolean

Only verify the last element of the certificate chain.

   

Prefer Crls

Boolean

Try CRL instead of OCSP first.

   

No Fallback

Boolean

Do not use the secondary checking method (the one not selected before).

   

Soft Fail

Boolean

Avoid verification failure when the revocation server can not be reached or is busy.

   

Custom Ocsp Responder

Field

Type

Description

Default Value

Required

Url

String

The URL of the OCSP responder.

   

Cert Alias

String

Alias of the signing certificate for the OCSP response (must be in the trust store), if present.

   

Crl File

Field

Type

Description

Default Value

Required

Path

String

The path to the CRL file.

   

Reconnection

Field

Type

Description

Default Value

Required

Fails Deployment

Boolean

When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment will fail if the test doesn’t pass after exhausting the associated reconnection strategy

   

Reconnection Strategy

·       Reconnect

·       Reconnect Forever

The reconnection strategy to use

   

Reconnect

Field

Type

Description

Default Value

Required

Frequency

Number

How often (in ms) to reconnect

   

Blocking

Boolean

If false, the reconnection strategy will run in a separate, non-blocking thread

   

Count

Number

How many reconnection attempts to make

   

Reconnect Forever

Field

Type

Description

Default Value

Required

Frequency

Number

How often (in ms) to reconnect

   

Blocking

Boolean

If false, the reconnection strategy will run in a separate, non-blocking thread

   

Expiration Policy

Field

Type

Description

Default Value

Required

Max Idle Time

Number

A scalar time value for the maximum amount of time a dynamic configuration instance should be allowed to be idle before it’s considered eligible for expiration

   

Time Unit

Enumeration, one of:

·       NANOSECONDS

·       MICROSECONDS

·       MILLISECONDS

·       SECONDS

·       MINUTES

·       HOURS

·       DAYS

A time unit that qualifies the maxIdleTime attribute

   

Http Response Attributes

Field

Type

Description

Default Value

Required

Status Code

Number

   

x

Headers

Object

   

x

Reason Phrase

String

   

x

Repeatable In Memory Stream

Field

Type

Description

Default Value

Required

Initial Buffer Size

Number

This is the amount of memory that will be allocated in order to consume the stream and provide random access to it. If the stream contains more data than can be fit into this buffer, then it will be expanded by according to the bufferSizeIncrement attribute, with an upper limit of maxInMemorySize.

   

Buffer Size Increment

Number

This is by how much will be buffer size by expanded if it exceeds its initial size. Setting a value of zero or lower will mean that the buffer should not expand, meaning that a STREAM_MAXIMUM_SIZE_EXCEEDED error will be raised when the buffer gets full.

   

Max Buffer Size

Number

This is the maximum amount of memory that will be used. If more than that is used then a STREAM_MAXIMUM_SIZE_EXCEEDED error will be raised. A value lower or equal to zero means no limit.

   

Buffer Unit

Enumeration, one of:

·       BYTE

·       KB

·       MB

·       GB

The unit in which all these attributes are expressed

   

Repeatable File Store Stream

Field

Type

Description

Default Value

Required

In Memory Size

Number

Defines the maximum memory that the stream should use to keep data in memory. If more than that is consumed then it will start to buffer the content on disk.

   

Buffer Unit

Enumeration, one of:

·       BYTE

·       KB

·       MB

·       GB

The unit in which maxInMemorySize is expressed