/n software Adapters for BizTalk

Questions / Feedback?

AMQP Adapter

Properties   Configuration Settings  

An easy-to-use AMQP 1.0 client implementation.

Remarks

The AMQP adapter provides an easy-to-use AMQP 1.0 client implementation. The adapter supports both plaintext and TLS-enabled connections over TCP.

AMQP Receive Adapter

At a minimum, you must supply an RemoteHost, RemotePort, and ContainerId for the connection. In order to authenticate with the AMQP broker you will need to specify a User and Password. The AuthScheme property contains a preferential list of authentication methods to be enabled on the adapter.

Setting SessionName will create a session with the specified name on the broker, and a receiver link will be created on the broker using the specified SessionName, LinkName, and (if necessary) a ReceiveSource for the sender to route the link creation request to.

The adapter will connect to the AMQP broker on the first PollingInterval and remain connected to receive incoming messages. It will remain connected until the adapter is shut down.

AMQP Send Adapter

At a minimum, you must supply an RemoteHost, RemotePort, and ContainerId for the connection. In order to authenticate with the AMQP broker you will need to specify a User and Password. The AuthScheme property contains a preferential list of authentication methods to be enabled on the adapter.

By default, the adapter will attempt to send the contents of the outbound BizTalk Server message as the message body. This can be overridden by setting a static message in the send port's MessageValue property at design-time. To set a dynamic message, you can write to the same property in the message context at runtime. The adapter will send the contents of the MessageValue property.

The AMQP Sender and Receiver Adapter has support for SSL transport layer security. This may be enabled by setting SSLStartMode, SSLCert and SSLAcceptServerCert to appropriate values.

Please refer to the section on adapter configuration for a description of how to configure receive locations and send ports for this adapter.

Receiver Property List


The following is the full list of the properties of the receiver adapter with short descriptions. Click on the links for further details.

AuthSchemeThe authentication scheme to use when connecting.
ContainerIdThe container Id the adapter should advertise when connecting.
ErrorThresholdThe maximum number of errors before the adapter shuts down.
FirewallA set of properties related to firewall access.
IdleTimeoutThe maximum period of inactivity the adapter will allow before disconnecting.
LinkNameThe name of the sender or receiver link.
MaxBatchSizeThe maximum size, in MB, of the current batch (0 indicates no limit).
MaxFileCountThe maximum number of files in the current batch (0 indicates no limit).
MaxFileSizeThe maximum size, in MB, of a file in the current batch (0 indicates no limit).
MaxThreadsThe maximum number of threads that the adapter may consume.
MessageAbsoluteExpiryTimeThe absolute time at which this message should be considered expired.
MessageContentEncodingThe content encoding of this message's data.
MessageContentTypeThe content type of this message's data.
MessageCorrelationIdThe correlation Id of this message.
MessageCreationTimeThe creation time of this message.
MessageDeliveryCountHow many previous attempts there have been to deliver this message.
MessageDurableWhether this message is durable.
MessageFirstAcquirerWhether this message may have been acquired by other links previously.
MessageGroupIdThe Id of the group this message belongs to.
MessageGroupSequenceThe position of this message within its group.
MessageIdThe unique Id of this message.
MessageLinkNameThe name of the link this message is associated with.
MessagePriorityThe priority of this message.
MessageReplyToThe address of the node to send replies to for this message.
MessageReplyToGroupIdThe Id of the group to send replies to for this message.
MessageSettledWhether this message is settled.
MessageSubjectThe subject of this message.
MessageToThe address of the node which this message is intended for.
MessageTTLThe time-to-live value for this message.
MessageUserIdThe identity of the user responsible for producing this message.
MessageValueTypeThis message's value data type.
OtherDefines a set of configuration settings to be used by the adapter.
PasswordA password to use for SASL authentication.
PollingIntervalThe amount of time, in seconds, between download attempts.
ReceiveSourceThe address of the node at the remote host acting as the sender.
RemoteHostThe address of the remote host. Domain names are resolved to IP addresses.
RemotePortThe port of the AQMP server (default is 5672).
RequeueEndpointsWhether to requeue receive endpoints if the polling interval has not been reached.
RuntimeLicenseSpecifies the adapter runtime license key.
SessionNameThe name of the session to send to or receive from.
SSLAcceptServerCertInstructs the adapter to unconditionally accept the server certificate that matches the supplied certificate.
SSLCertThe certificate to use for client authentication during the SSL handshake.
SSLStartModeDetermines how the adapter starts the SSL negotiation.
TimeoutA timeout for the adapter.
TransportLogTells the adapter where and how to report information about its operations.
URIThe Uniform Resource Identifier (URI) of the send port or receive location.
UserA username to use for SASL authentication.

Sender Property List


The following is the full list of the properties of the sender adapter with short descriptions. Click on the links for further details.

AuthSchemeThe authentication scheme to use when connecting.
ConnectionLifetimeInstructs the adapter whether or not to leave the connection to the server open.
ContainerIdThe container Id the adapter should advertise when connecting.
FirewallA set of properties related to firewall access.
IdleTimeoutThe maximum period of inactivity the adapter will allow before disconnecting.
LinkNameThe name of the sender or receiver link.
MaxPersistentConnectionsThe maximum number of simultaneous persistent connections when sending.
MaxThreadsThe maximum number of threads that the adapter may consume.
MaxTransmissionBatchSizeThe maximum number of messages that can be sent in a single batch.
MessageAbsoluteExpiryTimeThe absolute time at which this message should be considered expired.
MessageContentEncodingThe content encoding of this message's data.
MessageContentTypeThe content type of this message's data.
MessageCorrelationIdThe correlation Id of this message.
MessageCreationTimeThe creation time of this message.
MessageDeliveryCountHow many previous attempts there have been to deliver this message.
MessageDurableWhether this message is durable.
MessageFirstAcquirerWhether this message may have been acquired by other links previously.
MessageGroupIdThe Id of the group this message belongs to.
MessageGroupSequenceThe position of this message within its group.
MessageIdThe unique Id of this message.
MessagePriorityThe priority of this message.
MessageReplyToThe address of the node to send replies to for this message.
MessageReplyToGroupIdThe Id of the group to send replies to for this message.
MessageSettledWhether this message is settled.
MessageSubjectThe subject of this message.
MessageToThe address of the node which this message is intended for.
MessageTTLThe time-to-live value for this message.
MessageUserIdThe identity of the user responsible for producing this message.
MessageValueThis message's value.
MessageValueTypeThis message's value data type.
OtherDefines a set of configuration settings to be used by the adapter.
PasswordA password to use for SASL authentication.
RemoteHostThe address of the remote host. Domain names are resolved to IP addresses.
RemotePortThe port of the AQMP server (default is 5672).
RuntimeLicenseSpecifies the adapter runtime license key.
SendTargetThe address of the node at the target receiver.
SessionNameThe name of the session to send to or receive from.
SSLAcceptServerCertInstructs the adapter to unconditionally accept the server certificate that matches the supplied certificate.
SSLCertThe certificate to use for client authentication during the SSL handshake.
SSLStartModeDetermines how the adapter starts the SSL negotiation.
TimeoutA timeout for the adapter.
TransmitBatchModeHow the transmitter processes batches.
TransportLogTells the adapter where and how to report information about its operations.
URIThe Uniform Resource Identifier (URI) of the send port or receive location.
UserA username to use for SASL authentication.

Configuration Settings


The following is a list of configuration settings for the adapter with short descriptions. Click on the links for further details.

AuthorizationIdentityThe value to use as the authorization identity when SASL authentication is used.
DefaultCreditThe amount of credit to create new receiver links with.
DefaultCreditThresholdThe credit threshold to create new receiver links with.
DefaultIncomingWindowThe incoming window size to create new sessions with.
DefaultOutgoingWindowThe outgoing window size to create new sessions with.
DefaultSenderSettleModeThe sender settle mode to create new links with.
GenerateMessageIdWhether a unique message Id should be automatically generated when sending a message.
MaxFrameSizeThe maximum frame size.
MaxMessageSizeThe maximum message size to restrict new links to.
ProtocolVersionThe AMQP protocol version to conform to.
ReuseSSLSessionDetermines if the SSL session is reused.
SSLCipherStrengthThe minimum cipher strength used for bulk encryption.
SSLEnabledCipherSuitesThe cipher suite to be used in an SSL negotiation.
SSLEnabledProtocolsUsed to enable/disable the supported security protocols.
SSLIncludeCertChainWhether the entire certificate chain is included in the SSLServerAuthentication event.
SSLSecurityFlagsFlags that control certificate verification.
TLS12SignatureAlgorithmsDefines the allowed TLS 1.2 signature algorithms when UseInternalSecurityAPI is True.
TLS12SupportedGroupsThe supported groups for ECC.
TLS13KeyShareGroupsThe groups for which to pregenerate key shares.
TLS13SignatureAlgorithmsThe allowed certificate signature algorithms.
TLS13SupportedGroupsThe supported groups for (EC)DHE key exchange.
AbsoluteTimeoutDetermines whether timeouts are inactivity timeouts or absolute timeouts.
LocalHostThe name of the local host or user-assigned IP interface through which connections are initiated or accepted.
TcpNoDelayWhether or not to delay when sending packets.
UseInternalSecurityAPITells the adapter whether or not to use the system security libraries or an internal implementation.

 
 
Copyright (c) 2021 /n software inc. - All rights reserved.
/n software Adapters for BizTalk - Version 20.0 [Build 7877]