XMPPTCPConnection (smack_clone 4.0.7 API)

java.lang.Object
- org.jivesoftware.smack.XMPPConnection
- - org.jivesoftware.smack.tcp.XMPPTCPConnection

```
public class XMPPTCPConnection
extends XMPPConnection
```
Creates a socket connection to a XMPP server. This is the default connection to a Jabber server and is specified in the XMPP Core (RFC 3920).

See Also:
XMPPConnection

Nested Class Summary
- Nested classes/interfaces inherited from class org.jivesoftware.smack.XMPPConnection
  XMPPConnection.FromMode, XMPPConnection.InterceptorWrapper, XMPPConnection.ListenerWrapper

Field Summary
- Fields inherited from class org.jivesoftware.smack.XMPPConnection
  authenticated, collectors, compressionHandler, config, connectionCounterValue, connectionListeners, debugger, interceptors, reader, recvListeners, saslAuthentication, sendListeners, wasAuthenticated, writer

Constructor Summary

Constructors
Constructor and Description
`XMPPTCPConnection(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(ConnectionConfiguration config, CallbackHandler callbackHandler)` Creates a new XMPP connection using the specified connection configuration.
`XMPPTCPConnection(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(String serviceName, CallbackHandler callbackHandler)` Creates a new connection to the specified XMPP server.

Method Summary

Methods
Modifier and Type	Method and Description
`protected void`	`connectInternal()` Establishes a connection to the XMPP server and performs an automatic login only if the previous connection state was logged (authenticated).
`protected ConnectionConfiguration`	`getConfiguration()` Returns the configuration used to connect to the server.
`String`	`getConnectionID()` Returns the connection ID for this connection, which is the value set by the server when opening a XMPP stream.
`ParsingExceptionCallback`	`getParsingExceptionCallback()` Get the current active parsing exception callback.
`protected Reader`	`getReader()`
`protected SASLAuthentication`	`getSASLAuthentication()` Returns the SASLAuthentication manager that is responsible for authenticating with the server.
`String`	`getUser()` Returns the full XMPP address of the user that is logged in to the connection or `null` if not logged in yet.
`protected Writer`	`getWriter()`
`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`	`isSecureConnection()` Returns true if the connection to the server has successfully negotiated encryption.
`boolean`	`isSocketClosed()`
`boolean`	`isUsingCompression()` Returns true if network traffic is being compressed.
`boolean`	`isUsingTLS()` Returns true if the connection to the server has successfully negotiated TLS.
`void`	`login(String username, String password, String resource)` Logs in to the server using the strongest authentication mode supported by the server, then sets presence to available.
`void`	`loginAnonymously()` Logs in to the server anonymously.
`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.
`protected void`	`sendPacketInternal(Packet packet)`
`protected void`	`serverRequiresBinding()` Notification message saying that the server requires the client to bind a resource to the stream.
`protected void`	`serverSupportsAccountCreation()`
`protected void`	`serverSupportsSession()` Notification message saying that the server supports sessions.
`void`	`setParsingExceptionCallback(ParsingExceptionCallback callback)` Install a parsing exception callback, which will be invoked once an exception is encountered while parsing a stanza
`protected void`	`setRosterVersioningSupported()` Indicates that the server supports roster versioning as defined in XEP-0237.
`protected void`	`setServiceCapsNode(String node)` Set the servers Entity Caps node XMPPConnection holds this information in order to avoid a dependency to smackx where EntityCapsManager lives from smack.
`protected void`	`setServiceName(String serviceName)`
`protected void`	`shutdown()` Shuts the current connection down.
`protected void`	`throwConnectionExceptionOrNoResponse()`

Methods inherited from class org.jivesoftware.smack.XMPPConnection
addConnectionCreationListener, addConnectionListener, addPacketInterceptor, addPacketListener, addPacketSendingListener, bindResourceAndEstablishSession, callConnectionAuthenticatedListener, callConnectionClosedOnErrorListener, callConnectionConnectedListener, connect, createPacketCollector, createPacketCollectorAndSend, disconnect, disconnect, finalize, getConnectionCounter, getConnectionCreationListeners, getConnectionListeners, getFromMode, getHost, getPacketCollectors, getPacketInterceptors, getPacketListeners, getPacketReplyTimeout, getPacketSendingListeners, getPort, getRoster, getServiceCapsNode, getServiceName, initDebugger, isRosterVersioningSupported, login, maybeResolveDns, removeConnectionCreationListener, removeConnectionListener, removePacketCollector, removePacketInterceptor, removePacketListener, removePacketSendingListener, schedule, sendPacket, setConnectionException, setFromMode, setLoginInfo, setPacketReplyTimeout, setWasAuthenticated

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

- Constructor Detail
  - XMPPTCPConnection
```
public XMPPTCPConnection(String serviceName,
                 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 XMPPConnection.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(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(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(ConnectionConfiguration config,
                 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 XMPPConnection.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 String getConnectionID()
```
    Description copied from class: 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 class XMPPConnection
    
    Returns:
    the ID of this connection returned from the XMPP server or null if not connected to the server.
  - getUser
```
public String getUser()
```
    Description copied from class: 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 class XMPPConnection
    
    Returns:
    the full XMPP address of the user logged in.
  - setParsingExceptionCallback
```
public void setParsingExceptionCallback(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 ParsingExceptionCallback getParsingExceptionCallback()
```
    Get the current active parsing exception callback.
    
    Returns:
    the active exception callback or null if there is none
  - login
```
public void login(String username,
         String password,
         String resource)
           throws XMPPException,
                  SmackException,
                  SaslException,
                  IOException
```
    Description copied from class: XMPPConnection
    
    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.
    
    Specified by:
    
    login in class XMPPConnection
    
    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.
    
    SaslException
    
    IOException
  - loginAnonymously
```
public void loginAnonymously()
                      throws XMPPException,
                             SmackException,
                             SaslException,
                             IOException
```
    Description copied from class: XMPPConnection
    
    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).
    
    Specified by:
    
    loginAnonymously in class XMPPConnection
    
    Throws:
    
    XMPPException - if an error occurs on the XMPP protocol level.
    
    SmackException - if an error occurs somehwere else besides XMPP protocol level.
    
    SaslException
    
    IOException
  - isConnected
```
public boolean isConnected()
```
    Description copied from class: XMPPConnection
    
    Returns true if currently connected to the XMPP server.
    
    Specified by:
    
    isConnected in class XMPPConnection
    
    Returns:
    true if connected.
  - isSecureConnection
```
public boolean isSecureConnection()
```
    Description copied from class: XMPPConnection
    
    Returns true if the connection to the server has successfully negotiated encryption.
    
    Specified by:
    
    isSecureConnection in class XMPPConnection
    
    Returns:
    true if a secure connection to the server.
  - isSocketClosed
```
public boolean isSocketClosed()
```
  - isAuthenticated
```
public boolean isAuthenticated()
```
    Description copied from class: XMPPConnection
    
    Returns true if currently authenticated by successfully calling the login method.
    
    Specified by:
    
    isAuthenticated in class XMPPConnection
    
    Returns:
    true if authenticated.
  - isAnonymous
```
public boolean isAnonymous()
```
    Description copied from class: XMPPConnection
    
    Returns true if currently authenticated anonymously.
    
    Specified by:
    
    isAnonymous in class XMPPConnection
    
    Returns:
    true if authenticated anonymously.
  - 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 XMPPConnection
  - sendPacketInternal
```
protected void sendPacketInternal(Packet packet)
                           throws SmackException.NotConnectedException
```
    Specified by:
    
    sendPacketInternal in class XMPPConnection
    
    Throws:
    
    SmackException.NotConnectedException
  - isUsingTLS
```
public boolean isUsingTLS()
```
    Returns true if the connection to the server has successfully negotiated TLS. Once TLS has been negotiatied the connection has been secured.
    
    Returns:
    true if the connection to the server has successfully negotiated TLS.
  - isUsingCompression
```
public boolean isUsingCompression()
```
    Description copied from class: 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 class XMPPConnection
    
    Returns:
    true if network traffic is being compressed.
  - connectInternal
```
protected void connectInternal()
                        throws SmackException,
                               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 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 XMPPConnection
    
    Throws:
    
    XMPPException - if an error occurs while trying to establish the connection.
    
    SmackException
    
    IOException
  - processPacket
```
protected void processPacket(Packet packet)
```
    Description copied from class: XMPPConnection
    
    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.
    
    Overrides:
    
    processPacket in class XMPPConnection
    
    Parameters:
    packet - the packet to process.
  - getReader
```
protected Reader getReader()
```
    Overrides:
    
    getReader in class XMPPConnection
  - getWriter
```
protected Writer getWriter()
```
    Overrides:
    
    getWriter in class XMPPConnection
  - throwConnectionExceptionOrNoResponse
```
protected void throwConnectionExceptionOrNoResponse()
                                             throws IOException,
                                                    SmackException.NoResponseException
```
    Overrides:
    
    throwConnectionExceptionOrNoResponse in class XMPPConnection
    
    Throws:
    
    IOException
    
    SmackException.NoResponseException
  - setServiceName
```
protected void setServiceName(String serviceName)
```
    Overrides:
    
    setServiceName in class XMPPConnection
  - serverRequiresBinding
```
protected void serverRequiresBinding()
```
    Description copied from class: XMPPConnection
    
    Notification message saying that the server requires the client to bind a resource to the stream.
    
    Overrides:
    
    serverRequiresBinding in class XMPPConnection
  - setServiceCapsNode
```
protected void setServiceCapsNode(String node)
```
    Description copied from class: XMPPConnection
    
    Set the servers Entity Caps node XMPPConnection holds this information in order to avoid a dependency to smackx where EntityCapsManager lives from smack.
    
    Overrides:
    
    setServiceCapsNode in class XMPPConnection
  - serverSupportsSession
```
protected void serverSupportsSession()
```
    Description copied from class: XMPPConnection
    
    Notification message saying that the server supports sessions. When a server supports sessions the client needs to send a Session packet after successfully binding a resource for the session.
    
    Overrides:
    
    serverSupportsSession in class XMPPConnection
  - setRosterVersioningSupported
```
protected void setRosterVersioningSupported()
```
    Description copied from class: XMPPConnection
    
    Indicates that the server supports roster versioning as defined in XEP-0237.
    
    Overrides:
    
    setRosterVersioningSupported in class XMPPConnection
  - serverSupportsAccountCreation
```
protected void serverSupportsAccountCreation()
```
    Overrides:
    
    serverSupportsAccountCreation in class XMPPConnection
  - getSASLAuthentication
```
protected SASLAuthentication getSASLAuthentication()
```
    Description copied from class: XMPPConnection
    
    Returns the SASLAuthentication manager that is responsible for authenticating with the server.
    
    Overrides:
    
    getSASLAuthentication in class XMPPConnection
    
    Returns:
    the SASLAuthentication manager that is responsible for authenticating with the server.
  - getConfiguration
```
protected ConnectionConfiguration getConfiguration()
```
    Description copied from class: XMPPConnection
    
    Returns the configuration used to connect to the server.
    
    Overrides:
    
    getConfiguration in class XMPPConnection
    
    Returns:
    the configuration used to connect to the server.

Class XMPPTCPConnection

Nested Class Summary

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

Field Summary

Fields inherited from class org.jivesoftware.smack.XMPPConnection

Constructor Summary

Method Summary

Methods inherited from class org.jivesoftware.smack.XMPPConnection

Methods inherited from class java.lang.Object

Constructor Detail

XMPPTCPConnection

XMPPTCPConnection

XMPPTCPConnection

XMPPTCPConnection

Method Detail

getConnectionID

getUser

setParsingExceptionCallback

getParsingExceptionCallback

login

loginAnonymously

isConnected

isSecureConnection

isSocketClosed

isAuthenticated

isAnonymous

shutdown

sendPacketInternal

isUsingTLS

isUsingCompression

connectInternal

processPacket

getReader

getWriter

throwConnectionExceptionOrNoResponse

setServiceName

serverRequiresBinding

setServiceCapsNode

serverSupportsSession

setRosterVersioningSupported

serverSupportsAccountCreation

getSASLAuthentication

getConfiguration