org.jivesoftware.smack

Class TCPConnection

java.lang.Object

org.jivesoftware.smack.XMPPConnection

org.jivesoftware.smack.TCPConnection

public class TCPConnection
extends org.jivesoftware.smack.XMPPConnection

Creates a socket connection to a XMPP server. This is the default connection to a Jabber server and is specified in the XMPP Core (RFC 3920).

See Also:

XMPPConnection

Nested Class Summary

Nested classes/interfaces inherited from class org.jivesoftware.smack.XMPPConnection

org.jivesoftware.smack.XMPPConnection.InterceptorWrapper, org.jivesoftware.smack.XMPPConnection.ListenerWrapper

Field Summary

Fields inherited from class org.jivesoftware.smack.XMPPConnection

collectors, compressionHandler, config, connectionCounterValue, connectionListeners, debugger, interceptors, reader, recvListeners, saslAuthentication, sendListeners, writer

Constructor Summary

Constructors

Constructor and Description
TCPConnection(org.jivesoftware.smack.ConnectionConfiguration config) Creates a new XMPP connection in the same way TCPConnection(ConnectionConfiguration,CallbackHandler) does, but with no callback handler for password prompting of the keystore.
TCPConnection(org.jivesoftware.smack.ConnectionConfiguration config, javax.security.auth.callback.CallbackHandler callbackHandler) Creates a new XMPP connection using the specified connection configuration.
TCPConnection(java.lang.String serviceName) Creates a new XMPP connection in the same way TCPConnection(String,CallbackHandler) does, but with no callback handler for password prompting of the keystore.
TCPConnection(java.lang.String serviceName, javax.security.auth.callback.CallbackHandler callbackHandler) Creates a new connection to the specified XMPP server.

Method Summary

Methods

Modifier and Type	Method and Description
void	connect() Establishes a connection to the XMPP server and performs an automatic login only if the previous connection state was logged (authenticated).
void	disconnect(org.jivesoftware.smack.packet.Presence unavailablePresence)
java.lang.String	getConnectionID()
org.jivesoftware.smack.parsing.ParsingExceptionCallback	getParsingExceptionCallback() Get the current active parsing exception callback.
java.lang.String	getUser()
boolean	isAnonymous()
boolean	isAuthenticated()
boolean	isConnected()
boolean	isSecureConnection()
boolean	isSocketClosed()
boolean	isUsingCompression()
boolean	isUsingTLS() Returns true if the connection to the server has successfully negotiated TLS.
void	login(java.lang.String username, java.lang.String password, java.lang.String resource)
void	loginAnonymously()
protected void	notifyReconnection() Sends a notification indicating that the connection was reconnected successfully.
void	setParsingExceptionCallback(org.jivesoftware.smack.parsing.ParsingExceptionCallback callback) Install a parsing exception callback, which will be invoked once an exception is encountered while parsing a stanza
protected void	shutdown(org.jivesoftware.smack.packet.Presence unavailablePresence) Closes the connection by setting presence to unavailable then closing the stream to the XMPP server.

Methods inherited from class org.jivesoftware.smack.XMPPConnection

addConnectionCreationListener, addConnectionListener, addPacketInterceptor, addPacketListener, addPacketSendingListener, createPacketCollector, createPacketCollectorAndSend, disconnect, getConfiguration, getConnectionCounter, getConnectionCreationListeners, getConnectionListeners, getHost, getPacketCollectors, getPacketInterceptors, getPacketListeners, getPacketReplyTimeout, getPacketSendingListeners, getPort, getRoster, getSASLAuthentication, getServiceCapsNode, getServiceName, initDebugger, isRosterVersioningSupported, login, processPacket, removeConnectionCreationListener, removeConnectionListener, removePacketCollector, removePacketInterceptor, removePacketListener, removePacketSendingListener, schedule, sendPacket, setPacketReplyTimeout, setRosterVersioningSupported, setServiceCapsNode

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TCPConnection

public TCPConnection(java.lang.String serviceName,
             javax.security.auth.callback.CallbackHandler callbackHandler)

Creates a new connection to the specified XMPP server. A DNS SRV lookup will be performed to determine the IP address and port corresponding to the service name; if that lookup fails, it's assumed that server resides at serviceName with the default port of 5222. Encrypted connections (TLS) will be used if available, stream compression is disabled, and standard SASL mechanisms will be used for authentication.

This is the simplest constructor for connecting to an XMPP server. Alternatively, you can get fine-grained control over connection settings using the TCPConnection(ConnectionConfiguration) constructor.

Note that TCPConnection constructors do not establish a connection to the server and you must call connect().

The CallbackHandler will only be used if the connection requires the client provide an SSL certificate to the server. The CallbackHandler must handle the PasswordCallback to prompt for a password to unlock the keystore containing the SSL certificate.

Parameters:

serviceName - the name of the XMPP server to connect to; e.g. example.com.

callbackHandler - the CallbackHandler used to prompt for the password to the keystore.

TCPConnection

public TCPConnection(java.lang.String serviceName)

Creates a new XMPP connection in the same way TCPConnection(String,CallbackHandler) does, but with no callback handler for password prompting of the keystore. This will work in most cases, provided the client is not required to provide a certificate to the server.

Parameters:

serviceName - the name of the XMPP server to connect to; e.g. example.com.

TCPConnection

public TCPConnection(org.jivesoftware.smack.ConnectionConfiguration config)

Creates a new XMPP connection in the same way TCPConnection(ConnectionConfiguration,CallbackHandler) does, but with no callback handler for password prompting of the keystore. This will work in most cases, provided the client is not required to provide a certificate to the server.

Parameters:

config - the connection configuration.

TCPConnection

public TCPConnection(org.jivesoftware.smack.ConnectionConfiguration config,
             javax.security.auth.callback.CallbackHandler callbackHandler)

Creates a new XMPP connection using the specified connection configuration.

Manually specifying connection configuration information is suitable for advanced users of the API. In many cases, using the TCPConnection(String) constructor is a better approach.

Note that TCPConnection constructors do not establish a connection to the server and you must call connect().

The CallbackHandler will only be used if the connection requires the client provide an SSL certificate to the server. The CallbackHandler must handle the PasswordCallback to prompt for a password to unlock the keystore containing the SSL certificate.

Parameters:

config - the connection configuration.

callbackHandler - the CallbackHandler used to prompt for the password to the keystore.

Method Detail

getConnectionID

public java.lang.String getConnectionID()

Specified by:

getConnectionID in class org.jivesoftware.smack.XMPPConnection

getUser

public java.lang.String getUser()

Specified by:

getUser in class org.jivesoftware.smack.XMPPConnection

setParsingExceptionCallback

public void setParsingExceptionCallback(org.jivesoftware.smack.parsing.ParsingExceptionCallback callback)

Install a parsing exception callback, which will be invoked once an exception is encountered while parsing a stanza

Parameters:

callback - the callback to install

getParsingExceptionCallback

public org.jivesoftware.smack.parsing.ParsingExceptionCallback getParsingExceptionCallback()

Get the current active parsing exception callback.

Returns:

the active exception callback or null if there is none

login

public void login(java.lang.String username,
         java.lang.String password,
         java.lang.String resource)
           throws org.jivesoftware.smack.XMPPException,
                  org.jivesoftware.smack.SmackException,
                  javax.security.sasl.SaslException,
                  java.io.IOException

Specified by:

login in class org.jivesoftware.smack.XMPPConnection

Throws:

org.jivesoftware.smack.XMPPException

org.jivesoftware.smack.SmackException

javax.security.sasl.SaslException

java.io.IOException

loginAnonymously

public void loginAnonymously()
                      throws org.jivesoftware.smack.XMPPException,
                             org.jivesoftware.smack.SmackException,
                             javax.security.sasl.SaslException,
                             java.io.IOException

Specified by:

loginAnonymously in class org.jivesoftware.smack.XMPPConnection

Throws:

org.jivesoftware.smack.XMPPException

org.jivesoftware.smack.SmackException

javax.security.sasl.SaslException

java.io.IOException

isConnected

public boolean isConnected()

Specified by:

isConnected in class org.jivesoftware.smack.XMPPConnection

isSecureConnection

public boolean isSecureConnection()

Specified by:

isSecureConnection in class org.jivesoftware.smack.XMPPConnection

isSocketClosed

public boolean isSocketClosed()

isAuthenticated

public boolean isAuthenticated()

Specified by:

isAuthenticated in class org.jivesoftware.smack.XMPPConnection

isAnonymous

public boolean isAnonymous()

Specified by:

isAnonymous in class org.jivesoftware.smack.XMPPConnection

shutdown

protected void shutdown(org.jivesoftware.smack.packet.Presence unavailablePresence)

Closes the connection by setting presence to unavailable then closing the stream to the XMPP server. The shutdown logic will be used during a planned disconnection or when dealing with an unexpected disconnection. Unlike XMPPConnection.disconnect() the connection's packet reader, packet writer, and Roster will not be removed; thus connection's state is kept.

Parameters:

unavailablePresence - the presence packet to send during shutdown.

disconnect

public void disconnect(org.jivesoftware.smack.packet.Presence unavailablePresence)

Specified by:

disconnect in class org.jivesoftware.smack.XMPPConnection

isUsingTLS

public boolean isUsingTLS()

Returns true if the connection to the server has successfully negotiated TLS. Once TLS has been negotiatied the connection has been secured.

Returns:

true if the connection to the server has successfully negotiated TLS.

isUsingCompression

public boolean isUsingCompression()

Specified by:

isUsingCompression in class org.jivesoftware.smack.XMPPConnection

connect

public void connect()
             throws org.jivesoftware.smack.SmackException,
                    java.io.IOException,
                    org.jivesoftware.smack.XMPPException

Establishes a connection to the XMPP server and performs an automatic login only if the previous connection state was logged (authenticated). It basically creates and maintains a socket connection to the server.

Listeners will be preserved from a previous connection if the reconnection occurs after an abrupt termination.

Specified by:

connect in class org.jivesoftware.smack.XMPPConnection

Throws:

XMPPException - if an error occurs while trying to establish the connection.

SmackException

java.io.IOException

notifyReconnection

protected void notifyReconnection()

Sends a notification indicating that the connection was reconnected successfully.