Jabber API

Overview

These public interfaces are used in Jabber related services components. They are provided for implementing advanced functionality in your scripts. In order for you to use these interfaces in your project, you have to reference CozyRoc.SSISPlus.dll library.

IJabberConnection

When you call Jabber Connection Manager AcquireConnection method, it returns object implementing IJabberConnection interface. This is the interface used for interaction with Jabber Server. The Jabber Connection Manager is based on jabber-net library.

Connect method

Connects to Jabber server. The result is JabberClient object.

Close method

Closes the connection to a Jabber Server. Use always after you finish working with the server.

IsConnected method

Returns true if connected to the server.

ServerUser property (string)

Specify user name in email-like format to connect Jabber server.

ServerPassword property (string)

Specify user password to access the Jabber server.

ServerTimeout property (int)

Specify the number of seconds before timing out session connect. The default value of this property is 30.

NetworkHost property (string)

Specify the network host of the Jabber server. Set this property if you have issues resolving the domain name of the Jabber server.

ServerPort property (int)

Specify the port number on the Jabber server to use for the connection. The default value of this property is 5222.

UsePlainText property (bool)

Set to true to use plain text authentication when connecting to the Jabber server.

UseSSL property (bool)

Set to true to use secure-sockets layer when connecting to the Jabber server.

ConnectionType property (int)

Specify connection type to Jabber server. This property has the options listed in the following table

Value Description
0 Use "Normal" XMPP socket.
1 Use XMPP protocol extension that enables access to a Jabber server from behind firewalls which do not allow outgoing sockets on port 5222, via HTTP requests
2 Use a transport protocol specification that emulates a bidirectional stream between two entities (such as a client and a server) by efficiently using multiple synchronous HTTP request/response pairs without requiring the use of polling or asynchronous chunking.
PollingURL property (string)

Contains the URL to poll on, or bind to. Related to ConnectionType property.

RetainSameConnection property (bool)

Set to true to use same connection to Jabber server. This implies the connection to Jabber server will stay alive during the package execution. The default value of this property is true.

ProxyType property (int)

Specify proxy type. This property has the options listed in the following table.

Value Description
0 Proxy not specified
1 Use SOCKS4 proxy type.
2 Use SOCKS5 proxy type.
3 Use HTTP CONNECT proxy type.
ProxyHost property (string)

Specify the name or IP address of the proxy server.

ProxyPort property (int)

Specify the port number on the proxy server to use for the connection. The default value of this property is 80.

ProxyUser property (string)

Specify user name to access the proxy server.

ProxyPassword property (string)

Specify password to access the proxy server.