org.jivesoftware.smack.tcp

Class XMPPTCPConnection

java.lang.Object

org.jivesoftware.smack.AbstractXMPPConnection

org.jivesoftware.smack.tcp.XMPPTCPConnection

All Implemented Interfaces:

org.jivesoftware.smack.XMPPConnection

public class XMPPTCPConnection
extends org.jivesoftware.smack.AbstractXMPPConnection

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

See Also:

XMPPConnection

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	XMPPTCPConnection.PacketReader
protected class	XMPPTCPConnection.PacketWriter

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

org.jivesoftware.smack.AbstractXMPPConnection.InterceptorWrapper, org.jivesoftware.smack.AbstractXMPPConnection.ListenerWrapper

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

org.jivesoftware.smack.XMPPConnection.FromMode

Field Summary

Fields

Modifier and Type	Field and Description
protected XMPPTCPConnection.PacketReader	packetReader Protected access level because of unit test purposes
protected XMPPTCPConnection.PacketWriter	packetWriter Protected access level because of unit test purposes

Fields inherited from class org.jivesoftware.smack.AbstractXMPPConnection

authenticated, compressionHandler, config, connected, connectionCounterValue, connectionListeners, connectionLock, debugger, host, lastFeaturesReceived, port, reader, saslAuthentication, saslFeatureReceived, streamFeatures, user, wasAuthenticated, writer

Constructor Summary

Constructors

Constructor and Description
XMPPTCPConnection(org.jivesoftware.smack.ConnectionConfiguration config) Creates a new XMPP connection in the same way XMPPTCPConnection(ConnectionConfiguration,CallbackHandler) does, but with no callback handler for password prompting of the keystore.
XMPPTCPConnection(org.jivesoftware.smack.ConnectionConfiguration config, javax.security.auth.callback.CallbackHandler callbackHandler) Creates a new XMPP connection using the specified connection configuration.
XMPPTCPConnection(java.lang.String serviceName) Creates a new XMPP connection in the same way XMPPTCPConnection(String,CallbackHandler) does, but with no callback handler for password prompting of the keystore.
XMPPTCPConnection(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
boolean	addRequestAckPredicate(org.jivesoftware.smack.filter.PacketFilter predicate) Add a predicate for Stream Management acknowledgment requests.
void	addStanzaAcknowledgedListener(org.jivesoftware.smack.PacketListener listener) Add a Stanza acknowledged listener.
org.jivesoftware.smack.PacketListener	addStanzaIdAcknowledgedListener(java.lang.String id, org.jivesoftware.smack.PacketListener listener) Add a new Stanza ID acknowledged listener for the given ID.
protected void	afterFeaturesReceived()
protected void	connectInternal() Establishes a connection to the XMPP server and performs an automatic login only if the previous connection state was logged (authenticated).
java.lang.String	getConnectionID()
org.jivesoftware.smack.parsing.ParsingExceptionCallback	getParsingExceptionCallback() Get the current active parsing exception callback.
void	instantShutdown() Performs an unclean disconnect and shutdown of the connection.
boolean	isDisconnectedButSmResumptionPossible() Returns true if the connection is disconnected by a Stream resumption via Stream Management is possible.
boolean	isSecureConnection()
boolean	isSmAvailable() Returns true if Stream Management is supported by the server.
boolean	isSmEnabled() Returns true if Stream Management was successfully negotiated with the server.
boolean	isSmResumptionPossible() Returns true if the stream is resumable.
boolean	isSocketClosed()
boolean	isUsingCompression()
void	login(java.lang.String username, java.lang.String password, java.lang.String resource)
void	loginAnonymously()
void	removeAllRequestAckPredicates() Remove all predicates for Stream Management acknowledgment requests.
void	removeAllStanzaAcknowledgedListeners() Remove all stanza acknowledged listeners.
void	removeAllStanzaIdAcknowledgedListeners() Removes all Stanza ID acknowledged listeners.
boolean	removeRequestAckPredicate(org.jivesoftware.smack.filter.PacketFilter predicate) Remove the given predicate for Stream Management acknowledgment request.
boolean	removeStanzaAcknowledgedListener(org.jivesoftware.smack.PacketListener listener) Remove the given Stanza acknowledged listener.
org.jivesoftware.smack.PacketListener	removeStanzaIdAcknowledgedListener(java.lang.String id) Remove the Stanza ID acknowledged listener for the given ID.
void	requestSmAcknowledgement() Send an unconditional Stream Management acknowledgement request to the server.
void	send(org.jivesoftware.smack.packet.PlainStreamElement element)
protected void	sendPacketInternal(org.jivesoftware.smack.packet.Packet packet)
void	sendSmAcknowledgement() Send a unconditional Stream Management acknowledgment to the server.
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
void	setPreferredResumptionTime(int resumptionTime) Set the preferred resumption time in seconds.
void	setUseStreamManagement(boolean useSm) Set if Stream Management should be used if supported by the server.
static void	setUseStreamManagementDefault(boolean useSmDefault) Set if Stream Management should be used by default for new connections.
static void	setUseStreamManagementResumptiodDefault(boolean useSmResumptionDefault) Set if Stream Management resumption should be used by default for new connections.
void	setUseStreamManagementResumption(boolean useSmResumption) Set if Stream Management resumption should be used if supported by the server.
protected void	setWriter(java.io.Writer writer) For unit testing purposes
protected void	shutdown() Shuts the current connection down.

Methods inherited from class org.jivesoftware.smack.AbstractXMPPConnection

addConnectionListener, addPacketInterceptor, addPacketListener, addPacketSendingListener, afterSuccessfulLogin, bindResourceAndEstablishSession, callConnectionAuthenticatedListener, callConnectionClosedOnErrorListener, callConnectionConnectedListener, connect, createPacketCollector, createPacketCollectorAndSend, createPacketCollectorAndSend, disconnect, disconnect, finalize, firePacketSendingListeners, getConfiguration, getConnectionCounter, getConnectionCreationListeners, getConnectionListeners, getConnectionLock, getFeature, getFromMode, getHost, getLastStanzaReceived, getPacketReplyTimeout, getPort, getRoster, getRosterStore, getSASLAuthentication, getServiceName, getUser, hasFeature, initDebugger, invokePacketCollectorsAndNotifyRecvListeners, isAnonymous, isAuthenticated, isConnected, isRosterLoadedAtLogin, login, maybeResolveDns, parseFeatures, processPacket, removeConnectionListener, removePacketCollector, removePacketInterceptor, removePacketListener, removePacketSendingListener, reportStanzaReceived, sendIqWithResponseCallback, sendIqWithResponseCallback, sendIqWithResponseCallback, sendPacket, sendStanzaWithResponseCallback, sendStanzaWithResponseCallback, sendStanzaWithResponseCallback, setFromMode, setLoginInfo, setPacketReplyTimeout, setServiceName, setWasAuthenticated

Methods inherited from class java.lang.Object

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

Field Detail

packetWriter

protected XMPPTCPConnection.PacketWriter packetWriter

Protected access level because of unit test purposes

packetReader

protected XMPPTCPConnection.PacketReader packetReader

Protected access level because of unit test purposes

Constructor Detail

XMPPTCPConnection

public XMPPTCPConnection(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 XMPPTCPConnection(ConnectionConfiguration) constructor.

Note that XMPPTCPConnection constructors do not establish a connection to the server and you must call AbstractXMPPConnection.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.

XMPPTCPConnection

public XMPPTCPConnection(java.lang.String serviceName)

Creates a new XMPP connection in the same way XMPPTCPConnection(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.

XMPPTCPConnection

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

Creates a new XMPP connection in the same way XMPPTCPConnection(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.

XMPPTCPConnection

public XMPPTCPConnection(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 XMPPTCPConnection(String) constructor is a better approach.

Note that XMPPTCPConnection constructors do not establish a connection to the server and you must call AbstractXMPPConnection.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 interface org.jivesoftware.smack.XMPPConnection

Specified by:

getConnectionID in class org.jivesoftware.smack.AbstractXMPPConnection

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,
                  java.io.IOException

Specified by:

login in class org.jivesoftware.smack.AbstractXMPPConnection

Throws:

org.jivesoftware.smack.XMPPException

org.jivesoftware.smack.SmackException

java.io.IOException

loginAnonymously

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

Specified by:

loginAnonymously in class org.jivesoftware.smack.AbstractXMPPConnection

Throws:

org.jivesoftware.smack.XMPPException

org.jivesoftware.smack.SmackException

java.io.IOException

isSecureConnection

public boolean isSecureConnection()

Specified by:

isSecureConnection in interface org.jivesoftware.smack.XMPPConnection

Specified by:

isSecureConnection in class org.jivesoftware.smack.AbstractXMPPConnection

isSocketClosed

public boolean isSocketClosed()

shutdown

protected void shutdown()

Shuts the current connection down. After this method returns, the connection must be ready for re-use by connect.

Specified by:

shutdown in class org.jivesoftware.smack.AbstractXMPPConnection

instantShutdown

public void instantShutdown()

Performs an unclean disconnect and shutdown of the connection. Does not send a closing stream stanza.

send

public void send(org.jivesoftware.smack.packet.PlainStreamElement element)
          throws org.jivesoftware.smack.SmackException.NotConnectedException

Specified by:

send in interface org.jivesoftware.smack.XMPPConnection

Specified by:

send in class org.jivesoftware.smack.AbstractXMPPConnection

Throws:

org.jivesoftware.smack.SmackException.NotConnectedException

sendPacketInternal

protected void sendPacketInternal(org.jivesoftware.smack.packet.Packet packet)
                           throws org.jivesoftware.smack.SmackException.NotConnectedException

Specified by:

sendPacketInternal in class org.jivesoftware.smack.AbstractXMPPConnection

Throws:

org.jivesoftware.smack.SmackException.NotConnectedException

isUsingCompression

public boolean isUsingCompression()

Specified by:

isUsingCompression in interface org.jivesoftware.smack.XMPPConnection

Specified by:

isUsingCompression in class org.jivesoftware.smack.AbstractXMPPConnection

connectInternal

protected void connectInternal()
                        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:

connectInternal in class org.jivesoftware.smack.AbstractXMPPConnection

Throws:

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

org.jivesoftware.smack.SmackException

java.io.IOException

setWriter

protected void setWriter(java.io.Writer writer)

For unit testing purposes

Parameters:

writer -

afterFeaturesReceived

protected void afterFeaturesReceived()
                              throws org.jivesoftware.smack.SmackException.SecurityRequiredException,
                                     org.jivesoftware.smack.SmackException.NotConnectedException

Overrides:

afterFeaturesReceived in class org.jivesoftware.smack.AbstractXMPPConnection

Throws:

org.jivesoftware.smack.SmackException.SecurityRequiredException

org.jivesoftware.smack.SmackException.NotConnectedException

setUseStreamManagementDefault

public static void setUseStreamManagementDefault(boolean useSmDefault)

Set if Stream Management should be used by default for new connections.

Parameters:

useSmDefault - true to use Stream Management for new connections.

setUseStreamManagementResumptiodDefault

public static void setUseStreamManagementResumptiodDefault(boolean useSmResumptionDefault)

Set if Stream Management resumption should be used by default for new connections.

Parameters:

useSmResumptionDefault - true to use Stream Management resumption for new connections.

setUseStreamManagement

public void setUseStreamManagement(boolean useSm)

Set if Stream Management should be used if supported by the server.

Parameters:

useSm - true to use Stream Management.

setUseStreamManagementResumption

public void setUseStreamManagementResumption(boolean useSmResumption)

Set if Stream Management resumption should be used if supported by the server.

Parameters:

useSmResumption - true to use Stream Management resumption.

setPreferredResumptionTime

public void setPreferredResumptionTime(int resumptionTime)

Set the preferred resumption time in seconds.

Parameters:

resumptionTime - the preferred resumption time in seconds

addRequestAckPredicate

public boolean addRequestAckPredicate(org.jivesoftware.smack.filter.PacketFilter predicate)

Add a predicate for Stream Management acknowledgment requests.

Those predicates are used to determine when a Stream Management acknowledgement request is send to the server. Some pre-defined predicates are found in the org.jivesoftware.smack.tcp.sm.predicates package.

If not predicate is configured, the Predicate.forMessagesOrAfter5Stanzas() will be used.

Parameters:

predicate - the predicate to add.

Returns:

if the predicate was not already active.

removeRequestAckPredicate

public boolean removeRequestAckPredicate(org.jivesoftware.smack.filter.PacketFilter predicate)

Remove the given predicate for Stream Management acknowledgment request.

Parameters:

predicate - the predicate to remove.

Returns:

true if the predicate was removed.

removeAllRequestAckPredicates

public void removeAllRequestAckPredicates()

Remove all predicates for Stream Management acknowledgment requests.

requestSmAcknowledgement

public void requestSmAcknowledgement()
                              throws StreamManagementException.StreamManagementNotEnabledException,
                                     org.jivesoftware.smack.SmackException.NotConnectedException

Send an unconditional Stream Management acknowledgement request to the server.

Throws:

StreamManagementException.StreamManagementNotEnabledException - if Stream Mangement is not enabled.

org.jivesoftware.smack.SmackException.NotConnectedException - if the connection is not connected.

sendSmAcknowledgement

public void sendSmAcknowledgement()
                           throws StreamManagementException.StreamManagementNotEnabledException,
                                  org.jivesoftware.smack.SmackException.NotConnectedException

Send a unconditional Stream Management acknowledgment to the server.

See XEP-198: Stream Management § 4. Acks: "Either party MAY send an element at any time (e.g., after it has received a certain number of stanzas, or after a certain period of time), even if it has not received an element from the other party."

Throws:

StreamManagementException.StreamManagementNotEnabledException - if Stream Management is not enabled.

org.jivesoftware.smack.SmackException.NotConnectedException - if the connection is not connected.

addStanzaAcknowledgedListener

public void addStanzaAcknowledgedListener(org.jivesoftware.smack.PacketListener listener)
                                   throws StreamManagementException.StreamManagementNotEnabledException

Add a Stanza acknowledged listener.

Those listeners will be invoked every time a Stanza has been acknowledged by the server. The will not get automatically removed. Consider using addStanzaIdAcknowledgedListener(String, PacketListener) when possible.

Parameters:

listener - the listener to add.

Throws:

StreamManagementException.StreamManagementNotEnabledException - if Stream Management is not enabled.

removeStanzaAcknowledgedListener

public boolean removeStanzaAcknowledgedListener(org.jivesoftware.smack.PacketListener listener)

Remove the given Stanza acknowledged listener.

Parameters:

listener - the listener.

Returns:

true if the listener was removed.

removeAllStanzaAcknowledgedListeners

public void removeAllStanzaAcknowledgedListeners()

Remove all stanza acknowledged listeners.

addStanzaIdAcknowledgedListener

public org.jivesoftware.smack.PacketListener addStanzaIdAcknowledgedListener(java.lang.String id,
                                                                    org.jivesoftware.smack.PacketListener listener)
                                                                      throws StreamManagementException.StreamManagementNotEnabledException

Add a new Stanza ID acknowledged listener for the given ID.

The listener will be invoked if the stanza with the given ID was acknowledged by the server. It will automatically be removed after the listener was run.

Parameters:

id - the stanza ID.

listener - the listener to invoke.

Returns:

the previous listener for this stanza ID or null.

Throws:

StreamManagementException.StreamManagementNotEnabledException - if Stream Management is not enabled.

removeStanzaIdAcknowledgedListener

public org.jivesoftware.smack.PacketListener removeStanzaIdAcknowledgedListener(java.lang.String id)

Remove the Stanza ID acknowledged listener for the given ID.

Parameters:

id - the stanza ID.

Returns:

true if the listener was found and removed, false otherwise.

removeAllStanzaIdAcknowledgedListeners

public void removeAllStanzaIdAcknowledgedListeners()

Removes all Stanza ID acknowledged listeners.

isSmAvailable

public boolean isSmAvailable()

Returns true if Stream Management is supported by the server.

Returns:

true if Stream Management is supported by the server.

isSmEnabled

public boolean isSmEnabled()

Returns true if Stream Management was successfully negotiated with the server.

Returns:

true if Stream Management was negotiated.

isDisconnectedButSmResumptionPossible

public boolean isDisconnectedButSmResumptionPossible()

Returns true if the connection is disconnected by a Stream resumption via Stream Management is possible.

Returns:

true if disconnected but resumption possible.

isSmResumptionPossible

public boolean isSmResumptionPossible()

Returns true if the stream is resumable.

Returns:

true if the stream is resumable.