/n software Connectors for MuleSoft

Questions / Feedback?

XMPP Connector

Properties   Configuration Settings  

The XMPP Connector adds instant messaging functionality to your MuleSoft.

Remarks

eXtensible Messaging and Presence Protocol is a highly extensible instant message service based on XML packets. The XMPP Connector is a lightweight XMPP instant messaging client which enables you to send instant messages to any XMPP client within your service's network.

XMPP Send Connector

At a minimum, you must supply an IMServer, IMPort for the connection and a ToJID for the intended recipient of the message. In order to authenticate with the XMPP server you will need to specify a User and Password. The AuthMethods property contains a preferential list of authentication methods to be enabled on the connector.

The connector will send the contents of the MessageText property as the instant message body. The connector also supports sending HTML in the message body via the MessageHTML property.

A simple text message in the MessageText property can alternatively be treated as HTML via the TreatMessageAsHTML configuration setting. Also, when sending to clients that may not support reading HTML entities, ParseHTML can be set to cause the connector to parse an HTML entity into the simple text body of the instant message.

The XMPP Send Connector has support for SSL transport layer security. This may be enabled by setting SSLStartMode, SSLCert and SSLAcceptServerCert to appropriate values.

Send Example

Add an XMPP Send Connector to your flow and configure the connection settings to get started. To send a message, either provide a message in the MessageText or MessageHTML properties or optionally add a File Read connector immediately in front of the XMPP Send Connector. There is no need to transform the File Read output before passing it to the connector. That is all that is required to send a message.

Receiver Property List


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

AuthMethodsControls how the connector authenticates itself with the XMPP server.
ChatroomThe name of the chatroom to join.
ChatroomNicknameThe nickname to be used within the chatroom.
ChatroomPasswordThe password for the chatroom specified in the Chatroom configuration option.
FirewallA set of properties related to firewall access.
FromJIDThe ID of the user that sent the message.
IMPortThe server port for XMPP (default 5222).
IMServerThis is the instant messaging server.
LogFileThe file to write logging information to at runtime.
LogModeWhat information gets logged during connector execution.
LogTypeHow information gets logged during connector execution.
MessageOtherDataThis property contains extra data for the current message.
MessageReceivedTimeThe timestamp for when an offline message was received.
MessageSubjectThis is the subject of the current message.
MessageThreadThis is the thread name of the current message.
OtherDefines a set of configuration settings to be used by the connector.
PasswordThis is the user's password.
PersistentConnectionInstructs the connector whether to keep the connection to the server open.
ResourceThis is the resource for the current session.
RuntimeLicenseSpecifies the connector runtime license key.
SSLAcceptServerCertInstructs the connector 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 connector starts the SSL negotiation.
TimeoutA timeout for the connector.
ToJIDA semicolon-separated list of destination nodes to receive the current message.
UserThe user portion of this entity's Jabber ID.

Sender Property List


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

AuthMethodsControls how the connector authenticates itself with the XMPP server.
ChatroomThe name of the chatroom to join.
ChatroomNicknameThe nickname to be used within the chatroom.
ChatroomPasswordThe password for the chatroom specified in the Chatroom configuration option.
FirewallA set of properties related to firewall access.
IMPortThe server port for XMPP (default 5222).
IMServerThis is the instant messaging server.
LogFileThe file to write logging information to at runtime.
LogModeWhat information gets logged during connector execution.
LogTypeHow information gets logged during connector execution.
MessageHTMLThis is the HTML version of the current message.
MessageOtherDataThis property contains extra data for the current message.
MessageSubjectThis is the subject of the current message.
MessageTextThis is the plain text of the current message.
MessageThreadThis is the thread name of the current message.
MessageTypeThis is the type of the current message.
OtherDefines a set of configuration settings to be used by the connector.
PasswordThis is the user's password.
PersistentConnectionInstructs the connector whether to keep the connection to the server open.
ResourceThis is the resource for the current session.
RuntimeLicenseSpecifies the connector runtime license key.
SSLAcceptServerCertInstructs the connector 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 connector starts the SSL negotiation.
TimeoutA timeout for the connector.
ToJIDA semicolon-separated list of destination nodes to receive the current message.
UserThe user portion of this entity's Jabber ID.

Configuration Settings


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

AuthDomainThe domain under which the user must authenticate.
DateTimeFormatThe DateTime format for the MessageReceivedTime message context property.
ParseHTMLTells the connector to parse MessageHTML into a plaintext representation.
ServerDomainThis is the domain of the XMPP service.
TreatMessageAsHTMLTells the connector to treat the message contents as HTML.
UserDomainThe domain under which the user has registered with the XMPP service.
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.
TLS13SignatureAlgorithmsThe allowed certificate signature algorithms.
TLSNamedGroupsThe supported (EC)DHE groups.
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 connector whether or not to use the system security libraries or an internal implementation.

 
 
Copyright (c) 2021 /n software inc. - All rights reserved.
/n software Connectors for MuleSoft - Version 20.0 [Build 7722]