Package org.jivesoftware.smack.tcp

Class XMPPTCPConnection

java.lang.Object

org.jivesoftware.smack.AbstractXMPPConnection

org.jivesoftware.smack.tcp.XMPPTCPConnection

All Implemented Interfaces:

XMPPConnection

public class XMPPTCPConnection
extends AbstractXMPPConnection

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

See Also:

• XMPPConnection

Nested Class Summary

Nested Classes

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

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

AbstractXMPPConnection.InterceptorWrapper, AbstractXMPPConnection.ListenerWrapper, AbstractXMPPConnection.SyncPointState

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

XMPPConnection.FromMode

Field Summary

Fields

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

Fields inherited from class org.jivesoftware.smack.AbstractXMPPConnection

ASYNC_BUT_ORDERED, authenticated, authenticatedConnectionInitiallyEstablishedTimestamp, closingStreamReceived, compressionHandler, connected, connectionCounterValue, connectionListeners, connectionLock, debugger, host, lastFeaturesReceived, outgoingStreamXmlEnvironment, port, reader, saslFeatureReceived, SMACK_REACTOR, streamFeatures, streamId, tlsHandled, user, wasAuthenticated, writer

Constructor Summary

Constructors

Constructor	Description
XMPPTCPConnection(CharSequence jid, String password)	Creates a new XMPP connection over TCP.
XMPPTCPConnection(CharSequence username, String password, String serviceName)	Creates a new XMPP connection over TCP.
XMPPTCPConnection(XMPPTCPConnectionConfiguration config)	Creates a new XMPP connection over TCP (optionally using proxies).

Method Summary

Modifier and Type	Method	Description
boolean	addRequestAckPredicate(StanzaFilter predicate)	Add a predicate for Stream Management acknowledgment requests.
void	addStanzaAcknowledgedListener(StanzaListener listener)	Add a Stanza acknowledged listener.
void	addStanzaDroppedListener(StanzaListener listener)	Add a Stanza dropped listener.
StanzaListener	addStanzaIdAcknowledgedListener(String id, StanzaListener listener)	Add a new Stanza ID acknowledged listener for the given ID.
protected void	afterFeaturesReceived()
protected void	afterSuccessfulLogin(boolean resumed)
protected void	connectInternal()	Establishes a connection to the XMPP server.
InetAddress	getLocalAddress()	Returns the local address currently in use for this connection.
int	getMaxSmResumptionTime()	Get the maximum resumption time in seconds after which a managed stream can be resumed.
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()	Returns true if the connection to the server has successfully negotiated encryption.
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	isUsingCompression()	Returns true if network traffic is being compressed.
protected void	loginInternal(String username, String password, Resourcepart resource)
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(StanzaFilter predicate)	Remove the given predicate for Stream Management acknowledgment request.
boolean	removeStanzaAcknowledgedListener(StanzaListener listener)	Remove the given Stanza acknowledged listener.
boolean	removeStanzaDroppedListener(StanzaListener listener)	Remove the given Stanza dropped listener.
StanzaListener	removeStanzaIdAcknowledgedListener(String id)	Remove the Stanza ID acknowledged listener for the given ID.
void	requestSmAcknowledgement()	Send an unconditional Stream Management acknowledgement request to the server.
protected void	sendInternal(TopLevelStreamElement element)
protected void	sendNonBlockingInternal(TopLevelStreamElement element)
void	sendSmAcknowledgement()	Send a unconditional Stream Management acknowledgment to the server.
void	setBundleandDeferCallback(BundleAndDeferCallback bundleAndDeferCallback)	Set the bundle and defer callback used for this connection.
static void	setDefaultBundleAndDeferCallback(BundleAndDeferCallback defaultBundleAndDeferCallback)	Set the default bundle and defer callback used for new connections.
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)	Deprecated. use setUseStreamManagementResumptionDefault(boolean) instead.
void	setUseStreamManagementResumption(boolean useSmResumption)	Set if Stream Management resumption should be used if supported by the server.
static void	setUseStreamManagementResumptionDefault(boolean useSmResumptionDefault)	Set if Stream Management resumption should be used by default for new connections.
protected void	setWriter(Writer writer)	For unit testing purposes
protected void	shutdown()	Shuts the current connection down.
boolean	streamWasResumed()	Returns true if the stream was successfully resumed with help of Stream Management.
protected void	throwAlreadyConnectedExceptionIfAppropriate()
protected void	throwAlreadyLoggedInExceptionIfAppropriate()
protected void	throwNotConnectedExceptionIfAppropriate()

Methods inherited from class org.jivesoftware.smack.AbstractXMPPConnection

addAsyncStanzaListener, addConnectionListener, addMessageInterceptor, addOneTimeSyncCallback, addPresenceInterceptor, addStanzaListener, addStanzaSendingListener, addStreamFeature, addSyncStanzaListener, afterSaslAuthenticationSuccess, asyncGo, asyncGoLimited, authenticate, bindResourceAndEstablishSession, buildNonzaCallback, callConnectionAuthenticatedListener, callConnectionConnectedListener, callConnectionConnectingListener, connect, createStanzaCollector, createStanzaCollector, createStanzaCollectorAndSend, createStanzaCollectorAndSend, disconnect, disconnect, firePacketSendingListeners, getAuthenticatedConnectionInitiallyEstablishedTimestamp, getConfiguration, getConnectionCounter, getConnectionLock, getFeature, getFromMode, getHost, getLastStanzaReceived, getParsingExceptionCallback, getPort, getReactor, getReplyTimeout, getSmackTlsContext, getStanzaFactory, getStreamId, getStreamOpen, getUsedSaslMechansism, getUser, getXMPPServiceDomain, hasCurrentConnectionException, hasFeature, initDebugger, initState, invokeStanzaCollectorsAndNotifyRecvListeners, isAnonymous, isAuthenticated, isConnected, isSaslAuthenticated, login, login, login, notifyConnectionError, notifyWaitingThreads, onStreamOpen, parseAndProcessNonza, parseAndProcessStanza, parseFeatures, parseFeaturesAndNotify, processStanza, registerIQRequestHandler, removeAsyncStanzaListener, removeConnectionListener, removeMessageInterceptor, removePresenceInterceptor, removeStanzaCollector, removeStanzaListener, removeStanzaSendingListener, removeSyncStanzaListener, schedule, sendAndWaitForResponse, sendAsync, sendAsync, sendIqRequestAndWaitForResponse, sendIqRequestAsync, sendIqRequestAsync, sendNonza, sendNonzaNonBlocking, sendStanza, sendStanzaNonBlocking, sendStreamOpen, setCurrentConnectionExceptionAndNotify, setFromMode, setMaxAsyncOperations, setParsingExceptionCallback, setReplyTimeout, setUnknownIqRequestReplyMode, setWasAuthenticated, throwNotConnectedExceptionIfAppropriate, toString, trySendStanza, trySendStanza, unregisterIQRequestHandler, unregisterIQRequestHandler, updateOutgoingStreamXmlEnvironmentOnStreamOpen, waitFor, waitForClosingStreamTagFromServer, waitForConditionOrThrowConnectionException

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jivesoftware.smack.XMPPConnection

getFeature, hasFeature

Field Details

packetWriter

protected final XMPPTCPConnection.PacketWriter packetWriter

Protected access level because of unit test purposes

packetReader

protected final XMPPTCPConnection.PacketReader packetReader

Protected access level because of unit test purposes

Constructor Details

XMPPTCPConnection

public XMPPTCPConnection(XMPPTCPConnectionConfiguration config)

Creates a new XMPP connection over TCP (optionally using proxies).

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

Parameters:

config - the connection configuration.

XMPPTCPConnection

public XMPPTCPConnection(CharSequence jid,
 String password)
                  throws XmppStringprepException

Creates a new XMPP connection over TCP.

Note that jid must be the bare JID, e.g. "user@example.org". More fine-grained control over the connection settings is available using the XMPPTCPConnection(XMPPTCPConnectionConfiguration) constructor.

Parameters:

jid - the bare JID used by the client.

password - the password or authentication token.

Throws:

XmppStringprepException - if the provided string is invalid.

XMPPTCPConnection

public XMPPTCPConnection(CharSequence username,
 String password,
 String serviceName)
                  throws XmppStringprepException

Creates a new XMPP connection over TCP.

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

Parameters:

username - TODO javadoc me please

password - TODO javadoc me please

serviceName - TODO javadoc me please

Throws:

XmppStringprepException - if the provided string is invalid.

Method Details

throwNotConnectedExceptionIfAppropriate

protected void throwNotConnectedExceptionIfAppropriate()
                                                throws SmackException.NotConnectedException

Overrides:

throwNotConnectedExceptionIfAppropriate in class AbstractXMPPConnection

Throws:

SmackException.NotConnectedException

throwAlreadyConnectedExceptionIfAppropriate

protected void throwAlreadyConnectedExceptionIfAppropriate()
                                                    throws SmackException.AlreadyConnectedException

Overrides:

throwAlreadyConnectedExceptionIfAppropriate in class AbstractXMPPConnection

Throws:

SmackException.AlreadyConnectedException

throwAlreadyLoggedInExceptionIfAppropriate

protected void throwAlreadyLoggedInExceptionIfAppropriate()
                                                   throws SmackException.AlreadyLoggedInException

Overrides:

throwAlreadyLoggedInExceptionIfAppropriate in class AbstractXMPPConnection

Throws:

SmackException.AlreadyLoggedInException

afterSuccessfulLogin

protected void afterSuccessfulLogin(boolean resumed)
                             throws SmackException.NotConnectedException,
InterruptedException

Overrides:

afterSuccessfulLogin in class AbstractXMPPConnection

Throws:

SmackException.NotConnectedException

InterruptedException

loginInternal

protected void loginInternal(String username,
 String password,
 Resourcepart resource)
                      throws XMPPException,
SmackException,
IOException,
InterruptedException

Specified by:

loginInternal in class AbstractXMPPConnection

Throws:

XMPPException

SmackException

IOException

InterruptedException

isSecureConnection

public boolean isSecureConnection()

Description copied from interface: XMPPConnection

Returns true if the connection to the server has successfully negotiated encryption.

Specified by:

isSecureConnection in interface XMPPConnection

Specified by:

isSecureConnection in class AbstractXMPPConnection

Returns:

true if a secure connection to the server.

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 AbstractXMPPConnection

instantShutdown

public void instantShutdown()

Description copied from class: AbstractXMPPConnection

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

Specified by:

instantShutdown in class AbstractXMPPConnection

sendInternal

protected void sendInternal(TopLevelStreamElement element)
                     throws SmackException.NotConnectedException,
InterruptedException

Specified by:

sendInternal in class AbstractXMPPConnection

Throws:

SmackException.NotConnectedException

InterruptedException

sendNonBlockingInternal

protected void sendNonBlockingInternal(TopLevelStreamElement element)
                                throws SmackException.NotConnectedException,
SmackException.OutgoingQueueFullException

Specified by:

sendNonBlockingInternal in class AbstractXMPPConnection

Throws:

SmackException.NotConnectedException

SmackException.OutgoingQueueFullException

isUsingCompression

public boolean isUsingCompression()

Description copied from interface: XMPPConnection

Returns true if network traffic is being compressed. When using stream compression network traffic can be reduced up to 90%. Therefore, stream compression is ideal when using a slow speed network connection. However, the server will need to use more CPU time in order to un/compress network data so under high load the server performance might be affected.

Specified by:

isUsingCompression in interface XMPPConnection

Specified by:

isUsingCompression in class AbstractXMPPConnection

Returns:

true if network traffic is being compressed.

connectInternal

protected void connectInternal()
                        throws SmackException,
IOException,
XMPPException,
InterruptedException

Establishes a connection to the XMPP server. 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 AbstractXMPPConnection

Throws:

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

SmackException - if Smack detected an exceptional situation.

IOException - if an I/O error occurred.

InterruptedException - if the calling thread was interrupted.

setWriter

protected void setWriter(Writer writer)

For unit testing purposes

Parameters:

writer - TODO javadoc me please

afterFeaturesReceived

protected void afterFeaturesReceived()
                              throws SmackException.NotConnectedException,
InterruptedException,
SmackException.SecurityRequiredByServerException

Overrides:

afterFeaturesReceived in class AbstractXMPPConnection

Throws:

SmackException.NotConnectedException

InterruptedException

SmackException.SecurityRequiredByServerException

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

@Deprecated
public static void setUseStreamManagementResumptiodDefault(boolean useSmResumptionDefault)

Deprecated.

use setUseStreamManagementResumptionDefault(boolean) instead.

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

Parameters:

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

setUseStreamManagementResumptionDefault

public static void setUseStreamManagementResumptionDefault(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(StanzaFilter 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.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(StanzaFilter 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,
SmackException.NotConnectedException,
InterruptedException

Send an unconditional Stream Management acknowledgement request to the server.

Throws:

StreamManagementException.StreamManagementNotEnabledException - if Stream Management is not enabled.

SmackException.NotConnectedException - if the connection is not connected.

InterruptedException - if the calling thread was interrupted.

sendSmAcknowledgement

public void sendSmAcknowledgement()
                           throws StreamManagementException.StreamManagementNotEnabledException,
SmackException.NotConnectedException,
InterruptedException

Send a unconditional Stream Management acknowledgment to the server.

See XEP-198: Stream Management § 4. Acks: "Either party MAY send an <a/> 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 <r/> element from the other party."

Throws:

StreamManagementException.StreamManagementNotEnabledException - if Stream Management is not enabled.

SmackException.NotConnectedException - if the connection is not connected.

InterruptedException - if the calling thread was interrupted.

addStanzaAcknowledgedListener

public void addStanzaAcknowledgedListener(StanzaListener listener)

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, StanzaListener) when possible.

Parameters:

listener - the listener to add.

removeStanzaAcknowledgedListener

public boolean removeStanzaAcknowledgedListener(StanzaListener 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.

addStanzaDroppedListener

public void addStanzaDroppedListener(StanzaListener listener)

Add a Stanza dropped listener.

Those listeners will be invoked every time a Stanza has been dropped due to a failed SM resume. They will not get automatically removed. If at least one StanzaDroppedListener is configured, no attempt will be made to retransmit the Stanzas.

Parameters:

listener - the listener to add.

Since:

4.3.3

removeStanzaDroppedListener

public boolean removeStanzaDroppedListener(StanzaListener listener)

Remove the given Stanza dropped listener.

Parameters:

listener - the listener.

Returns:

true if the listener was removed.

Since:

4.3.3

addStanzaIdAcknowledgedListener

public StanzaListener addStanzaIdAcknowledgedListener(String id,
 StanzaListener 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 StanzaListener removeStanzaIdAcknowledgedListener(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.

streamWasResumed

public boolean streamWasResumed()

Returns true if the stream was successfully resumed with help of Stream Management.

Returns:

true if the stream was resumed.

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.

getMaxSmResumptionTime

public int getMaxSmResumptionTime()

Get the maximum resumption time in seconds after which a managed stream can be resumed.

This method will return Integer.MAX_VALUE if neither the client nor the server specify a maximum resumption time. Be aware of integer overflows when using this value, e.g. do not add arbitrary values to it without checking for overflows before.

Returns:

the maximum resumption time in seconds or Integer.MAX_VALUE if none set.

setDefaultBundleAndDeferCallback

public static void setDefaultBundleAndDeferCallback(BundleAndDeferCallback defaultBundleAndDeferCallback)

Set the default bundle and defer callback used for new connections.

Parameters:

defaultBundleAndDeferCallback - TODO javadoc me please

Since:

4.1

See Also:

• BundleAndDeferCallback

setBundleandDeferCallback

public void setBundleandDeferCallback(BundleAndDeferCallback bundleAndDeferCallback)

Set the bundle and defer callback used for this connection.

You can use null as argument to reset the callback. Outgoing stanzas will then no longer get deferred.

Parameters:

bundleAndDeferCallback - the callback or null.

Since:

4.1

See Also:

• BundleAndDeferCallback

getLocalAddress

public InetAddress getLocalAddress()

Returns the local address currently in use for this connection.

Returns:

the local address