AMQP Tasks
Properties Configuration Settings
An easy-to-use AMQP 1.0 client implementation.
Remarks
The AMQP task provides an easy-to-use AMQP 1.0 client implementation. The task supports both plaintext and TLS-enabled connections over TCP.
AMQP Send Task
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 task.
The task will send the contents of the MessageValue property.
The AMQP Sender Task has support for SSL transport layer security. This may be enabled by setting SSLStartMode, SSLCert and SSLAcceptServerCert to appropriate values.
Sender Property List
The following is the full list of the properties of the sender task with short descriptions. Click on the links for further details.
| AuthScheme | The authentication scheme to use when connecting. |
| ContainerId | The container Id the component should advertise when connecting. |
| Firewall | A set of properties related to firewall access. |
| IdleTimeout | The maximum period of inactivity the component will allow before disconnecting. |
| LinkName | The name of the sender or receiver link. |
| LogFile | The file to write logging information to at runtime. |
| LogMode | What information gets logged during component execution. |
| MessageAbsoluteExpiryTime | The absolute time at which this message should be considered expired. |
| MessageContentEncoding | The content encoding of this message's data. |
| MessageContentType | The content type of this message's data. |
| MessageCorrelationId | The correlation Id of this message. |
| MessageCreationTime | The creation time of this message. |
| MessageDeliveryCount | How many previous attempts there have been to deliver this message. |
| MessageDurable | Whether this message is durable. |
| MessageFirstAcquirer | Whether this message may have been acquired by other links previously. |
| MessageGroupId | The Id of the group this message belongs to. |
| MessageGroupSequence | The position of this message within its group. |
| MessageId | The unique Id of this message. |
| MessagePriority | The priority of this message. |
| MessageReplyTo | The address of the node to send replies to for this message. |
| MessageReplyToGroupId | The Id of the group to send replies to for this message. |
| MessageSettled | Whether this message is settled. |
| MessageSubject | The subject of this message. |
| MessageTo | The address of the node which this message is intended for. |
| MessageTTL | The time-to-live value for this message. |
| MessageUserId | The identity of the user responsible for producing this message. |
| MessageValue | This message's value. |
| MessageValueType | This message's value data type. |
| Other | Defines a set of configuration settings to be used by the component. |
| Password | A password to use for SASL authentication. |
| RemoteHost | The address of the remote host. Domain names are resolved to IP addresses. |
| RemotePort | The port of the AQMP server (default is 5672). |
| RuntimeLicense | Specifies the component runtime license key. |
| SendTarget | The address of the node at the target receiver. |
| SessionName | The name of the session to send to or receive from. |
| SSLAcceptServerCert | Instructs the component to unconditionally accept the server certificate that matches the supplied certificate. |
| SSLAcceptServerCertAcceptAny | Tells the component to accept any server certificate. |
| SSLCert | The certificate to use for client authentication during the SSL handshake. |
| SSLStartMode | Determines how the component starts the SSL negotiation. |
| Timeout | A timeout for the component. |
| User | A username to use for SASL authentication. |
Configuration Settings
The following is a list of configuration settings for the task with short descriptions. Click on the links for further details.
| AuthorizationIdentity | The value to use as the authorization identity when SASL authentication is used. |
| DefaultCredit | The amount of credit to create new receiver links with. |
| DefaultCreditThreshold | The credit threshold to create new receiver links with. |
| DefaultIncomingWindow | The incoming window size to create new sessions with. |
| DefaultOutgoingWindow | The outgoing window size to create new sessions with. |
| DefaultSenderSettleMode | The sender settle mode to create new links with. |
| GenerateCreationTime | Whether the message creation time should be automatically generated when sending a message. |
| GenerateMessageId | Whether a unique message Id should be automatically generated when sending a message. |
| MaxFrameSize | The maximum frame size. |
| MaxMessageSize | The maximum message size to restrict new links to. |
| MessageRelativeExpirationTime | Sets the number of seconds until the message expires. |
| ProtocolVersion | The AMQP protocol version to conform to. |
| ReuseSSLSession | Determines if the SSL session is reused. |
| SSLCipherStrength | The minimum cipher strength used for bulk encryption. |
| SSLEnabledCipherSuites | The cipher suite to be used in an SSL negotiation. |
| SSLEnabledProtocols | Used to enable/disable the supported security protocols. |
| SSLIncludeCertChain | Whether the entire certificate chain is included in the SSLServerAuthentication event. |
| SSLSecurityFlags | Flags that control certificate verification. |
| TLS12SignatureAlgorithms | Defines the allowed TLS 1.2 signature algorithms when UseInternalSecurityAPI is True. |
| TLS12SupportedGroups | The supported groups for ECC. |
| TLS13KeyShareGroups | The groups for which to pregenerate key shares. |
| TLS13SignatureAlgorithms | The allowed certificate signature algorithms. |
| TLS13SupportedGroups | The supported groups for (EC)DHE key exchange. |
| AbsoluteTimeout | Determines whether timeouts are inactivity timeouts or absolute timeouts. |
| LocalHost | The name of the local host or user-assigned IP interface through which connections are initiated or accepted. |
| TcpNoDelay | Whether or not to delay when sending packets. |
| UseInternalSecurityAPI | Tells the component whether or not to use the system security libraries or an internal implementation. |