XMPP Class
Properties Methods Events Config Settings Errors
The XMPP Class is used to create a lightweight messaging client using the XMPP (Jabber) protocol.
Syntax
ipworks.XMPP
Remarks
The XMPP class supports both plaintext and Secure Sockets Layer/Transport Layer Security (SSL/TLS) connections. When connecting over Secure Sockets Layer/Transport Layer Security (SSL/TLS) the SSLServerAuthentication event allows you to check the server identity and other security attributes. The SSLStatus event provides information about the SSL handshake. Additional SSL-related settings are also supported through the Config method.
A call to the ConnectTo method will perform the entire logon process after which a Connected event will fire to indicate the connection status. For simplicity, the entire interface is synchronous; the class will not return until a call is completed.
After a successful connection, the class will automatically begin the process of receiving the user's buddy list. The class will parse the XML as it comes in from the server and will set the appropriate properties. Once the entire buddy list has been retrieved, a Sync event will fire.
Sending a message is as simple as calling a single method. One call to the SendMessage method will cause the class to connect if it has not already done so, send the specified message to a specified user, and return to the original connection state.
The XMPP Class interface supports messaging, list, and presence management. Other features of the XMPP protocol are supported through the SendCommand method and PITrail event.
Example 1. Connecting and Sending a Message:
IMControl.ConnectTo("myusername", "mypassword")
IMControl.MessageText = "My Message"
IMControl.SendMessage("ToUser")
Example 2. Sending a Single Message:
IMControl.User = "myusername"
IMControl.Password = "mypassword"
IMControl.MessageText = "My Message"
IMControl.SendMessage("ToUser")
Property List
The following is the full list of the properties of the class with short descriptions. Click on the links for further details.
AuthDomain | This property includes the domain under which the user will be authenticated. |
AuthMethods | This property controls how the class authenticates itself with the XMPP server. |
Buddies | This property includes a collection of buddies in the buddy list. |
Connected | This property indicates whether the class is connected and logged in. |
Firewall | A set of properties related to firewall access. |
IMPort | This property includes the server port for XMPP (default 5222). |
IMServer | This property is the instant messaging server. |
LocalDirectory | This property includes the directory to which received files are saved. |
LocalFile | This property includes the path to the file that will be sent. |
LocalHost | This property includes the name of the local host or user-assigned IP interface through which connections are initiated or accepted. |
MessageHTML | This property includes the HTML version of the current message. |
MessageOtherData | This property contains extra data elements for the current message. |
MessageSubject | This property is the subject of the current message. |
MessageText | This property is the plaintext version of the current message. |
MessageThread | This property is the thread name of the current message. |
MessageType | This property is the type of the current message. |
Password | This property is the user's password. |
Presence | This property indicates the availability of the entity. |
Resource | This property is the resource for the current session. |
ServerDomain | This property includes the XMPP server's domain. |
SSLAcceptServerCert | This property instructs the class to unconditionally accept the server certificate that matches the supplied certificate. |
SSLCert | This property includes the certificate to be used during Secure Sockets Layer (SSL) negotiation. |
SSLEnabled | This property indicates whether Transport Layer Security/Secure Sockets Layer (TLS/SSL) is enabled. |
SSLProvider | This property specifies the Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use. |
SSLServerCert | This property includes the server certificate for the last established connection. |
SSLStartMode | This property determines how the class starts the Secure Sockets Layer (SSL) negotiation. |
Status | This property holds the description of the availability of this entity. |
Timeout | This property includes the timeout for the class. |
User | This property includes the user portion of this entity's Jabber Id. |
UserDomain | This property gets or sets the domain value used for Jabber Ids. |
UserInfo | This property includes the collection of named registration fields. |
Method List
The following is the full list of the methods of the class with short descriptions. Click on the links for further details.
Add | This method will add an entity to this entity's roster. |
Cancel | This method will cancel another entity's subscription to this entity's presence. |
ChangePassword | This method will change the current user's password. |
ChangePresence | This method will set the availability and status of this entity. |
Config | Sets or retrieves a configuration setting. |
Connect | This method will connect the class to the server. |
ConnectTo | This method will connect the class to the server. |
Disconnect | This method disconnects the class from the server. |
DoEvents | This method processes events from the internal message queue. |
Interrupt | This method interrupts the current method. |
ProbePresence | Use this method to probe for another entity's presence. |
QueryRegister | This method queries a server for the necessary registration fields. |
Register | This method registers an account with a server. |
Remove | This method will remove an entity from this entity's roster. |
Reset | This method will reset the class. |
RetrieveRoster | This method will retrieve this entity's roster from the server. |
SendCommand | This method sends a command to the server. |
SendFile | This method sends a file to the specified user. |
SendMessage | This method will send a message to the specified user. |
SetReceiveStream | This method sets the stream to which the received file data will be written. |
SetSendStream | This method sets the stream to be sent. |
SetUserInfoField | This method will add a user information field for registration. |
SubscribeTo | Use this method to subscribe to another entity's presence. |
Unregister | This method cancels an account with the host. |
UnsubscribeTo | This method will cancel a subscription to another entity's presence. |
UpdateBuddyGroup | This method updates the buddy's associated groups. |
Event List
The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.
BuddyUpdate | This event is fired whenever a roster entry is updated. |
Connected | This event is fired when a connection to the IM server is completed. |
ConnectionStatus | This event is fired to indicate changes in the connection state. |
Disconnected | This event is fired when the chat service connection is lost. |
EndTransfer | This event is fired when a file transfer completes. |
Error | This event is fired when the server sends a protocol error message. |
IQ | This event is fired for IQ messages not normally supported by the class. |
MessageIn | This event is fired upon receipt of a message. |
PITrail | This event is fired for all protocol messages. |
Presence | This event is fired when the presence of a subscribed entity changes. |
ReadyToSend | This event is fired when the class is ready to send data. |
SSLServerAuthentication | Fired after the server presents its certificate to the client. |
SSLStatus | Fired when secure connection progress messages are available. |
StartTransfer | This event is fired when a file transfer begins. |
SubscriptionRequest | This event fires when a subscription request is received. |
Sync | This event fires upon a complete information synchronization with the server. |
Transfer | This event is fired during file transfer. |
Config Settings
The following is a list of config settings for the class with short descriptions. Click on the links for further details.
AccessToken | The OAuth access token used for authentication. |
BlockSize | Specifies the block size for file transfers. |
ClientId | The OAuth client Id used for authentication. |
MessageId | Specifies the number used in the message Id. |
MessageXML | Returns the last root-level element received by the class. |
Overwrite | Specifies whether or not to overwrite received files. |
ParseHTML | Tells XMPP whether or not to parse MessageHTML when it's set. |
RetrieveRoster | Whether to automatically retrieve the roster when logging in. |
SendSubscriptionResponse | Determines whether a response will be sent to a Subscription Request. |
UseCompression | Specified whether or not stream compression is used. |
CloseStreamAfterTransfer | If true, the class will close the upload or download stream after the transfer. |
ConnectionTimeout | Sets a separate timeout value for establishing a connection. |
FirewallAutoDetect | Tells the class whether or not to automatically detect and use firewall system settings, if available. |
FirewallHost | Name or IP address of firewall (optional). |
FirewallListener | If true, the class binds to a SOCKS firewall as a server (TCPClient only). |
FirewallPassword | Password to be used if authentication is to be used when connecting through the firewall. |
FirewallPort | The TCP port for the FirewallHost;. |
FirewallType | Determines the type of firewall to connect through. |
FirewallUser | A user name if authentication is to be used connecting through a firewall. |
KeepAliveInterval | The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received. |
KeepAliveTime | The inactivity time in milliseconds before a TCP keep-alive packet is sent. |
Linger | When set to True, connections are terminated gracefully. |
LingerTime | Time in seconds to have the connection linger. |
LocalHost | The name of the local host through which connections are initiated or accepted. |
LocalPort | The port in the local host where the class binds. |
MaxLineLength | The maximum amount of data to accumulate when no EOL is found. |
MaxTransferRate | The transfer rate limit in bytes per second. |
ProxyExceptionsList | A semicolon separated list of hosts and IPs to bypass when using a proxy. |
TCPKeepAlive | Determines whether or not the keep alive socket option is enabled. |
TcpNoDelay | Whether or not to delay when sending packets. |
UseIPv6 | Whether to use IPv6. |
UseNTLMv2 | Whether to use NTLM V2. |
LogSSLPackets | Controls whether SSL packets are logged when using the internal security API. |
ReuseSSLSession | Determines if the SSL session is reused. |
SSLCACerts | A newline separated list of CA certificate to be included when performing an SSL handshake. |
SSLCheckCRL | Whether to check the Certificate Revocation List for the server certificate. |
SSLCheckOCSP | Whether to use OCSP to check the status of the server certificate. |
SSLCipherStrength | The minimum cipher strength used for bulk encryption. |
SSLClientCACerts | A newline separated list of CA certificates to use during SSL client certificate validation. |
SSLContextProtocol | The protocol used when getting an SSLContext instance. |
SSLEnabledCipherSuites | The cipher suite to be used in an SSL negotiation. |
SSLEnabledProtocols | Used to enable/disable the supported security protocols. |
SSLEnableRenegotiation | Whether the renegotiation_info SSL extension is supported. |
SSLIncludeCertChain | Whether the entire certificate chain is included in the SSLServerAuthentication event. |
SSLKeyLogFile | The location of a file where per-session secrets are written for debugging purposes. |
SSLNegotiatedCipher | Returns the negotiated cipher suite. |
SSLNegotiatedCipherStrength | Returns the negotiated cipher suite strength. |
SSLNegotiatedCipherSuite | Returns the negotiated cipher suite. |
SSLNegotiatedKeyExchange | Returns the negotiated key exchange algorithm. |
SSLNegotiatedKeyExchangeStrength | Returns the negotiated key exchange algorithm strength. |
SSLNegotiatedVersion | Returns the negotiated protocol version. |
SSLServerCACerts | A newline separated list of CA certificates to use during SSL server certificate validation. |
SSLTrustManagerFactoryAlgorithm | The algorithm to be used to create a TrustManager through TrustManagerFactory. |
TLS12SignatureAlgorithms | Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal. |
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. |
FirewallData | Used to send extra data to the firewall. |
InBufferSize | The size in bytes of the incoming queue of the socket. |
OutBufferSize | The size in bytes of the outgoing queue of the socket. |
BuildInfo | Information about the product's build. |
GUIAvailable | Whether or not a message loop is available for processing events. |
LicenseInfo | Information about the current license. |
MaskSensitiveData | Whether sensitive data is masked in log messages. |
UseDaemonThreads | Whether threads created by the class are daemon threads. |
UseInternalSecurityAPI | Whether or not to use the system security libraries or an internal implementation. |
AuthDomain Property (XMPP Class)
This property includes the domain under which the user will be authenticated.
Syntax
public String getAuthDomain(); public void setAuthDomain(String authDomain);
Default Value
""
Remarks
Set this value if the user must authenticate through a third-party authentication service that requires a different domain than the XMPP user's registered domain.
AuthMethods Property (XMPP Class)
This property controls how the class authenticates itself with the XMPP server.
Syntax
public String getAuthMethods(); public void setAuthMethods(String authMethods);
Default Value
"*"
Remarks
AuthMethods is a comma-separated list of authentication methods to be enabled on the class, listed in order of preference. When authenticating, the class will pick the first method in the list that is supported by the server.
The special value * (default) may be supplied to cause the class to enable all supported authentication methods in order of presumed security. The XMPP class currently supports the following values for AuthMethods, listed in order of most secure to least secure:
- SASL/DIGEST-MD5
- AuthIQ/Digest
- SASL/CRAM-MD5
- SASL/PLAIN
- AuthIQ/Plaintext
- SASL/NTLM
Buddies Property (XMPP Class)
This property includes a collection of buddies in the buddy list.
Syntax
public XMPPBuddyList getBuddies();
Remarks
After a Sync event is fired, this property will contain a collection of all buddies in the buddy list. The buddy list will be updated by the server when a successful call to RetrieveRoster has been made.
This collection is indexed from 0 to size -1.
This property is read-only.
Please refer to the XMPPBuddy type for a complete list of fields.Connected Property (XMPP Class)
This property indicates whether the class is connected and logged in.
Syntax
public boolean isConnected();
Default Value
False
Remarks
This property indicates whether the class is connected and logged in to the remote host. Use the Connect and Disconnect methods to manage the connection.
This property is read-only and not available at design time.
Firewall Property (XMPP Class)
A set of properties related to firewall access.
Syntax
public Firewall getFirewall(); public void setFirewall(Firewall firewall);
Remarks
This is a Firewall-type property, which contains fields describing the firewall through which the class will attempt to connect.
Please refer to the Firewall type for a complete list of fields.IMPort Property (XMPP Class)
This property includes the server port for XMPP (default 5222).
Syntax
public int getIMPort(); public void setIMPort(int IMPort);
Default Value
5222
Remarks
For an implicit Secure Sockets Layer (SSL), use port 5223. For more information, please refer to the SSLStartMode property.
A valid port number (a value between 1 and 65535) is required for the connection to take place. The property must be set before a connection is attempted and cannot be changed once a connection is established. Any attempt to change this property while connected will fail with an error.
IMServer Property (XMPP Class)
This property is the instant messaging server.
Syntax
public String getIMServer(); public void setIMServer(String IMServer);
Default Value
""
Remarks
This is the instant messaging server to which the class will connect when the Connect method is called. The IMServer property must contain a valid XMPP (Jabber) server, or any subsequent calls to the Connect method will fail.
LocalDirectory Property (XMPP Class)
This property includes the directory to which received files are saved.
Syntax
public String getLocalDirectory(); public void setLocalDirectory(String localDirectory);
Default Value
""
Remarks
This property specifies the directory on disk to which received files will be saved. If this property is not set and a file is received, the file data will be available through the Transfer event parameters. This property may also be set when the StartTransfer event fires.
LocalFile Property (XMPP Class)
This property includes the path to the file that will be sent.
Syntax
public String getLocalFile(); public void setLocalFile(String localFile);
Default Value
""
Remarks
This property specifies the local file that will be sent when calling SendFile. This property must be set before calling SendFile.
LocalHost Property (XMPP Class)
This property includes the name of the local host or user-assigned IP interface through which connections are initiated or accepted.
Syntax
public String getLocalHost(); public void setLocalHost(String localHost);
Default Value
""
Remarks
The LocalHost property contains the name of the local host as obtained by the gethostname() system call, or if the user has assigned an IP address, the value of that address.
In multihomed hosts (machines with more than one IP interface) setting LocalHost to the IP address of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface. It is recommended to provide an IP address rather than a hostname when setting this property to ensure the desired interface is used.
If the class is connected, the LocalHost property shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multihomed hosts (machines with more than one IP interface).
Note: LocalHost is not persistent. You must always set it in code, and never in the property window.
MessageHTML Property (XMPP Class)
This property includes the HTML version of the current message.
Syntax
public String getMessageHTML(); public void setMessageHTML(String messageHTML);
Default Value
""
Remarks
If the user wishes to send any HTML as a part of the message, it must be set in the MessageHTML property. The HTML must be an entire HTML document, including the <html> and <body> tags. If the HTML has unbalanced tags, the XMPP class will fail with an error.
This property is not available at design time.
MessageOtherData Property (XMPP Class)
This property contains extra data elements for the current message.
Syntax
public String getMessageOtherData(); public void setMessageOtherData(String messageOtherData);
Default Value
""
Remarks
MessageOtherData will contain zero or more complete XML elements that are associated with the message but that are not defined in the Jabber specification.
MessageSubject Property (XMPP Class)
This property is the subject of the current message.
Syntax
public String getMessageSubject(); public void setMessageSubject(String messageSubject);
Default Value
""
Remarks
MessageSubject will contain any subject associated with the message. Most Jabber clients will ignore the subject unless the message is of type "headline".
This property is not available at design time.
MessageText Property (XMPP Class)
This property is the plaintext version of the current message.
Syntax
public String getMessageText(); public void setMessageText(String messageText);
Default Value
""
Remarks
MessageText is the plaintext version of the current message, taken from the message's "body" child element. The text in this property is automatically escaped to ensure valid XML parsing on the other end.
This property is not available at design time.
MessageThread Property (XMPP Class)
This property is the thread name of the current message.
Syntax
public String getMessageThread(); public void setMessageThread(String messageThread);
Default Value
""
Remarks
MessageThread will contain the name of the thread associated with the message. Threads are useful for tracking messages of type "chat" or "groupchat".
This property is not available at design time.
MessageType Property (XMPP Class)
This property is the type of the current message.
Syntax
public int getMessageType(); public void setMessageType(int messageType); Enumerated values: public final static int jmtNormal = 0; public final static int jmtChat = 1; public final static int jmtGroupChat = 2; public final static int jmtHeadline = 3; public final static int jmtError = 4;
Default Value
0
Remarks
MessageType is the type of the message as specified in the XMPP RFC. The possible values are defined in the protocol specification as follows:
normal (jmtNormal - 0) | A single message. |
chat (jmtChat - 1) | A message sent in the context of a two-way chat between two entities. |
groupchat (jmtGroupChat - 2) | A message sent in the context of a multiuser chat among multiple entities. |
headline (jmtHeadline - 3) | A message that represents one of a list of items (e.g., in a news feed or information ticker). |
error (jmtError - 4) | A message returned to a sender specifying an error associated with a previous message sent by the sender to an intended recipient. |
This property is not available at design time.
Password Property (XMPP Class)
This property is the user's password.
Syntax
public String getPassword(); public void setPassword(String password);
Default Value
""
Remarks
This property must be set before a connection is attempted. If a call to the Connect method is made specifying a password, then the Password property will contain that password.
Presence Property (XMPP Class)
This property indicates the availability of the entity.
Syntax
public int getPresence(); Enumerated values: public final static int pcOffline = 0; public final static int pcChat = 1; public final static int pcAway = 2; public final static int pcXA = 3; public final static int pcDND = 4;
Default Value
1
Remarks
When the class completes the initial login, it will send information telling other entities subscribed to this entity's presence that it is online.
The Presence property has one of four values representing general information about the user's status as defined in the Jabber protocol specification:
pcOffline (0) | Invisible: JabberId is offline. |
pcChat (1) | Available: JabberId is online. |
pcAway (2) | Away: JabberId is online, but the user is away from their computer. |
pcXA (3) | Extended Away: JabberId is online, but the user is away from their computer for an extended period of time. |
pcDND (4) | Do Not Disturb: JabberId is online, but is busy and does not wish to be disturbed. |
By default, the class sets the client presence to pcChat, meaning that the user is available.
Note: Offline is not officially supported by the XMPP specification; however, some XMPP server implementations may recognize the value. Setting the client's presence state to this value may cause the server to respond with an Error.
The Status property is a pure-text string representing the user's presence information. Its value maybe be any random string, including the empty string, "".
If the application or user wishes to associate a specific status message with a new presence value, it should use the ChangePresence method. ChangePresence will update both the Presence and Status properties, and then send that information to the server.
This property is read-only and not available at design time.
Resource Property (XMPP Class)
This property is the resource for the current session.
Syntax
public String getResource(); public void setResource(String resource);
Default Value
"IPWorks XMPP Agent"
Remarks
Whenever an entity logs in to an XMPP (Jabber) server, it must provide account information as well as a resource. Resources allow multiple clients to log in using the same account. The server will forward all messages and PI data aimed at a specific resource to that resource. If a command or message is to be sent to a Jabber Id with no specified resource, the server will push that command or message out to all connected resources.
ServerDomain Property (XMPP Class)
This property includes the XMPP server's domain.
Syntax
public String getServerDomain(); public void setServerDomain(String serverDomain);
Default Value
""
Remarks
The domain of the XMPP server itself. Set this value if the domain of the server is different from the DNS name of the IMServer.
SSLAcceptServerCert Property (XMPP Class)
This property instructs the class to unconditionally accept the server certificate that matches the supplied certificate.
Syntax
public Certificate getSSLAcceptServerCert(); public void setSSLAcceptServerCert(Certificate SSLAcceptServerCert);
Remarks
If it finds any issues with the certificate presented by the server, the class will normally terminate the connection with an error.
You may override this behavior by supplying a value for SSLAcceptServerCert. If the certificate supplied in SSLAcceptServerCert is the same as the certificate presented by the server, then the server certificate is accepted unconditionally, and the connection will continue normally.
Note: This functionality is provided only for cases in which you otherwise know that you are communicating with the right server. If used improperly, this property may create a security breach. Use it at your own risk.
Please refer to the Certificate type for a complete list of fields.SSLCert Property (XMPP Class)
This property includes the certificate to be used during Secure Sockets Layer (SSL) negotiation.
Syntax
public Certificate getSSLCert(); public void setSSLCert(Certificate SSLCert);
Remarks
This property includes the digital certificate that the class will use during SSL negotiation. Set this property to a valid certificate before starting SSL negotiation. To set a certificate, you may set the Encoded field to the encoded certificate. To select a certificate, use the store and subject fields.
Please refer to the Certificate type for a complete list of fields.SSLEnabled Property (XMPP Class)
This property indicates whether Transport Layer Security/Secure Sockets Layer (TLS/SSL) is enabled.
Syntax
public boolean isSSLEnabled(); public void setSSLEnabled(boolean SSLEnabled);
Default Value
False
Remarks
This property specifies whether TLS/SSL is enabled in the class. When False (default), the class operates in plaintext mode. When True, TLS/SSL is enabled.
TLS/SSL may also be enabled by setting SSLStartMode. Setting SSLStartMode will automatically update this property value.
This property is not available at design time.
SSLProvider Property (XMPP Class)
This property specifies the Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use.
Syntax
public int getSSLProvider(); public void setSSLProvider(int SSLProvider); Enumerated values: public final static int sslpAutomatic = 0; public final static int sslpPlatform = 1; public final static int sslpInternal = 2;
Default Value
0
Remarks
This property specifies the SSL/TLS implementation to use. In most cases the default value of 0 (Automatic) is recommended and should not be changed. When set to 0 (Automatic), the class will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used.
Possible values are as follows:
0 (sslpAutomatic - default) | Automatically selects the appropriate implementation. |
1 (sslpPlatform) | Uses the platform/system implementation. |
2 (sslpInternal) | Uses the internal implementation. |
In most cases using the default value (Automatic) is recommended. The class will select a provider depending on the current platform.
When Automatic is selected, the platform implementation is used by default. When TLS 1.3 is enabled via SSLEnabledProtocols, the internal implementation is used.
SSLServerCert Property (XMPP Class)
This property includes the server certificate for the last established connection.
Syntax
public Certificate getSSLServerCert();
Remarks
SSLServerCert contains the server certificate for the last established connection.
SSLServerCert is reset every time a new connection is attempted.
This property is read-only.
Please refer to the Certificate type for a complete list of fields.SSLStartMode Property (XMPP Class)
This property determines how the class starts the Secure Sockets Layer (SSL) negotiation.
Syntax
public int getSSLStartMode(); public void setSSLStartMode(int SSLStartMode); Enumerated values: public final static int sslAutomatic = 0; public final static int sslImplicit = 1; public final static int sslExplicit = 2; public final static int sslNone = 3;
Default Value
3
Remarks
The SSLStartMode property may have one of the following values:
0 (sslAutomatic) | If the remote port is set to the standard plaintext port of the protocol (where applicable), the class will behave the same as if SSLStartMode is set to sslExplicit. In all other cases, SSL negotiation will be implicit (sslImplicit). |
1 (sslImplicit) | The SSL negotiation will start immediately after the connection is established. |
2 (sslExplicit) | The class will first connect in plaintext, and then will explicitly start SSL negotiation through a protocol command such as STARTTLS. |
3 (sslNone - default) | No SSL negotiation; no SSL security. All communication will be in plaintext mode. |
Status Property (XMPP Class)
This property holds the description of the availability of this entity.
Syntax
public String getStatus();
Default Value
"Available for Chat."
Remarks
When the class completes the initial login, it will send information telling other entities subscribed to this entity's presence that it is online.
The Presence property has one of four values representing general information about the user's status as defined in the Jabber protocol specification:
pcOffline (0) | Invisible: JabberId is offline. |
pcChat (1) | Available: JabberId is online. |
pcAway (2) | Away: JabberId is online, but the user is away from their computer. |
pcXA (3) | Extended Away: JabberId is online, but the user is away from their computer for an extended period of time. |
pcDND (4) | Do Not Disturb: JabberId is online, but is busy and does not wish to be disturbed. |
By default, the class sets the client presence to pcChat, meaning that the user is available.
Note: Offline is not officially supported by the XMPP specification; however, some XMPP server implementations may recognize the value. Setting the client's presence state to this value may cause the server to respond with an Error.
The Status property is a pure-text string representing the user's presence information. Its value maybe be any random string, including the empty string, "".
If the application or user wishes to associate a specific status message with a new presence value, it should use the ChangePresence method. ChangePresence will update both the Presence and Status properties, and then send that information to the server.
This property is read-only and not available at design time.
Timeout Property (XMPP Class)
This property includes the timeout for the class.
Syntax
public int getTimeout(); public void setTimeout(int timeout);
Default Value
60
Remarks
If the Timeout property is set to 0, all operations will run uninterrupted until successful completion or an error condition is encountered.
If Timeout is set to a positive value, the class will wait for the operation to complete before returning control.
The class will use DoEvents to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not freeze and remains responsive.
If Timeout expires, and the operation is not yet complete, the class throws an exception.
Note: By default, all timeouts are inactivity timeouts, that is, the timeout period is extended by Timeout seconds when any amount of data is successfully sent or received.
The default value for the Timeout property is 60 seconds.
User Property (XMPP Class)
This property includes the user portion of this entity's Jabber Id.
Syntax
public String getUser(); public void setUser(String user);
Default Value
""
Remarks
The User property is a unique username associated with this entity and is set at the time of registration under the field "user".
UserDomain Property (XMPP Class)
This property gets or sets the domain value used for Jabber Ids.
Syntax
public String getUserDomain(); public void setUserDomain(String userDomain);
Default Value
""
Remarks
A Jabber Id (JID) is a unique identifier of the format "User@Domain/Resource". user@domain denotes the account by username and domain. The Resource is given during the login process to distinguish individual connections under the same account. If the IMServer contains multiple domains, this property setting allows the user to specify the domain under which to log in.
If Domain is empty, the value in IMServer is used by default when creating the client's JID.
UserInfo Property (XMPP Class)
This property includes the collection of named registration fields.
Syntax
public XMPPUserInfoMap getUserInfo(); public void setUserInfo(XMPPUserInfoMap userInfo);
Remarks
Before a registration can be attempted, the application should use the QueryRegister method to poll the host to which the user wishes to register. This will gather all of the necessary fields that the user must send to the server and will populate the UserInfo collection accordingly. After a successful query, all entries in UserInfo values will be empty strings.
The possible registration fields are defined in the Jabber protocol specification, as follows:
instructions | Special instructions sent from the server. |
username | The username to be associated with this account. |
password | The initial password for this account. |
name | The user's name. |
The user's email address. | |
address | The user's physical address. |
city | The user's city of residence. |
state | The user's state (for US citizens). |
zip | The user's postal code (for US citizens). |
phone | The user's phone number. |
URL | The user's website. |
date | The date of registration. |
misc | Any miscellaneous data. |
text | Any extra text (potentially for a personal bio). |
remove | Specifies a request to unregister. |
After the user has set all of the values in UserInfo, and added any extra fields they may wish to include in their registration, the application should make a call to Register.
If the class is not already connected when this method is called, it will connect, poll the registration fields, and then disconnect.
This collection is a hash-table type of collection in which the field string is used as the key to the desired XMPP user info object.
Example. Setting New User Information:
xmpp1.queryRegister("server");
xmpp1.getUserInfo().item("Username").setValue("newuser");
xmpp1.getUserInfo().item("Password").setValue("newpass");
xmpp1.register("server");
This property is not available at design time.
Please refer to the XMPPUserInfo type for a complete list of fields.Add Method (XMPP Class)
This method will add an entity to this entity's roster.
Syntax
public void add(String jabberId, String name, String groups);
Remarks
JabberId is the Jabber Id of the entity to be added. It should be of form "user@host". If no hostname is specified, the class will assume the user's account is with the server in IMServer, and will append that hostname to JabberId before sending the request.
Name will contain the name that is to be associated with JabberId in this entity's roster. It may be the empty string, "".
Groups is either the empty string ("") or a comma- separated list of groups to which the JabberId is to be added. If JabberId already exists in the buddy list, it will be updated to exist only in the specified groups. A buddy's group list can also be modified by the Buddies property.
The Add method will make a subscription request to the presence of the specified JabberId. Upon receiving this request, the server will add an entry into this user's buddy list with a subscription of type subscriptionNone (0) if there was no previous entry (if this user has already allowed JabberId to subscribe to this user's presence, there will already be an entry of type subscriptionFrom (2)). If the contact chooses to allow the subscription, the server will update the entry and a BuddyUpdate event will fire with the new subscription value (subscriptionTo (1) if this is a new contact, or subscriptionBoth (3) if the contact is now mutual).
The XMPP protocol permits XMPP (Jabber) clients to communicate with foreign IM networks, such as AIM, MSN, SMS, and others, through the use of gateway servers that translate between the foreign protocol and XMPP. When sending or receiving presence information, messages, or subscription requests, Domain will be a gateway for the foreign network on which the contact resides and with which this user has registered an account for that foreign network. The Register method can be used to register with a foreign network gateway.
Cancel Method (XMPP Class)
This method will cancel another entity's subscription to this entity's presence.
Syntax
public void cancel(String jabberId);
Remarks
If for any reason the user should want to undo a previously granted subscription, this can be achieved through the Cancel method. The method will unsubscribe the target from this user's presence, thus preventing the target from seeing this user in the future.
ChangePassword Method (XMPP Class)
This method will change the current user's password.
Syntax
public void changePassword(String password);
Remarks
This method changes the current user's password to the password that is specified. The class must be connected to the server when this method is called.
ChangePresence Method (XMPP Class)
This method will set the availability and status of this entity.
Syntax
public void changePresence(int presenceCode, String status);
Remarks
PresenceCode should correspond to the possible values of the Presence property:
pcOffline (0) | Invisible: JabberId is offline. |
pcChat (1) | Available: JabberId is online. |
pcAway (2) | Away: JabberId is online, but the user is away from their computer. |
pcXA (3) | Extended Away: JabberId is online, but the user is away from their computer for an extended period of time. |
pcDND (4) | Do Not Disturb: JabberId is online, but is busy and does not wish to be disturbed. |
By default, the class sets the client presence to pcChat, meaning that the user is available.
Note: Offline is not officially supported by the XMPP specification; however, some XMPP server implementations may recognize the value. Setting the client's presence state to this value may cause the server to respond with an Error.
Status can be any random string, including the empty string "".
Config Method (XMPP Class)
Sets or retrieves a configuration setting.
Syntax
public String config(String configurationString);
Remarks
Config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.
These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.
To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).
To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.
Connect Method (XMPP Class)
This method will connect the class to the server.
Syntax
public void connect();
Remarks
The Connect method performs the entire connection routine. This includes connection to the IMServer, authenticating with the specified User and Password, and session initialization.
The Connected event will fire once for the initial Transmission Control Protocol (TCP) connection and again when the XMPP Logon is complete.
ConnectTo Method (XMPP Class)
This method will connect the class to the server.
Syntax
public void connectTo(String user, String password);
Remarks
The ConnectTo method performs the entire connection routine. This includes connection to the IMServer, user logon and authentication, and session initialization.
The Connected event will fire once for the initial Transmission Control Protocol (TCP) connection and again when the XMPP Logon is complete.
Because ConnectTo is called with a user and password specified, the User and Password properties will updated accordingly.
Disconnect Method (XMPP Class)
This method disconnects the class from the server.
Syntax
public void disconnect();
Remarks
The Disconnect method will send the disconnect command to the notification server. Upon disconnection, a Disconnected event will be fired.
DoEvents Method (XMPP Class)
This method processes events from the internal message queue.
Syntax
public void doEvents();
Remarks
When DoEvents is called, the class processes any available events. If no events are available, it waits for a preset period of time and then returns.
Interrupt Method (XMPP Class)
This method interrupts the current method.
Syntax
public void interrupt();
Remarks
If there is no method in progress, Interrupt simply returns, doing nothing.
ProbePresence Method (XMPP Class)
Use this method to probe for another entity's presence.
Syntax
public void probePresence(String jabberId);
Remarks
In the case that the user needs to update a particular entity's presence, this method can be used to retrieve it. After a successful call, the server will either respond with the last known presence for Jabber or will send a presence element of type "error". In either case, the respond will be returned by a Presence event.
QueryRegister Method (XMPP Class)
This method queries a server for the necessary registration fields.
Syntax
public void queryRegister(String XMPPServer);
Remarks
Before a registration can be attempted, the application should use the QueryRegister method to poll the host to which the user wishes to register. This will gather all of the necessary fields that the user must send to the server and will populate the UserInfo collection accordingly. After a successful query, all entries in UserInfo values will be empty strings.
The possible registration fields are defined in the Jabber protocol specification, as follows:
instructions | Special instructions sent from the server. |
username | The username to be associated with this account. |
password | The initial password for this account. |
name | The user's name. |
The user's email address. | |
address | The user's physical address. |
city | The user's city of residence. |
state | The user's state (for US citizens). |
zip | The user's postal code (for US citizens). |
phone | The user's phone number. |
URL | The user's website. |
date | The date of registration. |
misc | Any miscellaneous data. |
text | Any extra text (potentially for a personal bio). |
remove | Specifies a request to unregister. |
After the user has set all of the values in UserInfo, and added any extra fields they may wish to include in their registration, the application should make a call to Register.
If the class is not already connected when this method is called, it will connect, poll the registration fields, and then disconnect.
Register Method (XMPP Class)
This method registers an account with a server.
Syntax
public void register(String XMPPServer);
Remarks
Before a registration can be attempted, the application should use the QueryRegister method to poll the host to which the user wishes to register. This will gather all of the necessary fields that the user must send to the server and will populate the UserInfo collection accordingly. After a successful query, all entries in UserInfo values will be empty strings.
The possible registration fields are defined in the Jabber protocol specification, as follows:
instructions | Special instructions sent from the server. |
username | The username to be associated with this account. |
password | The initial password for this account. |
name | The user's name. |
The user's email address. | |
address | The user's physical address. |
city | The user's city of residence. |
state | The user's state (for US citizens). |
zip | The user's postal code (for US citizens). |
phone | The user's phone number. |
URL | The user's website. |
date | The date of registration. |
misc | Any miscellaneous data. |
text | Any extra text (potentially for a personal bio). |
remove | Specifies a request to unregister. |
After the user has set all of the values in UserInfo, and added any extra fields they may wish to include in their registration, the application should make a call to Register.
If the class is not already connected when this method is called, it will connect, poll the registration fields, and then disconnect.
A new account can be registered at any time, including while the class is logged into the host under an existing account.
Remove Method (XMPP Class)
This method will remove an entity from this entity's roster.
Syntax
public void remove(String jabberId, String name, String group);
Remarks
JabberId is the Jabber Id of the entity to be removed. It should be in the form of "user@host". If no hostname is specified, the class will assume the user's account is with the server in IMServer, and it will append that hostname to JabberId before sending the request.
Name should contain the name that is to be associated with JabberId in this entity's roster. It may be the empty string, "".
Groups may be either the empty string ("") or a comma- separated list of groups from which JabberId is to be removed. If no group is specified, the buddy will be completely removed from the buddy list.
After calling the Remove method, the server will remove the entry from the server-side roster and will push the result out to all connected resources. A BuddyUpdate event will fire with a subscription of type subscriptionRemove, and the entry will be removed from the Jabber class's internally stored list.
Reset Method (XMPP Class)
This method will reset the class.
Syntax
public void reset();
Remarks
This method will reset the class's properties to their default values.
RetrieveRoster Method (XMPP Class)
This method will retrieve this entity's roster from the server.
Syntax
public void retrieveRoster();
Remarks
After the class connects, it will automatically send a request to the server to retrieve the roster. If, however, the user or application wish to update the entire roster, this method may be used to do so.
After a successful call to the RetrieveRoster method, the server will respond with this entity's roster. The class will parse the roster and fire the Sync event once per item. This event may also fire for each entity added to or removed from the roster.
SendCommand Method (XMPP Class)
This method sends a command to the server.
Syntax
public void sendCommand(String command);
Remarks
The SendCommand method will send the Command parameter to the server. The command must be in valid XML format and must be recognizable to the IMServer.
The SendCommand method should be used only by programmers or users who are connecting to nonstandard servers whose command list is not covered by the class. Any responses that are defined in the protocol specification will be returned by the appropriate event. Any nonstandard IQ message will be returned by the IQ event. All other responses will be returned by the PITrail event.
SendFile Method (XMPP Class)
This method sends a file to the specified user.
Syntax
public void sendFile(String jabberId);
Remarks
This method sends the file specified by LocalFile to the user specified by the JabberId parameter.
JabberId is the intended recipient of the message. It is of the form user@domain/resource. If a resource is not supplied, all logged-in instances of the user's account will receive the message.
If SetSendStream is called, the stream will be used as the source when sending the file.
The class supports sending files using In-Band Bystestreams as defined in XEP-0047 and XEP-0096.
SendMessage Method (XMPP Class)
This method will send a message to the specified user.
Syntax
public String sendMessage(String jabberId);
Remarks
JabberId is the intended recipient of the message. It is of the form user@domain/resource. If a resource is not supplied, all logged-in instances of the user's account will receive the message.
The class associates several properties with messages it receives and sends. When it receives a message, the class will parse out the corresponding values and set these properties before firing a MessageIn event. After the event returns control to the class, the properties will be cleared (i.e., they will be set to the empty string, "").
Before sending a message, the application should set the appropriate properties to be associated with the message. The class will send only properties with nonempty string values ("") and will clear all properties after a successful send.
The associated properties are the following:
MessageType | The type of message to be sent. |
MessageSubject | For "headline" type messages, this is the subject. |
MessageThread | For "chat" type messages, this is the thread on which the current message is a follow-up. |
MessageText | The plaintext of the message. |
MessageHTML | The HTML version of the message. |
MessageOtherData | Any extra data associated with the message but not required by the protocol. |
If the parameter passed to SendMessage is prefixed with "@" the component will interpret the value as a domain when constructing the message. This allows for sending directly to subdomains.
Note: The XMPP class will generate and return a unique identifier for each message sent. This identifier can be used to track messages in conjunction with various Jabber Extension Protocols.
SetReceiveStream Method (XMPP Class)
This method sets the stream to which the received file data will be written.
Syntax
public void setReceiveStream(java.io.OutputStream receiveStream);
Remarks
This method sets the stream to which the incoming file will be written. This can be set from within the StartTransfer event when a file is received.
The file data will be written to the stream. The stream should be open and normally set to position 0. The class will automatically close this stream if CloseStreamAfterTransfer is True (default). The downloaded content will be written starting at the current position in the stream.
If a download stream is set, the incoming file will not be written to LocalDirectory.
SetSendStream Method (XMPP Class)
This method sets the stream to be sent.
Syntax
public void setSendStream(java.io.InputStream sendStream, String fileName);
Remarks
This method sets the stream to be sent to the recipient. FileName specifies the name of the file. If an upload stream is set before the SendFile method is called, the content of the stream will be read by the class and sent. The stream should be open and normally set to position 0.
The class will automatically close this stream if CloseStreamAfterTransfer is True (default). If the stream is closed, you will need to call SetSendStream again before calling SendFile again.
The content of the stream will be read from the current position all the way to the end.
Note: SetSendStream and LocalFile will reset the other.
SetUserInfoField Method (XMPP Class)
This method will add a user information field for registration.
Syntax
public void setUserInfoField(String field, String value);
Remarks
This method will search through UserInfo for the field name in Field and set the corresponding value to Value. If the field was not previously contained in UserInfo, it will automatically be added.
Before a registration can be attempted, the application should use the QueryRegister method to poll the host to which the user wishes to register. This will gather all of the necessary fields that the user must send to the server and will populate the UserInfo collection accordingly. After a successful query, all entries in UserInfo values will be empty strings.
The possible registration fields are defined in the Jabber protocol specification, as follows:
instructions | Special instructions sent from the server. |
username | The username to be associated with this account. |
password | The initial password for this account. |
name | The user's name. |
The user's email address. | |
address | The user's physical address. |
city | The user's city of residence. |
state | The user's state (for US citizens). |
zip | The user's postal code (for US citizens). |
phone | The user's phone number. |
URL | The user's website. |
date | The date of registration. |
misc | Any miscellaneous data. |
text | Any extra text (potentially for a personal bio). |
remove | Specifies a request to unregister. |
After the user has set all of the values in UserInfo, and added any extra fields they may wish to include in their registration, the application should make a call to Register.
If the class is not already connected when this method is called, it will connect, poll the registration fields, and then disconnect.
SubscribeTo Method (XMPP Class)
Use this method to subscribe to another entity's presence.
Syntax
public void subscribeTo(String jabberId);
Remarks
This method will send a request for a subscription to JabberId's presence. If the entity allows the subscription, a new item will be stored in the buddy list with the appropriate subscription type. Otherwise, no change will take place.
Unregister Method (XMPP Class)
This method cancels an account with the host.
Syntax
public void unregister();
Remarks
If the user or application wishes to terminate an account with the IMServer it should make a call to this method. After a successful call, the account will be canceled and the class will be logged off the server, but not disconnected.
UnsubscribeTo Method (XMPP Class)
This method will cancel a subscription to another entity's presence.
Syntax
public void unsubscribeTo(String jabberId);
Remarks
This method will inform the server of the cancellation of a subscription to JabberId's presence. After a successful call, the subscription type of the associated buddy list item will be updated.
UpdateBuddyGroup Method (XMPP Class)
This method updates the buddy's associated groups.
Syntax
public void updateBuddyGroup(int buddyIndex, String group);
Remarks
This method updates the associated groups for the buddy specified by BuddyIndex.
After the Sync event has fired, the Group field is populated with a comma-separated list of groups for each buddy. To update the groups for a buddy, call this method with the buddy's index and the comma-separated list of groups the buddy should be associated with. Setting Group to an empty string ("") will cause the buddy to be completely disassociated from all groups.
BuddyUpdate Event (XMPP Class)
This event is fired whenever a roster entry is updated.
Syntax
public class DefaultXMPPEventListener implements XMPPEventListener { ... public void buddyUpdate(XMPPBuddyUpdateEvent e) {} ... } public class XMPPBuddyUpdateEvent { public int buddyIdx; }
Remarks
The BuddyUpdate event will fire whenever a new buddy list entry is added or an old entry is updated. The updated information can be retrieved through the Buddies collection property. The BuddyIdx parameter of this event will be the index of that XMPPBuddy in the collection.
Connected Event (XMPP Class)
This event is fired when a connection to the IM server is completed.
Syntax
public class DefaultXMPPEventListener implements XMPPEventListener { ... public void connected(XMPPConnectedEvent e) {} ... } public class XMPPConnectedEvent { public int statusCode; public String description; }
Remarks
If the connection is made normally, StatusCode is 0, and Description is "OK".
If the connection fails, StatusCode has the error code returned by the Transmission Control Protocol (TCP)/IP stack. Description contains a description of this code. The value of StatusCode is equal to the value of the error.
Please refer to the Error Codes section for more information.
ConnectionStatus Event (XMPP Class)
This event is fired to indicate changes in the connection state.
Syntax
public class DefaultXMPPEventListener implements XMPPEventListener { ... public void connectionStatus(XMPPConnectionStatusEvent e) {} ... } public class XMPPConnectionStatusEvent { public String connectionEvent; public int statusCode; public String description; }
Remarks
The ConnectionStatus event is fired when the connection state changes: for example, completion of a firewall or proxy connection or completion of a security handshake.
The ConnectionEvent parameter indicates the type of connection event. Values may include the following:
Firewall connection complete. | |
Secure Sockets Layer (SSL) or S/Shell handshake complete (where applicable). | |
Remote host connection complete. | |
Remote host disconnected. | |
SSL or S/Shell connection broken. | |
Firewall host disconnected. |
Disconnected Event (XMPP Class)
This event is fired when the chat service connection is lost.
Syntax
public class DefaultXMPPEventListener implements XMPPEventListener { ... public void disconnected(XMPPDisconnectedEvent e) {} ... } public class XMPPDisconnectedEvent { public int statusCode; public String description; }
Remarks
If the connection is broken normally, StatusCode is 0, and Description is "OK".
If the connection is broken for any other reason, StatusCode has the error code returned by the Transmission Control Protocol (TCP)/IP subsystem. Description contains a description of this code. The value of StatusCode is equal to the value of the TCP/IP error.
Please refer to the Error Codes section for more information.
EndTransfer Event (XMPP Class)
This event is fired when a file transfer completes.
Syntax
public class DefaultXMPPEventListener implements XMPPEventListener { ... public void endTransfer(XMPPEndTransferEvent e) {} ... } public class XMPPEndTransferEvent { public int direction; public String fileId; public String fileName; public boolean success; }
Remarks
When a file transfer completes, this event will fire.
The Direction parameter shows whether the client (0) or the server (1) is sending the data.
Error Event (XMPP Class)
This event is fired when the server sends a protocol error message.
Syntax
public class DefaultXMPPEventListener implements XMPPEventListener { ... public void error(XMPPErrorEvent e) {} ... } public class XMPPErrorEvent { public int errorCode; public String description; }
Remarks
This event is fired whenever there is a protocol error. ErrorCode will contain the error code string sent by the server. Description will contain the Xmpp class's interpretation of the code.
IQ Event (XMPP Class)
This event is fired for IQ messages not normally supported by the class.
Syntax
public class DefaultXMPPEventListener implements XMPPEventListener { ... public void IQ(XMPPIQEvent e) {} ... } public class XMPPIQEvent { public String iq; public String id; public String from; public String iqType; public boolean ignore; //read-write }
Remarks
Some servers may wish to gather some data from the client in ways not specified by the XMPP RFC. This event will contain any IQ message that is not a part of the Jabber specification. The Iq parameter will contain an entire XML entity, and thus it will require both knowledge of XML and knowledge of the possible contents of the IQ message to parse. Id will contain the transaction Id of the IQ message. From will contain the sender's Jabber Id. IqType will have one of the following values:
"get" | The IQ is requesting information from this XMPP client. |
"set" | The IQ is attempting to set a value. |
"result" | The IQ is a success response to a previous IQ. |
"error" | The IQ is an error response to a previous IQ. |
Note: To respond to these IQs, you may use the SendCommand method.
MessageIn Event (XMPP Class)
This event is fired upon receipt of a message.
Syntax
public class DefaultXMPPEventListener implements XMPPEventListener { ... public void messageIn(XMPPMessageInEvent e) {} ... } public class XMPPMessageInEvent { public String messageId; public String from; public String domain; public String resource; public int messageType; public String subject; public String messageThread; public String messageText; public String messageHTML; public String other; }
Remarks
When a message is received, the XMPP class will parse the sender's Jabber Id into the From, Domain, and Resource fields. These parameters can be used to track the exact instance of a user's account that originated the message.
MessageId can be used with Jabber extension protocols. The MessageText parameter is the plaintext portion of the message body. MessageHTML will contain any HTML from the message.
Type is the type of message received. See MessageType for a list of possible values. For a message of type "headline", Subject will reflect the subject of the message. For a message of type "chat", Thread will report the conversation thread for which the current message is a follow-up.
Other will contain any extra data associated with the message but not defined by the XMPP-IM protocol.
PITrail Event (XMPP Class)
This event is fired for all protocol messages.
Syntax
public class DefaultXMPPEventListener implements XMPPEventListener { ... public void PITrail(XMPPPITrailEvent e) {} ... } public class XMPPPITrailEvent { public int direction; public String pi; }
Remarks
The PITrail event is useful for debugging purposes. It shows all the interactions between the client and the server, line by line.
SessionId will hold the session number that originated the PI. A value of 0 is reserved for all PI dealing with the IMServer.
The direction parameter shows the originator of the message:
0 (Client) | Pi originates from the client. |
1 (Server) | Pi originates from the server. |
2 (Info) | Pi is an informative message originating from within the class. |
The Pi parameter contains the PI message.
Presence Event (XMPP Class)
This event is fired when the presence of a subscribed entity changes.
Syntax
public class DefaultXMPPEventListener implements XMPPEventListener { ... public void presence(XMPPPresenceEvent e) {} ... } public class XMPPPresenceEvent { public String user; public String domain; public String resource; public int availability; public String status; }
Remarks
This event contains the availability and status information of a particular Jabber entity to whom this entity has a subscription.
Because a user can log in multiple times using the same account, the XMPP class will parse the user's Jabber Id into the User, Domain, and Resource parameters so that the client can easily track which instance of the account sent the presence.
The XMPP protocol permits XMPP (Jabber) clients to communicate with foreign IM networks, such as AIM, MSN, SMS, and others, through the use of gateway servers that translate between the foreign protocol and XMPP. When sending or receiving presence information, messages, or subscription requests, Domain will be a gateway for the foreign network on which the contact resides and with which this user has registered an account for that foreign network. The Register method can be used to register with a foreign network gateway.
Availability corresponds to the Presence property of the class, with the same possible values:
pcOffline (0) | Invisible: JabberId is offline. |
pcChat (1) | Available: JabberId is online. |
pcAway (2) | Away: JabberId is online, but the user is away from their computer. |
pcXA (3) | Extended Away: JabberId is online, but the user is away from their computer for an extended period of time. |
pcDND (4) | Do Not Disturb: JabberId is online, but is busy and does not wish to be disturbed. |
By default, the class sets the client presence to pcChat, meaning that the user is available.
Note: Offline is not officially supported by the XMPP specification; however, some XMPP server implementations may recognize the value. Setting the client's presence state to this value may cause the server to respond with an Error.
Status corresponds to the Status property. This value may be any random string, including the empty string, "".
ReadyToSend Event (XMPP Class)
This event is fired when the class is ready to send data.
Syntax
public class DefaultXMPPEventListener implements XMPPEventListener { ... public void readyToSend(XMPPReadyToSendEvent e) {} ... } public class XMPPReadyToSendEvent { }
Remarks
The ReadyToSend event indicates that the underlying Transmission Control Protocol (TCP)/IP subsystem is ready to accept data after a failed SendBytes. This event also is fired immediately after a connection to the remote host is established.
SSLServerAuthentication Event (XMPP Class)
Fired after the server presents its certificate to the client.
Syntax
public class DefaultXMPPEventListener implements XMPPEventListener { ... public void SSLServerAuthentication(XMPPSSLServerAuthenticationEvent e) {} ... } public class XMPPSSLServerAuthenticationEvent { public byte[] certEncoded; public String certSubject; public String certIssuer; public String status; public boolean accept; //read-write }
Remarks
During this event, the client can decide whether or not to continue with the connection process. The Accept parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether or not to continue.
When Accept is False, Status shows why the verification failed (otherwise, Status contains the string OK). If it is decided to continue, you can override and accept the certificate by setting the Accept parameter to True.
SSLStatus Event (XMPP Class)
Fired when secure connection progress messages are available.
Syntax
public class DefaultXMPPEventListener implements XMPPEventListener { ... public void SSLStatus(XMPPSSLStatusEvent e) {} ... } public class XMPPSSLStatusEvent { public String message; }
Remarks
The event is fired for informational and logging purposes only. This event tracks the progress of the connection.
StartTransfer Event (XMPP Class)
This event is fired when a file transfer begins.
Syntax
public class DefaultXMPPEventListener implements XMPPEventListener { ... public void startTransfer(XMPPStartTransferEvent e) {} ... } public class XMPPStartTransferEvent { public int direction; public String fileId; public String user; public String domain; public String resource; public String fileName; //read-write public String datetime; public long size; public boolean accept; //read-write }
Remarks
When a file is received, the XMPP component will parse the sender's Jabber Id into the User, Domain, and Resource fields. The FileId and FileName parameters identify the current transfer. Within this event, you may override the FileName by setting the FileName parameter. At this time, you may also set LocalDirectory if it is not already set or call SetReceiveStream.
When sending a file, the XMPP component will parse the receiver's Jabber Id into the User, Domain, and Resource fields.
The Direction parameter shows whether the client (0) or the server (1) is sending the data.
SubscriptionRequest Event (XMPP Class)
This event fires when a subscription request is received.
Syntax
public class DefaultXMPPEventListener implements XMPPEventListener { ... public void subscriptionRequest(XMPPSubscriptionRequestEvent e) {} ... } public class XMPPSubscriptionRequestEvent { public String from; public String domain; public boolean accept; //read-write }
Remarks
This event fires whenever another XMPP entity requests a subscription to this entity's presence. The XMPP class will parse the requesting entity's Jabber Id into the From and Domain parameters. It is not necessary to know which resource sent the request, because all instances of the requesting entity's account have access to the same roster.
Accept will initially be False, but setting it to True will cause the XMPP class to allow the remote subscription. Otherwise, the XMPP class will actively deny the subscription request.
Sync Event (XMPP Class)
This event fires upon a complete information synchronization with the server.
Syntax
public class DefaultXMPPEventListener implements XMPPEventListener { ... public void sync(XMPPSyncEvent e) {} ... } public class XMPPSyncEvent { }
Remarks
The Sync event will fire after each successful call to the RetrieveRoster method. When the event fires, the buddy list, or roster, will be completely retrieved and the Buddies collection will be filled out accordingly:
Id | The Jabber Ids associated with the buddies. |
Group | The group associated with each entry (if a buddy is in more than one group, they will have multiple entries in the buddy list). |
Subscription | The subscription type for each buddy. |
Note: Please refer to Buddies collection property for more information.
Transfer Event (XMPP Class)
This event is fired during file transfer.
Syntax
public class DefaultXMPPEventListener implements XMPPEventListener { ... public void transfer(XMPPTransferEvent e) {} ... } public class XMPPTransferEvent { public int direction; public String fileId; public String fileName; public long bytesTransferred; public int percentDone; public byte[] text; public boolean cancel; //read-write }
Remarks
This event will fire when sending or receiving. One or more Transfer events are fired during file transfer.
The BytesTransferred parameter shows the number of bytes transferred since the beginning of the transfer.
Text contains the portion of the file data being delivered.
The Direction parameter shows whether the client (0) or the server (1) is sending the data.
The PercentDone parameter shows the progress of the transfer in the corresponding direction. If PercentDone cannot be calculated, the value will be -1.
The Direction parameter shows whether the client (0) or the server (1) is sending the data.
The PercentDone parameter shows the progress of the transfer in the corresponding direction. If PercentDone can not be calculated the value will be -1.
Note: Events are not re-entrant. Performing time-consuming operations within this event will prevent it from firing again in a timely manner and may affect overall performance.
Certificate Type
This is the digital certificate being used.
Remarks
This type describes the current digital certificate. The certificate may be a public or private key. The fields are used to identify or select certificates.
Fields
EffectiveDate
String (read-only)
Default Value: ""
This is the date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:
23-Jan-2000 15:00:00.
ExpirationDate
String (read-only)
Default Value: ""
This is the date the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:
23-Jan-2001 15:00:00.
ExtendedKeyUsage
String (read-only)
Default Value: ""
This is a comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).
Fingerprint
String (read-only)
Default Value: ""
This is the hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02
FingerprintSHA1
String (read-only)
Default Value: ""
This is the hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84
FingerprintSHA256
String (read-only)
Default Value: ""
This is the hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53
Issuer
String (read-only)
Default Value: ""
This is the issuer of the certificate. This field contains a string representation of the name of the issuing authority for the certificate.
KeyPassword
String
Default Value: ""
This is the password for the certificate's private key (if any).
Some certificate stores may individually protect certificates' private keys, separate from the standard protection offered by the StorePassword. KeyPassword. This field can be used to read such password-protected private keys.
Note: this property defaults to the value of StorePassword. To clear it, you must set the property to the empty string (""). It can be set at any time, but when the private key's password is different from the store's password, then it must be set before calling PrivateKey.
PrivateKey
String (read-only)
Default Value: ""
This is the private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.
Note: The PrivateKey may be available but not exportable. In this case, PrivateKey returns an empty string.
PrivateKeyAvailable
boolean (read-only)
Default Value: False
This field shows whether a PrivateKey is available for the selected certificate. If PrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).
PrivateKeyContainer
String (read-only)
Default Value: ""
This is the name of the PrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.
PublicKey
String (read-only)
Default Value: ""
This is the public key of the certificate. The key is provided as PEM/Base64-encoded data.
PublicKeyAlgorithm
String (read-only)
Default Value: ""
This field contains the textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.
PublicKeyLength
int (read-only)
Default Value: 0
This is the length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.
SerialNumber
String (read-only)
Default Value: ""
This is the serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.
SignatureAlgorithm
String (read-only)
Default Value: ""
The field contains the text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.
Store
String
Default Value: "MY"
This is the name of the certificate store for the client certificate.
The StoreType field denotes the type of the certificate store specified by Store. If the store is password protected, specify the password in StorePassword.
Store is used in conjunction with the Subject field to specify client certificates. If Store has a value, and Subject or Encoded is set, a search for a certificate is initiated. Please see the Subject field for details.
Designations of certificate stores are platform dependent.
The following designations are the most common User and Machine certificate stores in Windows:
MY | A certificate store holding personal certificates with their associated private keys. |
CA | Certifying authority certificates. |
ROOT | Root certificates. |
In Java, the certificate store normally is a file containing certificates and optional private keys.
When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).
StoreB
byte[]
Default Value: "MY"
This is the name of the certificate store for the client certificate.
The StoreType field denotes the type of the certificate store specified by Store. If the store is password protected, specify the password in StorePassword.
Store is used in conjunction with the Subject field to specify client certificates. If Store has a value, and Subject or Encoded is set, a search for a certificate is initiated. Please see the Subject field for details.
Designations of certificate stores are platform dependent.
The following designations are the most common User and Machine certificate stores in Windows:
MY | A certificate store holding personal certificates with their associated private keys. |
CA | Certifying authority certificates. |
ROOT | Root certificates. |
In Java, the certificate store normally is a file containing certificates and optional private keys.
When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).
StorePassword
String
Default Value: ""
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
StoreType
int
Default Value: 0
This is the type of certificate store for this certificate.
The class supports both public and private keys in a variety of formats. When the cstAuto value is used, the class will automatically determine the type. This field can take one of the following values:
0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user.
Note: This store type is not available in Java. |
1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store.
Note: This store type is not available in Java. |
2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. |
3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. |
4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates.
Note: This store type is only available in Java. |
5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format.
Note: this store type is only available in Java. |
6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. |
8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. |
9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. |
10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. |
11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. |
12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. |
13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. |
14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). |
15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). |
16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. |
17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. |
18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). |
19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). |
21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store).
Note: This store type is only available in Java and .NET. |
22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format.
Note: This store type is only available in Java and .NET. |
23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface.
To use a security key, the necessary data must first be collected using the CertMgr class. The ListStoreCertificates method may be called after setting CertStoreType to cstPKCS11, CertStorePassword to the PIN, and CertStore to the full path of the PKCS#11 DLL. The certificate information returned in the CertList event's CertEncoded parameter may be saved for later use. When using a certificate, pass the previously saved security key information as the Store and set StorePassword to the PIN. Code Example. SSH Authentication with Security Key:
|
99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. |
SubjectAltNames
String (read-only)
Default Value: ""
This field contains comma-separated lists of alternative subject names for the certificate.
ThumbprintMD5
String (read-only)
Default Value: ""
This field contains the MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
ThumbprintSHA1
String (read-only)
Default Value: ""
This field contains the SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
ThumbprintSHA256
String (read-only)
Default Value: ""
This field contains the SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
Usage
String (read-only)
Default Value: ""
This field contains the text description of UsageFlags.
This value will be of one or more of the following strings and will be separated by commas:
- Digital Signature
- Non-Repudiation
- Key Encipherment
- Data Encipherment
- Key Agreement
- Certificate Signing
- CRL Signing
- Encipher Only
If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.
UsageFlags
int (read-only)
Default Value: 0
This field contains the flags that show intended use for the certificate. The value of UsageFlags is a combination of the following flags:
0x80 | Digital Signature |
0x40 | Non-Repudiation |
0x20 | Key Encipherment |
0x10 | Data Encipherment |
0x08 | Key Agreement |
0x04 | Certificate Signing |
0x02 | CRL Signing |
0x01 | Encipher Only |
Please see the Usage field for a text representation of UsageFlags.
This functionality currently is not available when the provider is OpenSSL.
Version
String (read-only)
Default Value: ""
This field contains the certificate's version number. The possible values are the strings "V1", "V2", and "V3".
Subject
String
Default Value: ""
This is the subject of the certificate used for client authentication.
This field will be populated with the full subject of the loaded certificate. When loading a certificate, the subject is used to locate the certificate in the store.
If an exact match is not found, the store is searched for subjects containing the value of the property.
If a match is still not found, the property is set to an empty string, and no certificate is selected.
The special value "*" picks a random certificate in the certificate store.
The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:
Field | Meaning |
CN | Common Name. This is commonly a hostname like www.server.com. |
O | Organization |
OU | Organizational Unit |
L | Locality |
S | State |
C | Country |
E | Email Address |
If a field value contains a comma, it must be quoted.
Encoded
String
Default Value: ""
This is the certificate (PEM/Base64 encoded). This field is used to assign a specific certificate. The Store and Subject fields also may be used to specify a certificate.
When Encoded is set, a search is initiated in the current Store for the private key of the certificate. If the key is found, Subject is updated to reflect the full subject of the selected certificate; otherwise, Subject is set to an empty string.
EncodedB
byte[]
Default Value: ""
This is the certificate (PEM/Base64 encoded). This field is used to assign a specific certificate. The Store and Subject fields also may be used to specify a certificate.
When Encoded is set, a search is initiated in the current Store for the private key of the certificate. If the key is found, Subject is updated to reflect the full subject of the selected certificate; otherwise, Subject is set to an empty string.
Constructors
public Certificate();
Creates a Certificate instance whose properties can be set. This is useful for use with CERTMGR when generating new certificates.
public Certificate( certificateFile);
Opens CertificateFile and reads out the contents as an X.509 public key.
public Certificate( encoded);
Parses Encoded as an X.509 public key.
public Certificate( storeType, store, storePassword, subject);
CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store. After the store has been successfully opened, the class will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The Subject parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format.
public Certificate( storeType, store, storePassword, subject, configurationString);
CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store. ConfigurationString is a newline separated list of name-value pairs that may be used to modify the default behavior. Possible values include "PersistPFXKey", which shows whether or not the PFX key is persisted after performing operations with the private key. This correlates to the PKCS12_NO_PERSIST_KEY CryptoAPI option. The default value is True (the key is persisted). "Thumbprint" - an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load. When specified, this value is used to select the certificate in the store. This is applicable to cstUser, cstMachine, cstPublicKeyFile, and cstPFXFile store types. "UseInternalSecurityAPI" shows whether the platform (default) or the internal security API is used when performing certificate-related operations. After the store has been successfully opened, the class will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The Subject parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format.
public Certificate( storeType, store, storePassword, encoded);
CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store. After the store has been successfully opened, the class will load Encoded as an X.509 certificate and search the opened store for a corresponding private key.
public Certificate( storeType, store, storePassword, subject);
CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a string (binary- or Base64-encoded) containing the certificate data. StorePassword is the password used to protect the store. After the store has been successfully opened, the class will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The Subject parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format.
public Certificate( storeType, store, storePassword, subject, configurationString);
CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a string (binary- or Base64-encoded) containing the certificate data. StorePassword is the password used to protect the store. After the store has been successfully opened, the class will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The Subject parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format.
public Certificate( storeType, store, storePassword, encoded);
CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a string (binary- or Base64-encoded) containing the certificate store. StorePassword is the password used to protect the store. After the store has been successfully opened, the class will load Encoded as an X.509 certificate and search the opened store for a corresponding private key.
Firewall Type
The firewall the class will connect through.
Remarks
When connecting through a firewall, this type is used to specify different properties of the firewall, such as the firewall Host and the FirewallType.
Fields
AutoDetect
boolean
Default Value: False
This field tells the class whether or not to automatically detect and use firewall system settings, if available.
Connection information will first be obtained from Java system properties, such as http.proxyHost and https.proxyHost. Java properties may be set in a variety of ways; please consult the Java documentation for information about how firewall and proxy values can be specified.
If no Java system properties define connection information, the class will inspect the Windows registry for connection information that may be present on the system (applicable only on Windows systems).
FirewallType
int
Default Value: 0
This field determines the type of firewall to connect through. The applicable values are as follows:
fwNone (0) | No firewall (default setting). |
fwTunnel (1) | Connect through a tunneling proxy. Port is set to 80. |
fwSOCKS4 (2) | Connect through a SOCKS4 Proxy. Port is set to 1080. |
fwSOCKS5 (3) | Connect through a SOCKS5 Proxy. Port is set to 1080. |
fwSOCKS4A (10) | Connect through a SOCKS4A Proxy. Port is set to 1080. |
Host
String
Default Value: ""
This field contains the name or IP address of the firewall (optional). If a Host is given, the requested connections will be authenticated through the specified firewall when connecting.
If this field is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, this field is set to the corresponding address. If the search is not successful, the class throws an exception.
Password
String
Default Value: ""
This field contains a password if authentication is to be used when connecting through the firewall. If Host is specified, the User and Password fields are used to connect and authenticate to the given firewall. If the authentication fails, the class throws an exception.
Port
int
Default Value: 0
This field contains the Transmission Control Protocol (TCP) port for the firewall Host. See the description of the Host field for details.
Note: This field is set automatically when FirewallType is set to a valid value. See the description of the FirewallType field for details.
User
String
Default Value: ""
This field contains a username if authentication is to be used when connecting through a firewall. If Host is specified, this field and the Password field are used to connect and authenticate to the given Firewall. If the authentication fails, the class throws an exception.
Constructors
public Firewall();
XMPPBuddy Type
This type describes a buddy in the XMPP buddy list.
Remarks
This type describes a buddy in the user's buddy list. Each buddy in the list has certain properties associated with it, such as names and Id.
Fields
Group
String (read-only)
Default Value: ""
This field holds a comma-separated list of the buddy's associated groups.
After the Sync event has fired, this field will contain a comma-separated list of groups for the associated Id. Call the UpdateBuddyGroup method to update the buddy's group associations.
Id
String (read-only)
Default Value: ""
This field is the jabber Id of the buddy.
After a Sync event is fired, this field will contain the user Id associated with the corresponding entry in the buddy list. If a buddy has multiple entries (e.g., if the buddy is listed in several groups), more than one entry will be the same.
NickName
String
Default Value: ""
This field includes the nickname of the buddy, if one exists.
RealName
String (read-only)
Default Value: ""
This field includes the real name of the buddy.
Subscription
int (read-only)
Default Value: 0
This field includes a list of the buddy's subscription status types.
After a Sync event is fired, this property will contain all of the types of subscriptions for the buddy. They are defined as follows:
stNone (0) | no subscription |
stTo (1) | the buddy has a subscription to this entity |
stFrom (2) | this entity has a subscription to the buddy |
stBoth (3) | subscription is both to and from |
stRemove (4) | the item is to be removed from the list |
Constructors
public XMPPBuddy();
XMPPUserInfo Type
This type describes a named registration field.
Remarks
This type describes the user information that must be sent to the server during registration.
Fields
Field
String
Default Value: ""
This field includes the name of the current field necessary for registration.
Before a registration can be attempted, the application should use the QueryRegister method to poll the host to which the user wishes to register. This will gather all of the necessary fields that the user must send to the server and will populate the UserInfo collection accordingly. After a successful query, all entries in UserInfo values will be empty strings.
The possible registration fields are defined in the Jabber protocol specification, as follows:
instructions | Special instructions sent from the server. |
username | The username to be associated with this account. |
password | The initial password for this account. |
name | The user's name. |
The user's email address. | |
address | The user's physical address. |
city | The user's city of residence. |
state | The user's state (for US citizens). |
zip | The user's postal code (for US citizens). |
phone | The user's phone number. |
URL | The user's website. |
date | The date of registration. |
misc | Any miscellaneous data. |
text | Any extra text (potentially for a personal bio). |
remove | Specifies a request to unregister. |
After the user has set all of the values in UserInfo, and added any extra fields they may wish to include in their registration, the application should make a call to Register.
If the class is not already connected when this method is called, it will connect, poll the registration fields, and then disconnect.
Value
String
Default Value: ""
This field includes the value of the current registration field. It should be set after calling QueryRegister and before calling Register.
Before a registration can be attempted, the application should use the QueryRegister method to poll the host to which the user wishes to register. This will gather all of the necessary fields that the user must send to the server and will populate the UserInfo collection accordingly. After a successful query, all entries in UserInfo values will be empty strings.
The possible registration fields are defined in the Jabber protocol specification, as follows:
instructions | Special instructions sent from the server. |
username | The username to be associated with this account. |
password | The initial password for this account. |
name | The user's name. |
The user's email address. | |
address | The user's physical address. |
city | The user's city of residence. |
state | The user's state (for US citizens). |
zip | The user's postal code (for US citizens). |
phone | The user's phone number. |
URL | The user's website. |
date | The date of registration. |
misc | Any miscellaneous data. |
text | Any extra text (potentially for a personal bio). |
remove | Specifies a request to unregister. |
After the user has set all of the values in UserInfo, and added any extra fields they may wish to include in their registration, the application should make a call to Register.
If the class is not already connected when this method is called, it will connect, poll the registration fields, and then disconnect.
Constructors
public XMPPUserInfo();
public XMPPUserInfo( field, value);
Config Settings (XMPP Class)
The class accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.XMPP Config Settings
TCPClient Config Settings
If the FirewallHost setting is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, the FirewallHost setting is set to the corresponding address. If the search is not successful, an error is returned.
Note: This setting is provided for use by classs that do not directly expose Firewall properties.
If this entry is set, the class acts as a server. RemoteHost and RemotePort are used to tell the SOCKS firewall in which address and port to listen to. The firewall rules may ignore RemoteHost, and it is recommended that RemoteHost be set to empty string in this case.
RemotePort is the port in which the firewall will listen to. If set to 0, the firewall will select a random port. The binding (address and port) is provided through the ConnectionStatus event.
The connection to the firewall is made by calling the Connect method.
Note: This setting is provided for use by classs that do not directly expose Firewall properties.
Note: This configuration setting is provided for use by classs that do not directly expose Firewall properties.
0 | No firewall (default setting). |
1 | Connect through a tunneling proxy. FirewallPort is set to 80. |
2 | Connect through a SOCKS4 Proxy. FirewallPort is set to 1080. |
3 | Connect through a SOCKS5 Proxy. FirewallPort is set to 1080. |
10 | Connect through a SOCKS4A Proxy. FirewallPort is set to 1080. |
Note: This setting is provided for use by classs that do not directly expose Firewall properties.
Note: This setting is provided for use by classs that do not directly expose Firewall properties.
Note: This value is not applicable in macOS.
In the case that Linger is True (default), two scenarios determine how long the connection will linger. In the first, if LingerTime is 0 (default), the system will attempt to send pending data for a connection until the default IP timeout expires.
In the second scenario, if LingerTime is a positive value, the system will attempt to send pending data until the specified LingerTime is reached. If this attempt fails, then the system will reset the connection.
The default behavior (which is also the default mode for stream sockets) might result in a long delay in closing the connection. Although the class returns control immediately, the system could hold system resources until all pending data are sent (even after your application closes).
Setting this property to False forces an immediate disconnection. If you know that the other side has received all the data you sent (e.g., by a client acknowledgment), setting this property to False might be the appropriate course of action.
In multihomed hosts (machines with more than one IP interface), setting LocalHost to the value of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface.
If the class is connected, the LocalHost setting shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multihomed hosts (machines with more than one IP interface).
Setting this to 0 (default) enables the system to choose a port at random. The chosen port will be shown by LocalPort after the connection is established.
LocalPort cannot be changed once a connection is made. Any attempt to set this when a connection is active will generate an error.
This configuration setting is useful when trying to connect to services that require a trusted port on the client side. An example is the remote shell (rsh) service in UNIX systems.
If an EOL string is found in the input stream before MaxLineLength bytes are received, the DataIn event is fired with the EOL parameter set to True, and the buffer is reset.
If no EOL is found, and MaxLineLength bytes are accumulated in the buffer, the DataIn event is fired with the EOL parameter set to False, and the buffer is reset.
The minimum value for MaxLineLength is 256 bytes. The default value is 2048 bytes.
www.google.com;www.nsoftware.com
Note: This value is not applicable in Java.
By default, this configuration setting is set to False.
0 | IPv4 only |
1 | IPv6 only |
2 | IPv6 with IPv4 fallback |
SSL Config Settings
When enabled, SSL packet logs are output using the SSLStatus event, which will fire each time an SSL packet is sent or received.
Enabling this configuration setting has no effect if SSLProvider is set to Platform.
If set to True, the class will reuse the context if and only if the following criteria are met:
- The target host name is the same.
- The system cache entry has not expired (default timeout is 10 hours).
- The application process that calls the function is the same.
- The logon session is the same.
- The instance of the class is the same.
-----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... Intermedaite Cert ... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp ... Root Cert ... d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE-----
When set to 0 (default), the CRL check will not be performed by the class. When set to 1, it will attempt to perform the CRL check, but it will continue without an error if the server's certificate does not support CRL. When set to 2, it will perform the CRL check and will throw an error if CRL is not supported.
This configuration setting is supported only in the Java, C#, and C++ editions. In the C++ edition, it is supported only on Windows operating systems.
When set to 0 (default), the class will not perform an OCSP check. When set to 1, it will attempt to perform the OCSP check, but it will continue without an error if the server's certificate does not support OCSP. When set to 2, it will perform the OCSP check and will throw an error if OCSP is not supported.
This configuration setting is supported only in the Java, C#, and C++ editions. In the C++ edition, it is supported only on Windows operating systems.
Note: This configuration setting contains the minimum cipher strength requested from the security library. The actual cipher strength used for the connection is shown by the SSLStatus event.
Use this configuration setting with caution. Requesting a lower cipher strength than necessary could potentially cause serious security vulnerabilities in your application.
When the provider is OpenSSL, SSLCipherStrength is currently not supported. This functionality is instead made available through the OpenSSLCipherList configuration setting.
The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance:
-----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... Intermediate Cert ... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp ... Root Cert ... d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE-----
By default, the enabled cipher suites will include all available ciphers ("*").
The special value "*" means that the class will pick all of the supported cipher suites. If SSLEnabledCipherSuites is set to any other value, only the specified cipher suites will be considered.
Multiple cipher suites are separated by semicolons.
Note: This value must be set after SSLProvider is set.
Example values:
obj.config("SSLEnabledCipherSuites=*");
obj.config("SSLEnabledCipherSuites=SSL_RSA_WITH_RC4_128_SHA");
obj.config("SSLEnabledCipherSuites=SSL_RSA_WITH_RC4_128_SHA; SSL_DHE_RSA_WITH_3DES_EDE_CBC_SHA");
Possible values when SSLProvider is set to Platform include the following:
- SSL_DHE_RSA_EXPORT_WITH_DES40_CBC_SHA
- SSL_DHE_RSA_WITH_3DES_EDE_CBC_SHA
- SSL_RSA_WITH_RC4_128_SHA
- SSL_RSA_WITH_DES_CBC_SHA
- SSL_RSA_EXPORT_WITH_DES40_CBC_SHA
- SSL_DH_anon_WITH_DES_CBC_SHA
- SSL_RSA_EXPORT_WITH_RC4_40_MD5
- SSL_DHE_DSS_EXPORT_WITH_DES40_CBC_SHA
- SSL_DH_anon_EXPORT_WITH_RC4_40_MD5
- SSL_DHE_DSS_WITH_DES_CBC_SHA
- SSL_RSA_WITH_NULL_MD5
- SSL_DH_anon_WITH_3DES_EDE_CBC_SHA
- SSL_DHE_RSA_WITH_DES_CBC_SHA
- SSL_DH_anon_EXPORT_WITH_DES40_CBC_SHA
- SSL_RSA_WITH_NULL_SHA
- SSL_DH_anon_WITH_RC4_128_MD5
- SSL_RSA_WITH_RC4_128_MD5
- SSL_DHE_DSS_WITH_3DES_EDE_CBC_SHA
- SSL_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_ECDH_ECDSA_WITH_NULL_SHA
- TLS_DH_anon_WITH_AES_128_CBC_SHA256 (Not Recommended)
- TLS_ECDH_anon_WITH_RC4_128_SHA
- TLS_DH_anon_WITH_AES_128_CBC_SHA (Not Recommended)
- TLS_DHE_RSA_WITH_AES_128_CBC_SHA
- TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
- TLS_KRB5_WITH_3DES_EDE_CBC_SHA
- TLS_DHE_DSS_WITH_AES_128_CBC_SHA256
- TLS_ECDH_ECDSA_WITH_3DES_EDE_CBC_SHA
- TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
- TLS_KRB5_EXPORT_WITH_RC4_40_SHA
- TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
- TLS_ECDHE_RSA_WITH_RC4_128_SHA
- TLS_ECDH_ECDSA_WITH_RC4_128_SHA
- TLS_ECDH_anon_WITH_NULL_SHA
- TLS_ECDHE_ECDSA_WITH_RC4_128_SHA
- TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
- TLS_RSA_WITH_NULL_SHA256
- TLS_ECDH_anon_WITH_3DES_EDE_CBC_SHA
- TLS_KRB5_WITH_RC4_128_MD5
- TLS_ECDHE_ECDSA_WITH_NULL_SHA
- TLS_ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA
- TLS_ECDH_RSA_WITH_RC4_128_SHA
- TLS_EMPTY_RENEGOTIATION_INFO_SCSV
- TLS_KRB5_WITH_3DES_EDE_CBC_MD5
- TLS_KRB5_WITH_RC4_128_SHA
- TLS_ECDH_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_ECDH_RSA_WITH_NULL_SHA
- TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
- TLS_KRB5_WITH_DES_CBC_MD5
- TLS_KRB5_EXPORT_WITH_RC4_40_MD5
- TLS_KRB5_EXPORT_WITH_DES_CBC_40_MD5
- TLS_ECDH_anon_WITH_AES_128_CBC_SHA
- TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
- TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
- TLS_KRB5_WITH_DES_CBC_SHA
- TLS_RSA_WITH_AES_128_CBC_SHA
- TLS_KRB5_EXPORT_WITH_DES_CBC_40_SHA
- TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
- TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
- TLS_ECDHE_RSA_WITH_NULL_SHA
- TLS_RSA_WITH_AES_128_CBC_SHA256
- TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_DHE_DSS_WITH_AES_128_CBC_SHA
Possible values when SSLProvider is set to Internal include the following:
- TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
- TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
- TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
- TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
- TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
- TLS_RSA_WITH_AES_256_GCM_SHA384
- TLS_RSA_WITH_AES_128_GCM_SHA256
- TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
- TLS_DHE_DSS_WITH_AES_256_GCM_SHA384
- TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
- TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
- TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
- TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
- TLS_DHE_DSS_WITH_AES_128_GCM_SHA256
- TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
- TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
- TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
- TLS_DHE_DSS_WITH_AES_256_CBC_SHA256
- TLS_RSA_WITH_AES_256_CBC_SHA256
- TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
- TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
- TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
- TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
- TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
- TLS_RSA_WITH_AES_128_CBC_SHA256
- TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
- TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
- TLS_DHE_DSS_WITH_AES_128_CBC_SHA256
- TLS_RSA_WITH_AES_256_CBC_SHA
- TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
- TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
- TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
- TLS_DHE_RSA_WITH_AES_256_CBC_SHA
- TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
- TLS_DHE_DSS_WITH_AES_256_CBC_SHA
- TLS_RSA_WITH_AES_128_CBC_SHA
- TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
- TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
- TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
- TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
- TLS_DHE_RSA_WITH_AES_128_CBC_SHA
- TLS_DHE_DSS_WITH_AES_128_CBC_SHA
- TLS_ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA
- TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_ECDH_ECDSA_WITH_3DES_EDE_CBC_SHA
- TLS_ECDH_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_DHE_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA
- TLS_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_RSA_WITH_DES_CBC_SHA
- TLS_DHE_RSA_WITH_DES_CBC_SHA
- TLS_DHE_DSS_WITH_DES_CBC_SHA
- TLS_RSA_WITH_RC4_128_MD5
- TLS_RSA_WITH_RC4_128_SHA
When TLS 1.3 is negotiated (see SSLEnabledProtocols), only the following cipher suites are supported:
- TLS_AES_256_GCM_SHA384
- TLS_CHACHA20_POLY1305_SHA256
- TLS_AES_128_GCM_SHA256
SSLEnabledCipherSuites is used together with SSLCipherStrength.
Not all supported protocols are enabled by default. The default value is 4032 for client components, and 3072 for server components. To specify a combination of enabled protocol versions set this config to the binary OR of one or more of the following values:
TLS1.3 | 12288 (Hex 3000) |
TLS1.2 | 3072 (Hex C00) (Default - Client and Server) |
TLS1.1 | 768 (Hex 300) (Default - Client) |
TLS1 | 192 (Hex C0) (Default - Client) |
SSL3 | 48 (Hex 30) |
SSL2 | 12 (Hex 0C) |
Note that only TLS 1.2 is enabled for server components that accept incoming connections. This adheres to industry standards to ensure a secure connection. Client components enable TLS 1.0, TLS 1.1, and TLS 1.2 by default and will negotiate the highest mutually supported version when connecting to a server, which should be TLS 1.2 in most cases.
SSLEnabledProtocols: Transport Layer Security (TLS) 1.3 Notes:
By default when TLS 1.3 is enabled, the class will use the internal TLS implementation when the SSLProvider is set to Automatic for all editions.
In editions that are designed to run on Windows, SSLProvider can be set to Platform to use the platform implementation instead of the internal implementation. When configured in this manner, please note that the platform provider is supported only on Windows 11/Windows Server 2022 and up. The default internal provider is available on all platforms and is not restricted to any specific OS version.
If set to 1 (Platform provider), please be aware of the following notes:
- The platform provider is available only on Windows 11/Windows Server 2022 and up.
- SSLEnabledCipherSuites and other similar SSL configuration settings are not supported.
- If SSLEnabledProtocols includes both TLS 1.3 and TLS 1.2, these restrictions are still applicable even if TLS 1.2 is negotiated. Enabling TLS 1.3 with the platform provider changes the implementation used for all TLS versions.
SSLEnabledProtocols: SSL2 and SSL3 Notes:
SSL 2.0 and 3.0 are not supported by the class when the SSLProvider is set to internal. To use SSL 2.0 or SSL 3.0, the platform security API must have the protocols enabled and SSLProvider needs to be set to platform.
This configuration setting is applicable only when SSLProvider is set to Internal.
If set to True, all certificates returned by the server will be present in the Encoded parameter of the SSLServerAuthentication event. This includes the leaf certificate, any intermediate certificate, and the root certificate.
Note: When SSLProvider is set to Internal this value is automatically set to true. This is needed for proper validation when using the internal provider.
When set, the class will save the session secrets in the same format as the SSLKEYLOGFILE environment variable functionality used by most major browsers and tools, such as Chrome, Firefox, and cURL. This file can then be used in tools such as Wireshark to decrypt TLS traffic for debugging purposes. When writing to this file, the class will only append, it will not overwrite previous values.
Note: This configuration setting is applicable only when SSLProvider is set to Internal.
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedCipher[connId]");
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedCipherStrength[connId]");
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedCipherSuite[connId]");
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedKeyExchange[connId]");
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedKeyExchangeStrength[connId]");
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedVersion[connId]");
The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance:
-----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... Intermediate Cert... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp ... Root Cert... d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE-----
When specified the class will verify that the server certificate signature algorithm is among the values specified in this configuration setting. If the server certificate signature algorithm is unsupported, the class throws an exception.
The format of this value is a comma-separated list of hash-signature combinations. For instance:
component.SSLProvider = TCPClientSSLProviders.sslpInternal;
component.Config("SSLEnabledProtocols=3072"); //TLS 1.2
component.Config("TLS12SignatureAlgorithms=sha256-rsa,sha256-dsa,sha1-rsa,sha1-dsa");
The default value for this configuration setting is sha512-ecdsa,sha512-rsa,sha512-dsa,sha384-ecdsa,sha384-rsa,sha384-dsa,sha256-ecdsa,sha256-rsa,sha256-dsa,sha224-ecdsa,sha224-rsa,sha224-dsa,sha1-ecdsa,sha1-rsa,sha1-dsa.
To not restrict the server's certificate signature algorithm, specify an empty string as the value for this configuration setting, which will cause the signature_algorithms TLS 1.2 extension to not be sent.
The default value is ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1.
When using TLS 1.2 and SSLProvider is set to Internal, the values refer to the supported groups for ECC. The following values are supported:
- "ecdhe_secp256r1" (default)
- "ecdhe_secp384r1" (default)
- "ecdhe_secp521r1" (default)
The default value is set to balance common supported groups and the computational resources required to generate key shares. As a result, only some groups are included by default in this configuration setting.
Note: All supported groups can always be used during the handshake even if not listed here, but if a group is used that is not present in this list, it will incur an additional roundtrip and time to generate the key share for that group.
In most cases, this configuration setting does not need to be modified. This should be modified only if there is a specific reason to do so.
The default value is ecdhe_x25519,ecdhe_secp256r1,ecdhe_secp384r1,ffdhe_2048,ffdhe_3072
The values are ordered from most preferred to least preferred. The following values are supported:
- "ecdhe_x25519" (default)
- "ecdhe_x448"
- "ecdhe_secp256r1" (default)
- "ecdhe_secp384r1" (default)
- "ecdhe_secp521r1"
- "ffdhe_2048" (default)
- "ffdhe_3072" (default)
- "ffdhe_4096"
- "ffdhe_6144"
- "ffdhe_8192"
- "ed25519" (default)
- "ed448" (default)
- "ecdsa_secp256r1_sha256" (default)
- "ecdsa_secp384r1_sha384" (default)
- "ecdsa_secp521r1_sha512" (default)
- "rsa_pkcs1_sha256" (default)
- "rsa_pkcs1_sha384" (default)
- "rsa_pkcs1_sha512" (default)
- "rsa_pss_sha256" (default)
- "rsa_pss_sha384" (default)
- "rsa_pss_sha512" (default)
The default value is ecdhe_x25519,ecdhe_x448,ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1,ffdhe_2048,ffdhe_3072,ffdhe_4096,ffdhe_6144,ffdhe_8192
The values are ordered from most preferred to least preferred. The following values are supported:
- "ecdhe_x25519" (default)
- "ecdhe_x448" (default)
- "ecdhe_secp256r1" (default)
- "ecdhe_secp384r1" (default)
- "ecdhe_secp521r1" (default)
- "ffdhe_2048" (default)
- "ffdhe_3072" (default)
- "ffdhe_4096" (default)
- "ffdhe_6144" (default)
- "ffdhe_8192" (default)
Socket Config Settings
Note: This option is not valid for User Datagram Protocol (UDP) ports.
Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class is activated the InBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.
Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class is activated the OutBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.
Base Config Settings
In some non-GUI applications, an invalid message loop may be discovered that will result in errant behavior. In these cases, setting GUIAvailable to false will ensure that the class does not attempt to process external events.
- Product: The product the license is for.
- Product Key: The key the license was generated from.
- License Source: Where the license was found (e.g., RuntimeLicense, License File).
- License Type: The type of license installed (e.g., Royalty Free, Single Server).
- Last Valid Build: The last valid build number for which the license will work.
This setting only works on these classes: AS3Receiver, AS3Sender, Atom, Client(3DS), FTP, FTPServer, IMAP, OFTPClient, SSHClient, SCP, Server(3DS), Sexec, SFTP, SFTPServer, SSHServer, TCPClient, TCPServer.
Setting this configuration setting to true tells the class to use the internal implementation instead of using the system security libraries.
This setting is set to false by default on all platforms.
Trappable Errors (XMPP Class)
XMPP Errors
202 | Invalid argument. |
432 | Array index out of bounds. |
600 | XMPP protocol error (server returned an error code; description follows). |
601 | Server disconnected. |
602 | Cannot change this property while connected. |
603 | Invalid XML received from server. |
604 | Invalid response received from server. |
605 | Server indicates Transport Layer Security (TLS) is required. |
606 | User requested Secure Sockets Layer (SSL), but the server does not support it. |
607 | Cannot authenticate. |
620 | Error hashing password. |
TCPClient Errors
100 | You cannot change the RemotePort at this time. A connection is in progress. |
101 | You cannot change the RemoteHost (Server) at this time. A connection is in progress. |
102 | The RemoteHost address is invalid (0.0.0.0). |
104 | Already connected. If you want to reconnect, close the current connection first. |
106 | You cannot change the LocalPort at this time. A connection is in progress. |
107 | You cannot change the LocalHost at this time. A connection is in progress. |
112 | You cannot change MaxLineLength at this time. A connection is in progress. |
116 | RemotePort cannot be zero. Please specify a valid service port number. |
117 | You cannot change the UseConnection option while the class is active. |
135 | Operation would block. |
201 | Timeout. |
211 | Action impossible in control's present state. |
212 | Action impossible while not connected. |
213 | Action impossible while listening. |
301 | Timeout. |
303 | Could not open file. |
434 | Unable to convert string to selected CodePage. |
1105 | Already connecting. If you want to reconnect, close the current connection first. |
1117 | You need to connect first. |
1119 | You cannot change the LocalHost at this time. A connection is in progress. |
1120 | Connection dropped by remote host. |
SSL Errors
270 | Cannot load specified security library. |
271 | Cannot open certificate store. |
272 | Cannot find specified certificate. |
273 | Cannot acquire security credentials. |
274 | Cannot find certificate chain. |
275 | Cannot verify certificate chain. |
276 | Error during handshake. |
280 | Error verifying certificate. |
281 | Could not find client certificate. |
282 | Could not find server certificate. |
283 | Error encrypting data. |
284 | Error decrypting data. |
TCP/IP Errors
10004 | [10004] Interrupted system call. |
10009 | [10009] Bad file number. |
10013 | [10013] Access denied. |
10014 | [10014] Bad address. |
10022 | [10022] Invalid argument. |
10024 | [10024] Too many open files. |
10035 | [10035] Operation would block. |
10036 | [10036] Operation now in progress. |
10037 | [10037] Operation already in progress. |
10038 | [10038] Socket operation on nonsocket. |
10039 | [10039] Destination address required. |
10040 | [10040] Message is too long. |
10041 | [10041] Protocol wrong type for socket. |
10042 | [10042] Bad protocol option. |
10043 | [10043] Protocol is not supported. |
10044 | [10044] Socket type is not supported. |
10045 | [10045] Operation is not supported on socket. |
10046 | [10046] Protocol family is not supported. |
10047 | [10047] Address family is not supported by protocol family. |
10048 | [10048] Address already in use. |
10049 | [10049] Cannot assign requested address. |
10050 | [10050] Network is down. |
10051 | [10051] Network is unreachable. |
10052 | [10052] Net dropped connection or reset. |
10053 | [10053] Software caused connection abort. |
10054 | [10054] Connection reset by peer. |
10055 | [10055] No buffer space available. |
10056 | [10056] Socket is already connected. |
10057 | [10057] Socket is not connected. |
10058 | [10058] Cannot send after socket shutdown. |
10059 | [10059] Too many references, cannot splice. |
10060 | [10060] Connection timed out. |
10061 | [10061] Connection refused. |
10062 | [10062] Too many levels of symbolic links. |
10063 | [10063] File name is too long. |
10064 | [10064] Host is down. |
10065 | [10065] No route to host. |
10066 | [10066] Directory is not empty |
10067 | [10067] Too many processes. |
10068 | [10068] Too many users. |
10069 | [10069] Disc Quota Exceeded. |
10070 | [10070] Stale NFS file handle. |
10071 | [10071] Too many levels of remote in path. |
10091 | [10091] Network subsystem is unavailable. |
10092 | [10092] WINSOCK DLL Version out of range. |
10093 | [10093] Winsock is not loaded yet. |
11001 | [11001] Host not found. |
11002 | [11002] Nonauthoritative 'Host not found' (try again or check DNS setup). |
11003 | [11003] Nonrecoverable errors: FORMERR, REFUSED, NOTIMP. |
11004 | [11004] Valid name, no data record (check DNS setup). |