AbstractXMPPConnection (smack-core 4.1.0-alpha5 API)

java.lang.Object
- org.jivesoftware.smack.AbstractXMPPConnection

All Implemented Interfaces:: XMPPConnection

public abstract class AbstractXMPPConnection
extends java.lang.Object
implements XMPPConnection

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`protected static class`	`AbstractXMPPConnection.InterceptorWrapper` A wrapper class to associate a packet filter with an interceptor.
`protected static class`	`AbstractXMPPConnection.ListenerWrapper` A wrapper class to associate a packet filter with a listener.

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

Field Summary

Fields
Modifier and Type	Field and Description
`protected boolean`	`authenticated` Flag that indicates if the user is currently authenticated with the server.
`protected XMPPInputOutputStream`	`compressionHandler`
`protected ConnectionConfiguration`	`config` Holds the initial configuration used while creating the connection.
`protected boolean`	`connected`
`protected int`	`connectionCounterValue` A number to uniquely identify connections that are created.
`protected java.util.Set<ConnectionListener>`	`connectionListeners` A collection of ConnectionListeners which listen for connection closing and reconnection events.
`protected java.util.concurrent.locks.Lock`	`connectionLock`
`protected SmackDebugger`	`debugger` The SmackDebugger allows to log and debug XML traffic.
`protected java.lang.String`	`host` The used host to establish the connection to
`protected SynchronizationPoint<java.lang.Exception>`	`lastFeaturesReceived` Set to success if the last features stanza from the server has been parsed.
`protected int`	`port` The used port to establish the connection to
`protected java.io.Reader`	`reader` The Reader which is used for the debugger.
`protected SASLAuthentication`	`saslAuthentication` The SASLAuthentication manager that is responsible for authenticating with the server.
`protected SynchronizationPoint<SmackException>`	`saslFeatureReceived` Set to success if the sasl feature has been received.
`protected java.util.Map<java.lang.String,PacketExtension>`	`streamFeatures`
`protected java.lang.String`	`user` The full JID of the authenticated user.
`protected boolean`	`wasAuthenticated` Flag that indicates if the user was authenticated with the server when the connection to the server was closed (abruptly or not).
`protected java.io.Writer`	`writer` The Writer which is used for the debugger.

Constructor Summary

Constructors
Modifier Constructor and Description

protected AbstractXMPPConnection(ConnectionConfiguration configuration)
Create a new XMPPConnection to a XMPP server.

Constructors
Modifier	Constructor and Description
`protected`	`AbstractXMPPConnection(ConnectionConfiguration configuration)` Create a new XMPPConnection to a XMPP server.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addConnectionListener(ConnectionListener connectionListener)` Adds a connection listener to this connection that will be notified when the connection closes or fails.
`void`	`addPacketInterceptor(PacketListener packetInterceptor, PacketFilter packetFilter)` Registers a packet interceptor with this connection.
`void`	`addPacketListener(PacketListener packetListener, PacketFilter packetFilter)` Registers a packet listener with this connection.
`void`	`addPacketSendingListener(PacketListener packetListener, PacketFilter packetFilter)` Registers a packet listener with this connection.
`protected void`	`afterFeaturesReceived()`
`protected void`	`afterSuccessfulLogin(boolean anonymous, boolean resumed)`
`protected void`	`bindResourceAndEstablishSession(java.lang.String resource)`
`protected void`	`callConnectionAuthenticatedListener()`
`protected void`	`callConnectionClosedOnErrorListener(java.lang.Exception e)`
`protected void`	`callConnectionConnectedListener()`
`void`	`connect()` Establishes a connection to the XMPP server and performs an automatic login only if the previous connection state was logged (authenticated).
`protected abstract void`	`connectInternal()` Abstract method that concrete subclasses of XMPPConnection need to implement to perform their way of XMPP connection establishment.
`PacketCollector`	`createPacketCollector(PacketFilter packetFilter)` Creates a new packet collector for this connection.
`PacketCollector`	`createPacketCollectorAndSend(IQ packet)` Creates a new packet collector collecting packets that are replies to `packet`.
`PacketCollector`	`createPacketCollectorAndSend(PacketFilter packetFilter, Packet packet)` Creates a new packet collector for this connection.
`void`	`disconnect()` Closes the connection by setting presence to unavailable then closing the connection to the XMPP server.
`void`	`disconnect(Presence unavailablePresence)` Closes the connection.
`protected void`	`finalize()`
`protected void`	`firePacketSendingListeners(Packet packet)` Process all packet listeners for sending packets.
`protected ConnectionConfiguration`	`getConfiguration()`
`int`	`getConnectionCounter()` Get the connection counter of this XMPPConnection instance.
`protected static java.util.Collection<ConnectionCreationListener>`	`getConnectionCreationListeners()` Get the collection of listeners that are interested in connection creation events.
`abstract java.lang.String`	`getConnectionID()` Returns the connection ID for this connection, which is the value set by the server when opening a XMPP stream.
`protected java.util.Collection<ConnectionListener>`	`getConnectionListeners()` Get the collection of listeners that are interested in connection events.
`protected java.util.concurrent.locks.Lock`	`getConnectionLock()`
`<F extends PacketExtension> F`	`getFeature(java.lang.String element, java.lang.String namespace)` Get the feature packet extensions for a given stream feature of the server, or `null` if the server doesn't support that feature.
`XMPPConnection.FromMode`	`getFromMode()` Get the currently active FromMode.
`java.lang.String`	`getHost()` Returns the host name of the server where the XMPP server is running.
`long`	`getLastStanzaReceived()` Returns the timestamp in milliseconds when the last stanza was received.
`long`	`getPacketReplyTimeout()` Returns the current value of the reply timeout in milliseconds for request for this XMPPConnection instance.
`int`	`getPort()` Returns the port number of the XMPP server for this connection.
`Roster`	`getRoster()` Returns the roster for the user.
`RosterStore`	`getRosterStore()` Get the permanent roster store.
`protected SASLAuthentication`	`getSASLAuthentication()` Returns the SASLAuthentication manager that is responsible for authenticating with the server.
`java.lang.String`	`getServiceName()` Returns the name of the service provided by the XMPP server for this connection.
`java.lang.String`	`getUser()` Returns the full XMPP address of the user that is logged in to the connection or `null` if not logged in yet.
`boolean`	`hasFeature(java.lang.String element, java.lang.String namespace)` Return true if the server supports the given stream feature.
`protected void`	`initDebugger()` Initialize the `debugger`.
`protected void`	`invokePacketCollectorsAndNotifyRecvListeners(Packet packet)` Invoke `PacketCollector.processPacket(Packet)` for every PacketCollector with the given packet.
`boolean`	`isAnonymous()` Returns true if currently authenticated anonymously.
`boolean`	`isAuthenticated()` Returns true if currently authenticated by successfully calling the login method.
`boolean`	`isConnected()` Returns true if currently connected to the XMPP server.
`boolean`	`isRosterLoadedAtLogin()` Returns true if the roster will be loaded from the server when logging in.
`abstract boolean`	`isSecureConnection()` Returns true if the connection to the server has successfully negotiated encryption.
`abstract boolean`	`isUsingCompression()` Returns true if network traffic is being compressed.
`void`	`login(java.lang.String username, java.lang.String password)` Logs in to the server using the strongest authentication mode supported by the server, then sets presence to available.
`abstract void`	`login(java.lang.String username, java.lang.String password, java.lang.String resource)` Logs in to the server using the strongest authentication mode supported by the server, then sets presence to available.
`abstract void`	`loginAnonymously()` Logs in to the server anonymously.
`protected void`	`maybeResolveDns()`
`protected void`	`parseFeatures(org.xmlpull.v1.XmlPullParser parser)`
`protected void`	`processPacket(Packet packet)` Processes a packet after it's been fully parsed by looping through the installed packet collectors and listeners and letting them examine the packet to see if they are a match with the filter.
`void`	`removeConnectionListener(ConnectionListener connectionListener)` Removes a connection listener from this connection.
`void`	`removePacketCollector(PacketCollector collector)` Remove a packet collector of this connection.
`void`	`removePacketInterceptor(PacketListener packetInterceptor)` Removes a packet interceptor.
`boolean`	`removePacketListener(PacketListener packetListener)` Removes a packet listener for received packets from this connection.
`void`	`removePacketSendingListener(PacketListener packetListener)` Removes a packet listener for sending packets from this connection.
`protected void`	`reportStanzaReceived()`
`abstract void`	`send(PlainStreamElement element)` Send a PlainStreamElement.
`void`	`sendIqWithResponseCallback(IQ iqRequest, PacketListener callback)` Send a IQ stanza and invoke `callback` if there is a result of `IQ.Type.result` with that result IQ.
`void`	`sendIqWithResponseCallback(IQ iqRequest, PacketListener callback, ExceptionCallback exceptionCallback)` Send a IQ stanza and invoke `callback` if there is a result of `IQ.Type.result` with that result IQ.
`void`	`sendIqWithResponseCallback(IQ iqRequest, PacketListener callback, ExceptionCallback exceptionCallback, long timeout)` Send a IQ stanza and invoke `callback` if there is a result of `IQ.Type.result` with that result IQ.
`void`	`sendPacket(Packet packet)` Sends the specified packet to the server.
`protected abstract void`	`sendPacketInternal(Packet packet)`
`void`	`sendStanzaWithResponseCallback(Packet stanza, PacketFilter replyFilter, PacketListener callback)` Send a stanza and wait asynchronously for a response by using `replyFilter`.
`void`	`sendStanzaWithResponseCallback(Packet stanza, PacketFilter replyFilter, PacketListener callback, ExceptionCallback exceptionCallback)` Send a stanza and wait asynchronously for a response by using `replyFilter`.
`void`	`sendStanzaWithResponseCallback(Packet stanza, PacketFilter replyFilter, PacketListener callback, ExceptionCallback exceptionCallback, long timeout)` Send a stanza and wait asynchronously for a response by using `replyFilter`.
`void`	`setFromMode(XMPPConnection.FromMode fromMode)` Set the FromMode for this connection instance.
`protected void`	`setLoginInfo(java.lang.String username, java.lang.String password, java.lang.String resource)`
`void`	`setPacketReplyTimeout(long timeout)` Set the packet reply timeout in milliseconds.
`protected void`	`setServiceName(java.lang.String serviceName)`
`protected void`	`setWasAuthenticated(boolean authenticated)` Sets whether the connection has already logged in the server.
`protected abstract void`	`shutdown()` Shuts the current connection down.

Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - connectionListeners
```
protected final java.util.Set<ConnectionListener> connectionListeners
```
    A collection of ConnectionListeners which listen for connection closing and reconnection events.
  - connectionLock
```
protected final java.util.concurrent.locks.Lock connectionLock
```
  - streamFeatures
```
protected final java.util.Map<java.lang.String,PacketExtension> streamFeatures
```
  - user
```
protected java.lang.String user
```
    The full JID of the authenticated user.
  - connected
```
protected boolean connected
```
  - debugger
```
protected SmackDebugger debugger
```
    The SmackDebugger allows to log and debug XML traffic.
  - reader
```
protected java.io.Reader reader
```
    The Reader which is used for the debugger.
  - writer
```
protected java.io.Writer writer
```
    The Writer which is used for the debugger.
  - lastFeaturesReceived
```
protected final SynchronizationPoint<java.lang.Exception> lastFeaturesReceived
```
    Set to success if the last features stanza from the server has been parsed. A XMPP connection handshake can invoke multiple features stanzas, e.g. when TLS is activated a second feature stanza is send by the server. This is set to true once the last feature stanza has been parsed.
  - saslFeatureReceived
```
protected final SynchronizationPoint<SmackException> saslFeatureReceived
```
    Set to success if the sasl feature has been received.
  - saslAuthentication
```
protected SASLAuthentication saslAuthentication
```
    The SASLAuthentication manager that is responsible for authenticating with the server.
  - connectionCounterValue
```
protected final int connectionCounterValue
```
    A number to uniquely identify connections that are created. This is distinct from the connection ID, which is a value sent by the server once a connection is made.
  - config
```
protected final ConnectionConfiguration config
```
    Holds the initial configuration used while creating the connection.
  - compressionHandler
```
protected XMPPInputOutputStream compressionHandler
```
  - host
```
protected java.lang.String host
```
    The used host to establish the connection to
  - port
```
protected int port
```
    The used port to establish the connection to
  - authenticated
```
protected boolean authenticated
```
    Flag that indicates if the user is currently authenticated with the server.
  - wasAuthenticated
```
protected boolean wasAuthenticated
```
    Flag that indicates if the user was authenticated with the server when the connection to the server was closed (abruptly or not).
- Constructor Detail
  - AbstractXMPPConnection
```
protected AbstractXMPPConnection(ConnectionConfiguration configuration)
```
    Create a new XMPPConnection to a XMPP server.
    
    Parameters:
    configuration - The configuration which is used to establish the connection.
- Method Detail
  - getConnectionCreationListeners
```
protected static java.util.Collection<ConnectionCreationListener> getConnectionCreationListeners()
```
    Get the collection of listeners that are interested in connection creation events.
    
    Returns:
    a collection of listeners interested on new connections.
  - getConfiguration
```
protected ConnectionConfiguration getConfiguration()
```
  - getServiceName
```
public java.lang.String getServiceName()
```
    Description copied from interface: XMPPConnection
    
    Returns the name of the service provided by the XMPP server for this connection. This is also called XMPP domain of the connected server. After authenticating with the server the returned value may be different.
    
    Specified by:
    
    getServiceName in interface XMPPConnection
    
    Returns:
    the name of the service provided by the XMPP server.
  - getHost
```
public java.lang.String getHost()
```
    Description copied from interface: XMPPConnection
    
    Returns the host name of the server where the XMPP server is running. This would be the IP address of the server or a name that may be resolved by a DNS server.
    
    Specified by:
    
    getHost in interface XMPPConnection
    
    Returns:
    the host name of the server where the XMPP server is running or null if not yet connected.
  - getPort
```
public int getPort()
```
    Description copied from interface: XMPPConnection
    
    Returns the port number of the XMPP server for this connection. The default port for normal connections is 5222.
    
    Specified by:
    
    getPort in interface XMPPConnection
    
    Returns:
    the port number of the XMPP server or 0 if not yet connected.
  - getConnectionID
```
public abstract java.lang.String getConnectionID()
```
    Description copied from interface: XMPPConnection
    
    Returns the connection ID for this connection, which is the value set by the server when opening a XMPP stream. If the server does not set a connection ID, this value will be null. This value will be null if not connected to the server.
    
    Specified by:
    
    getConnectionID in interface XMPPConnection
    
    Returns:
    the ID of this connection returned from the XMPP server or null if not connected to the server.
  - isSecureConnection
```
public abstract 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
    
    Returns:
    true if a secure connection to the server.
  - sendPacketInternal
```
protected abstract void sendPacketInternal(Packet packet)
                                    throws SmackException.NotConnectedException
```
    Throws:
    
    SmackException.NotConnectedException
  - send
```
public abstract void send(PlainStreamElement element)
                   throws SmackException.NotConnectedException
```
    Description copied from interface: XMPPConnection
    
    Send a PlainStreamElement.
    This method is not meant for end-user usage! It allows sending plain stream elements, which should not be done by a user manually. Doing so may result in a unstable or unusable connection. Certain Smack APIs use this method to send plain stream elements.
    
    Specified by:
    
    send in interface XMPPConnection
    
    Throws:
    
    SmackException.NotConnectedException
  - isUsingCompression
```
public abstract 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
    
    Returns:
    true if network traffic is being compressed.
  - connect
```
public void connect()
             throws SmackException,
                    java.io.IOException,
                    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 connection to the server.
    Listeners will be preserved from a previous connection.
    
    Throws:
    
    XMPPException - if an error occurs on the XMPP protocol level.
    
    SmackException - if an error occurs somewhere else besides XMPP protocol level.
    
    java.io.IOException
    
    SmackException.ConnectionException - with detailed information about the failed connection.
  - connectInternal
```
protected abstract void connectInternal()
                                 throws SmackException,
                                        java.io.IOException,
                                        XMPPException
```
    Abstract method that concrete subclasses of XMPPConnection need to implement to perform their way of XMPP connection establishment. Implementations are required to perform an automatic login if the previous connection state was logged (authenticated).
    
    Throws:
    
    SmackException
    
    java.io.IOException
    
    XMPPException
  - login
```
public void login(java.lang.String username,
         java.lang.String password)
           throws XMPPException,
                  SmackException,
                  java.io.IOException
```
    Logs in to the server using the strongest authentication mode supported by the server, then sets presence to available. If the server supports SASL authentication then the user will be authenticated using SASL if not Non-SASL authentication will be tried. If more than five seconds (default timeout) elapses in each step of the authentication process without a response from the server, or if an error occurs, a XMPPException will be thrown.
    Before logging in (i.e. authenticate) to the server the connection must be connected. It is possible to log in without sending an initial available presence by using ConnectionConfiguration.setSendPresence(boolean). If this connection is not interested in loading its roster upon login then use ConnectionConfiguration.setRosterLoadedAtLogin(boolean). Finally, if you want to not pass a password and instead use a more advanced mechanism while using SASL then you may be interested in using ConnectionConfiguration.setCallbackHandler(javax.security.auth.callback.CallbackHandler). For more advanced login settings see ConnectionConfiguration.
    
    Parameters:
    username - the username.
    password - the password or null if using a CallbackHandler.
    
    Throws:
    
    XMPPException - if an error occurs on the XMPP protocol level.
    
    SmackException - if an error occurs somehwere else besides XMPP protocol level.
    
    java.io.IOException
  - login
```
public abstract void login(java.lang.String username,
         java.lang.String password,
         java.lang.String resource)
                    throws XMPPException,
                           SmackException,
                           java.io.IOException
```
    Logs in to the server using the strongest authentication mode supported by the server, then sets presence to available. If the server supports SASL authentication then the user will be authenticated using SASL if not Non-SASL authentication will be tried. If more than five seconds (default timeout) elapses in each step of the authentication process without a response from the server, or if an error occurs, a XMPPException will be thrown.
    Before logging in (i.e. authenticate) to the server the connection must be connected. It is possible to log in without sending an initial available presence by using ConnectionConfiguration.setSendPresence(boolean). If this connection is not interested in loading its roster upon login then use ConnectionConfiguration.setRosterLoadedAtLogin(boolean). Finally, if you want to not pass a password and instead use a more advanced mechanism while using SASL then you may be interested in using ConnectionConfiguration.setCallbackHandler(javax.security.auth.callback.CallbackHandler). For more advanced login settings see ConnectionConfiguration.
    
    Parameters:
    username - the username.
    password - the password or null if using a CallbackHandler.
    resource - the resource.
    
    Throws:
    
    XMPPException - if an error occurs on the XMPP protocol level.
    
    SmackException - if an error occurs somehwere else besides XMPP protocol level.
    
    java.io.IOException
  - loginAnonymously
```
public abstract void loginAnonymously()
                               throws XMPPException,
                                      SmackException,
                                      java.io.IOException
```
    Logs in to the server anonymously. Very few servers are configured to support anonymous authentication, so it's fairly likely logging in anonymously will fail. If anonymous login does succeed, your XMPP address will likely be in the form "123ABC@server/789XYZ" or "server/123ABC" (where "123ABC" and "789XYZ" is a random value generated by the server).
    
    Throws:
    
    XMPPException - if an error occurs on the XMPP protocol level.
    
    SmackException - if an error occurs somehwere else besides XMPP protocol level.
    
    java.io.IOException
  - isConnected
```
public final boolean isConnected()
```
    Description copied from interface: XMPPConnection
    
    Returns true if currently connected to the XMPP server.
    
    Specified by:
    
    isConnected in interface XMPPConnection
    
    Returns:
    true if connected.
  - isAuthenticated
```
public final boolean isAuthenticated()
```
    Description copied from interface: XMPPConnection
    
    Returns true if currently authenticated by successfully calling the login method.
    
    Specified by:
    
    isAuthenticated in interface XMPPConnection
    
    Returns:
    true if authenticated.
  - getUser
```
public final java.lang.String getUser()
```
    Description copied from interface: XMPPConnection
    
    Returns the full XMPP address of the user that is logged in to the connection or null if not logged in yet. An XMPP address is in the form username@server/resource.
    
    Specified by:
    
    getUser in interface XMPPConnection
    
    Returns:
    the full XMPP address of the user logged in.
  - bindResourceAndEstablishSession
```
protected void bindResourceAndEstablishSession(java.lang.String resource)
                                        throws XMPPException.XMPPErrorException,
                                               java.io.IOException,
                                               SmackException
```
    Throws:
    
    XMPPException.XMPPErrorException
    
    java.io.IOException
    
    SmackException
  - afterSuccessfulLogin
```
protected void afterSuccessfulLogin(boolean anonymous,
                        boolean resumed)
                             throws SmackException.NotConnectedException
```
    Throws:
    
    SmackException.NotConnectedException
  - isAnonymous
```
public boolean isAnonymous()
```
    Description copied from interface: XMPPConnection
    
    Returns true if currently authenticated anonymously.
    
    Specified by:
    
    isAnonymous in interface XMPPConnection
    
    Returns:
    true if authenticated anonymously.
  - setServiceName
```
protected void setServiceName(java.lang.String serviceName)
```
  - setLoginInfo
```
protected void setLoginInfo(java.lang.String username,
                java.lang.String password,
                java.lang.String resource)
```
  - maybeResolveDns
```
protected void maybeResolveDns()
                        throws java.lang.Exception
```
    Throws:
    
    java.lang.Exception
  - getConnectionLock
```
protected java.util.concurrent.locks.Lock getConnectionLock()
```
  - sendPacket
```
public void sendPacket(Packet packet)
                throws SmackException.NotConnectedException
```
    Description copied from interface: XMPPConnection
    
    Sends the specified packet to the server.
    
    Specified by:
    
    sendPacket in interface XMPPConnection
    
    Parameters:
    packet - the packet to send.
    
    Throws:
    
    SmackException.NotConnectedException
  - getRoster
```
public Roster getRoster()
```
    Description copied from interface: XMPPConnection
    
    Returns the roster for the user.
    This method will never return null, instead if the user has not yet logged into the server or is logged in anonymously all modifying methods of the returned roster object like Roster.createEntry(String, String, String[]), Roster.removeEntry(RosterEntry) , etc. except adding or removing RosterListeners will throw an IllegalStateException.
    
    Specified by:
    
    getRoster in interface XMPPConnection
    
    Returns:
    the user's roster.
  - getSASLAuthentication
```
protected SASLAuthentication getSASLAuthentication()
```
    Returns the SASLAuthentication manager that is responsible for authenticating with the server.
    
    Returns:
    the SASLAuthentication manager that is responsible for authenticating with the server.
  - disconnect
```
public void disconnect()
                throws SmackException.NotConnectedException
```
    Closes the connection by setting presence to unavailable then closing the connection to the XMPP server. The XMPPConnection can still be used for connecting to the server again.
    
    Throws:
    
    SmackException.NotConnectedException
  - disconnect
```
public void disconnect(Presence unavailablePresence)
                throws SmackException.NotConnectedException
```
    Closes the connection. A custom unavailable presence is sent to the server, followed by closing the stream. The XMPPConnection can still be used for connecting to the server again. A custom unavailable presence is useful for communicating offline presence information such as "On vacation". Typically, just the status text of the presence packet is set with online information, but most XMPP servers will deliver the full presence packet with whatever data is set.
    
    Parameters:
    unavailablePresence - the presence packet to send during shutdown.
    
    Throws:
    
    SmackException.NotConnectedException
  - shutdown
```
protected abstract void shutdown()
```
    Shuts the current connection down.
  - addConnectionListener
```
public void addConnectionListener(ConnectionListener connectionListener)
```
    Description copied from interface: XMPPConnection
    
    Adds a connection listener to this connection that will be notified when the connection closes or fails.
    
    Specified by:
    
    addConnectionListener in interface XMPPConnection
    
    Parameters:
    connectionListener - a connection listener.
  - removeConnectionListener
```
public void removeConnectionListener(ConnectionListener connectionListener)
```
    Description copied from interface: XMPPConnection
    
    Removes a connection listener from this connection.
    
    Specified by:
    
    removeConnectionListener in interface XMPPConnection
    
    Parameters:
    connectionListener - a connection listener.
  - getConnectionListeners
```
protected java.util.Collection<ConnectionListener> getConnectionListeners()
```
    Get the collection of listeners that are interested in connection events.
    
    Returns:
    a collection of listeners interested on connection events.
  - createPacketCollectorAndSend
```
public PacketCollector createPacketCollectorAndSend(IQ packet)
                                             throws SmackException.NotConnectedException
```
    Description copied from interface: XMPPConnection
    
    Creates a new packet collector collecting packets that are replies to packet. Does also send packet. The packet filter for the collector is an IQReplyFilter, guaranteeing that packet id and JID in the 'from' address have expected values.
    
    Specified by:
    
    createPacketCollectorAndSend in interface XMPPConnection
    
    Parameters:
    packet - the packet to filter responses from
    
    Returns:
    a new packet collector.
    
    Throws:
    
    SmackException.NotConnectedException
  - createPacketCollectorAndSend
```
public PacketCollector createPacketCollectorAndSend(PacketFilter packetFilter,
                                           Packet packet)
                                             throws SmackException.NotConnectedException
```
    Description copied from interface: XMPPConnection
    
    Creates a new packet collector for this connection. A packet filter determines which packets will be accumulated by the collector. A PacketCollector is more suitable to use than a PacketListener when you need to wait for a specific result.
    
    Specified by:
    
    createPacketCollectorAndSend in interface XMPPConnection
    
    Parameters:
    packetFilter - the packet filter to use.
    packet - the packet to send right after the collector got created
    
    Returns:
    a new packet collector.
    
    Throws:
    
    SmackException.NotConnectedException
  - createPacketCollector
```
public PacketCollector createPacketCollector(PacketFilter packetFilter)
```
    Description copied from interface: XMPPConnection
    
    Creates a new packet collector for this connection. A packet filter determines which packets will be accumulated by the collector. A PacketCollector is more suitable to use than a PacketListener when you need to wait for a specific result.
    Note: If you send a Packet right after using this method, then consider using XMPPConnection.createPacketCollectorAndSend(PacketFilter, Packet) instead. Otherwise make sure cancel the PacketCollector in every case, e.g. even if an exception is thrown, or otherwise you may leak the PacketCollector.
    
    Specified by:
    
    createPacketCollector in interface XMPPConnection
    
    Parameters:
    packetFilter - the packet filter to use.
    
    Returns:
    a new packet collector.
  - removePacketCollector
```
public void removePacketCollector(PacketCollector collector)
```
    Description copied from interface: XMPPConnection
    
    Remove a packet collector of this connection.
    
    Specified by:
    
    removePacketCollector in interface XMPPConnection
    
    Parameters:
    collector - a packet collectors which was created for this connection.
  - addPacketListener
```
public void addPacketListener(PacketListener packetListener,
                     PacketFilter packetFilter)
```
    Description copied from interface: XMPPConnection
    
    Registers a packet listener with this connection. A packet listener will be invoked only when an incoming packet is received. A packet filter determines which packets will be delivered to the listener. If the same packet listener is added again with a different filter, only the new filter will be used. NOTE: If you want get a similar callback for outgoing packets, see XMPPConnection.addPacketInterceptor(PacketListener, PacketFilter).
    
    Specified by:
    
    addPacketListener in interface XMPPConnection
    
    Parameters:
    packetListener - the packet listener to notify of new received packets.
    packetFilter - the packet filter to use.
  - removePacketListener
```
public boolean removePacketListener(PacketListener packetListener)
```
    Description copied from interface: XMPPConnection
    
    Removes a packet listener for received packets from this connection.
    
    Specified by:
    
    removePacketListener in interface XMPPConnection
    
    Parameters:
    packetListener - the packet listener to remove.
    
    Returns:
    true if the packet listener was removed
  - addPacketSendingListener
```
public void addPacketSendingListener(PacketListener packetListener,
                            PacketFilter packetFilter)
```
    Description copied from interface: XMPPConnection
    
    Registers a packet listener with this connection. The listener will be notified of every packet that this connection sends. A packet filter determines which packets will be delivered to the listener. Note that the thread that writes packets will be used to invoke the listeners. Therefore, each packet listener should complete all operations quickly or use a different thread for processing.
    
    Specified by:
    
    addPacketSendingListener in interface XMPPConnection
    
    Parameters:
    packetListener - the packet listener to notify of sent packets.
    packetFilter - the packet filter to use.
  - removePacketSendingListener
```
public void removePacketSendingListener(PacketListener packetListener)
```
    Description copied from interface: XMPPConnection
    
    Removes a packet listener for sending packets from this connection.
    
    Specified by:
    
    removePacketSendingListener in interface XMPPConnection
    
    Parameters:
    packetListener - the packet listener to remove.
  - firePacketSendingListeners
```
protected void firePacketSendingListeners(Packet packet)
```
    Process all packet listeners for sending packets.
    Compared to firePacketInterceptors(Packet), the listeners will be invoked in a new thread.
    
    Parameters:
    packet - the packet to process.
  - addPacketInterceptor
```
public void addPacketInterceptor(PacketListener packetInterceptor,
                        PacketFilter packetFilter)
```
    Description copied from interface: XMPPConnection
    
    Registers a packet interceptor with this connection. The interceptor will be invoked every time a packet is about to be sent by this connection. Interceptors may modify the packet to be sent. A packet filter determines which packets will be delivered to the interceptor.
    NOTE: For a similar functionality on incoming packets, see XMPPConnection.addPacketListener(PacketListener, PacketFilter).
    
    Specified by:
    
    addPacketInterceptor in interface XMPPConnection
    
    Parameters:
    packetInterceptor - the packet interceptor to notify of packets about to be sent.
    packetFilter - the packet filter to use.
  - removePacketInterceptor
```
public void removePacketInterceptor(PacketListener packetInterceptor)
```
    Description copied from interface: XMPPConnection
    
    Removes a packet interceptor.
    
    Specified by:
    
    removePacketInterceptor in interface XMPPConnection
    
    Parameters:
    packetInterceptor - the packet interceptor to remove.
  - initDebugger
```
protected void initDebugger()
```
    Initialize the debugger. You can specify a customized SmackDebugger by setup the system property smack.debuggerClass to the implementation.
    
    Throws:
    
    java.lang.IllegalStateException - if the reader or writer isn't yet initialized.
    
    java.lang.IllegalArgumentException - if the SmackDebugger can't be loaded.
  - getPacketReplyTimeout
```
public long getPacketReplyTimeout()
```
    Description copied from interface: XMPPConnection
    
    Returns the current value of the reply timeout in milliseconds for request for this XMPPConnection instance.
    
    Specified by:
    
    getPacketReplyTimeout in interface XMPPConnection
    
    Returns:
    the packet reply timeout in milliseconds
  - setPacketReplyTimeout
```
public void setPacketReplyTimeout(long timeout)
```
    Description copied from interface: XMPPConnection
    
    Set the packet reply timeout in milliseconds. In most cases, Smack will throw a SmackException.NoResponseException if no reply to a request was received within the timeout period.
    
    Specified by:
    
    setPacketReplyTimeout in interface XMPPConnection
    
    Parameters:
    timeout - the packet reply timeout in milliseconds
  - processPacket
```
protected void processPacket(Packet packet)
```
    Processes a packet after it's been fully parsed by looping through the installed packet collectors and listeners and letting them examine the packet to see if they are a match with the filter.
    
    Parameters:
    packet - the packet to process.
  - invokePacketCollectorsAndNotifyRecvListeners
```
protected void invokePacketCollectorsAndNotifyRecvListeners(Packet packet)
```
    Invoke PacketCollector.processPacket(Packet) for every PacketCollector with the given packet. Also notify the receive listeners with a matching packet filter about the packet.
    
    Parameters:
    packet - the packet to notify the PacketCollectors and receive listeners about.
  - setWasAuthenticated
```
protected void setWasAuthenticated(boolean authenticated)
```
    Sets whether the connection has already logged in the server. This method assures that the wasAuthenticated flag is never reset once it has ever been set.
    
    Parameters:
    authenticated - true if the connection has already been authenticated.
  - callConnectionConnectedListener
```
protected void callConnectionConnectedListener()
```
  - callConnectionAuthenticatedListener
```
protected void callConnectionAuthenticatedListener()
```
  - callConnectionClosedOnErrorListener
```
protected void callConnectionClosedOnErrorListener(java.lang.Exception e)
```
  - getConnectionCounter
```
public int getConnectionCounter()
```
    Description copied from interface: XMPPConnection
    
    Get the connection counter of this XMPPConnection instance. Those can be used as ID to identify the connection, but beware that the ID may not be unique if you create more then 2*Integer.MAX_VALUE instances as the counter could wrap.
    
    Specified by:
    
    getConnectionCounter in interface XMPPConnection
    
    Returns:
    the connection counter of this XMPPConnection
  - setFromMode
```
public void setFromMode(XMPPConnection.FromMode fromMode)
```
    Description copied from interface: XMPPConnection
    
    Set the FromMode for this connection instance. Defines how the 'from' attribute of outgoing stanzas should be populated by Smack.
    
    Specified by:
    
    setFromMode in interface XMPPConnection
  - getFromMode
```
public XMPPConnection.FromMode getFromMode()
```
    Description copied from interface: XMPPConnection
    
    Get the currently active FromMode.
    
    Specified by:
    
    getFromMode in interface XMPPConnection
    
    Returns:
    the currently active XMPPConnection.FromMode
  - finalize
```
protected void finalize()
                 throws java.lang.Throwable
```
    Overrides:
    
    finalize in class java.lang.Object
    
    Throws:
    
    java.lang.Throwable
  - getRosterStore
```
public RosterStore getRosterStore()
```
    Description copied from interface: XMPPConnection
    
    Get the permanent roster store.
    
    Specified by:
    
    getRosterStore in interface XMPPConnection
    
    Returns:
    the permanent roster store or null
  - isRosterLoadedAtLogin
```
public boolean isRosterLoadedAtLogin()
```
    Description copied from interface: XMPPConnection
    
    Returns true if the roster will be loaded from the server when logging in. This is the common behavior for clients but sometimes clients may want to differ this or just never do it if not interested in rosters.
    
    Specified by:
    
    isRosterLoadedAtLogin in interface XMPPConnection
    
    Returns:
    true if the roster will be loaded from the server when logging in.
    See Also:
    RFC 6121 2.2 - Retrieving the Roster on Login
  - parseFeatures
```
protected final void parseFeatures(org.xmlpull.v1.XmlPullParser parser)
                            throws org.xmlpull.v1.XmlPullParserException,
                                   java.io.IOException,
                                   SmackException
```
    Throws:
    
    org.xmlpull.v1.XmlPullParserException
    
    java.io.IOException
    
    SmackException
  - afterFeaturesReceived
```
protected void afterFeaturesReceived()
                              throws SmackException.SecurityRequiredException,
                                     SmackException.NotConnectedException
```
    Throws:
    
    SmackException.SecurityRequiredException
    
    SmackException.NotConnectedException
  - getFeature
```
public <F extends PacketExtension> F getFeature(java.lang.String element,
                                       java.lang.String namespace)
```
    Description copied from interface: XMPPConnection
    
    Get the feature packet extensions for a given stream feature of the server, or null if the server doesn't support that feature.
    
    Specified by:
    
    getFeature in interface XMPPConnection
    
    Returns:
    a packet extensions of the feature or null
  - hasFeature
```
public boolean hasFeature(java.lang.String element,
                 java.lang.String namespace)
```
    Description copied from interface: XMPPConnection
    
    Return true if the server supports the given stream feature.
    
    Specified by:
    
    hasFeature in interface XMPPConnection
    
    Returns:
    true if the server supports the stream feature.
  - sendStanzaWithResponseCallback
```
public void sendStanzaWithResponseCallback(Packet stanza,
                                  PacketFilter replyFilter,
                                  PacketListener callback)
                                    throws SmackException.NotConnectedException
```
    Description copied from interface: XMPPConnection
    
    Send a stanza and wait asynchronously for a response by using replyFilter.
    If there is a response, then callback will be invoked. The callback will be invoked at most once and it will be not invoked after the connections default reply timeout has been elapsed.
    
    Specified by:
    
    sendStanzaWithResponseCallback in interface XMPPConnection
    
    Parameters:
    stanza - the stanza to send (required)
    replyFilter - the filter used to determine response stanza (required)
    callback - the callback invoked if there is a response (required)
    
    Throws:
    
    SmackException.NotConnectedException
  - sendStanzaWithResponseCallback
```
public void sendStanzaWithResponseCallback(Packet stanza,
                                  PacketFilter replyFilter,
                                  PacketListener callback,
                                  ExceptionCallback exceptionCallback)
                                    throws SmackException.NotConnectedException
```
    Description copied from interface: XMPPConnection
    
    Send a stanza and wait asynchronously for a response by using replyFilter.
    If there is a response, then callback will be invoked. If there is no response after the connections default reply timeout, then exceptionCallback will be invoked with a SmackException.NoResponseException. The callback will be invoked at most once.
    
    Specified by:
    
    sendStanzaWithResponseCallback in interface XMPPConnection
    
    Parameters:
    stanza - the stanza to send (required)
    replyFilter - the filter used to determine response stanza (required)
    callback - the callback invoked if there is a response (required)
    exceptionCallback - the callback invoked if there is an exception (optional)
    
    Throws:
    
    SmackException.NotConnectedException
  - sendStanzaWithResponseCallback
```
public void sendStanzaWithResponseCallback(Packet stanza,
                                  PacketFilter replyFilter,
                                  PacketListener callback,
                                  ExceptionCallback exceptionCallback,
                                  long timeout)
                                    throws SmackException.NotConnectedException
```
    Description copied from interface: XMPPConnection
    
    Send a stanza and wait asynchronously for a response by using replyFilter.
    If there is a response, then callback will be invoked. If there is no response after timeout milliseconds, then exceptionCallback will be invoked with a SmackException.NoResponseException. The callback will be invoked at most once.
    
    Specified by:
    
    sendStanzaWithResponseCallback in interface XMPPConnection
    
    Parameters:
    stanza - the stanza to send (required)
    replyFilter - the filter used to determine response stanza (required)
    callback - the callback invoked if there is a response (required)
    exceptionCallback - the callback invoked if there is an exception (optional)
    timeout - the timeout in milliseconds to wait for a response
    
    Throws:
    
    SmackException.NotConnectedException
  - sendIqWithResponseCallback
```
public void sendIqWithResponseCallback(IQ iqRequest,
                              PacketListener callback)
                                throws SmackException.NotConnectedException
```
    Description copied from interface: XMPPConnection
    
    Send a IQ stanza and invoke callback if there is a result of IQ.Type.result with that result IQ. The callback will not be invoked after the connections default reply timeout has been elapsed.
    
    Specified by:
    
    sendIqWithResponseCallback in interface XMPPConnection
    
    Parameters:
    iqRequest - the IQ stanza to send (required)
    callback - the callback invoked if there is result response (required)
    
    Throws:
    
    SmackException.NotConnectedException
  - sendIqWithResponseCallback
```
public void sendIqWithResponseCallback(IQ iqRequest,
                              PacketListener callback,
                              ExceptionCallback exceptionCallback)
                                throws SmackException.NotConnectedException
```
    Description copied from interface: XMPPConnection
    
    Send a IQ stanza and invoke callback if there is a result of IQ.Type.result with that result IQ. If there is an error response exceptionCallback will be invoked, if not null, with the received error as XMPPException.XMPPErrorException. If there is no response after the connections default reply timeout, then exceptionCallback will be invoked with a SmackException.NoResponseException.
    
    Specified by:
    
    sendIqWithResponseCallback in interface XMPPConnection
    
    Parameters:
    iqRequest - the IQ stanza to send (required)
    callback - the callback invoked if there is result response (required)
    exceptionCallback - the callback invoked if there is an Exception optional
    
    Throws:
    
    SmackException.NotConnectedException
  - sendIqWithResponseCallback
```
public void sendIqWithResponseCallback(IQ iqRequest,
                              PacketListener callback,
                              ExceptionCallback exceptionCallback,
                              long timeout)
                                throws SmackException.NotConnectedException
```
    Description copied from interface: XMPPConnection
    
    Send a IQ stanza and invoke callback if there is a result of IQ.Type.result with that result IQ. If there is an error response exceptionCallback will be invoked, if not null, with the received error as XMPPException.XMPPErrorException. If there is no response after timeout, then exceptionCallback will be invoked with a SmackException.NoResponseException.
    
    Specified by:
    
    sendIqWithResponseCallback in interface XMPPConnection
    
    Parameters:
    iqRequest - the IQ stanza to send (required)
    callback - the callback invoked if there is result response (required)
    exceptionCallback - the callback invoked if there is an Exception optional
    timeout - the timeout in milliseconds to wait for a response
    
    Throws:
    
    SmackException.NotConnectedException
  - getLastStanzaReceived
```
public long getLastStanzaReceived()
```
    Description copied from interface: XMPPConnection
    
    Returns the timestamp in milliseconds when the last stanza was received.
    
    Specified by:
    
    getLastStanzaReceived in interface XMPPConnection
    
    Returns:
    the timestamp in milliseconds
  - reportStanzaReceived
```
protected void reportStanzaReceived()
```

Class AbstractXMPPConnection

Nested Class Summary

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

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

connectionListeners

connectionLock

streamFeatures

user

connected

debugger

reader

writer

lastFeaturesReceived

saslFeatureReceived

saslAuthentication

connectionCounterValue

config

compressionHandler

host

port

authenticated

wasAuthenticated

Constructor Detail

AbstractXMPPConnection

Method Detail

getConnectionCreationListeners

getConfiguration

getServiceName

getHost

getPort

getConnectionID

isSecureConnection

sendPacketInternal

send

isUsingCompression

connect

connectInternal

login

login

loginAnonymously

isConnected

isAuthenticated

getUser

bindResourceAndEstablishSession

afterSuccessfulLogin

isAnonymous

setServiceName

setLoginInfo

maybeResolveDns

getConnectionLock

sendPacket

getRoster

getSASLAuthentication

disconnect

disconnect

shutdown

addConnectionListener

removeConnectionListener

getConnectionListeners

createPacketCollectorAndSend

createPacketCollectorAndSend

createPacketCollector

removePacketCollector

addPacketListener

removePacketListener

addPacketSendingListener

removePacketSendingListener

firePacketSendingListeners

addPacketInterceptor

removePacketInterceptor

initDebugger

getPacketReplyTimeout

setPacketReplyTimeout

processPacket

invokePacketCollectorsAndNotifyRecvListeners

setWasAuthenticated