org.jivesoftware.smack.bosh

Class XMPPBOSHConnection

java.lang.Object

org.jivesoftware.smack.AbstractXMPPConnection

org.jivesoftware.smack.bosh.XMPPBOSHConnection

All Implemented Interfaces:

XMPPConnection

public class XMPPBOSHConnection
extends AbstractXMPPConnection

Creates a connection to an XMPP server via HTTP binding. This is specified in the XEP-0206: XMPP Over BOSH.

Author:

Guenther Niess

See Also:

XMPPConnection

Nested Class Summary

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

AbstractXMPPConnection.InterceptorWrapper, AbstractXMPPConnection.ListenerWrapper

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

XMPPConnection.FromMode

Field Summary

Fields

Modifier and Type	Field and Description
static String	BOSH_URI The BOSH namespace from XEP-0124.
protected String	sessionID The session ID for the BOSH session with the connection manager.
static String	XMPP_BOSH_NS The XMPP Over Bosh namespace.

Fields inherited from class org.jivesoftware.smack.AbstractXMPPConnection

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

Constructor Summary

Constructors

Constructor and Description
XMPPBOSHConnection(BOSHConfiguration config) Create a HTTP Binding connection to an XMPP server.
XMPPBOSHConnection(String username, String password, boolean https, String host, int port, String filePath, String xmppDomain) Create a HTTP Binding connection to an XMPP server.

Method Summary

Modifier and Type	Method and Description
protected void	connectInternal() Abstract method that concrete subclasses of XMPPConnection need to implement to perform their way of XMPP connection establishment.
protected void	initDebugger() Initialize the SmackDebugger which allows to log and debug XML traffic.
boolean	isSecureConnection() Returns true if the connection to the server has successfully negotiated encryption.
boolean	isUsingCompression() Returns true if network traffic is being compressed.
protected void	loginAnonymously()
protected void	loginNonAnonymously(String username, String password, String resource)
protected void	notifyConnectionError(Exception e) Sends out a notification that there was an error with the connection and closes the connection.
protected void	send(org.igniterealtime.jbosh.ComposableBody body) Send a HTTP request to the connection manager with the provided body element.
void	send(PlainStreamElement element) Send a PlainStreamElement.
protected void	sendStanzaInternal(Stanza packet)
protected void	shutdown() Closes the connection by setting presence to unavailable and closing the HTTP client.

Methods inherited from class org.jivesoftware.smack.AbstractXMPPConnection

addAsyncStanzaListener, addConnectionListener, addOneTimeSyncCallback, addPacketInterceptor, addPacketListener, addPacketSendingListener, addSyncStanzaListener, afterFeaturesReceived, afterSuccessfulLogin, asyncGo, bindResourceAndEstablishSession, callConnectionAuthenticatedListener, callConnectionClosedOnErrorListener, callConnectionConnectedListener, connect, createPacketCollector, createPacketCollector, createPacketCollectorAndSend, createPacketCollectorAndSend, disconnect, disconnect, finalize, firePacketSendingListeners, getConfiguration, getConnectionCounter, getConnectionCreationListeners, getConnectionLock, getFeature, getFromMode, getHost, getLastStanzaReceived, getPacketReplyTimeout, getParsingExceptionCallback, getPort, getSASLAuthentication, getServiceName, getStreamId, getUser, hasFeature, invokePacketCollectorsAndNotifyRecvListeners, isAnonymous, isAuthenticated, isConnected, login, login, login, notifyReconnection, parseAndProcessStanza, parseFeatures, populateHostAddresses, processPacket, registerIQRequestHandler, removeAsyncStanzaListener, removeConnectionListener, removePacketCollector, removePacketInterceptor, removePacketListener, removePacketSendingListener, removeSyncStanzaListener, schedule, sendIqWithResponseCallback, sendIqWithResponseCallback, sendIqWithResponseCallback, sendPacket, sendStanza, sendStanzaWithResponseCallback, sendStanzaWithResponseCallback, sendStanzaWithResponseCallback, setFromMode, setPacketReplyTimeout, setParsingExceptionCallback, setReplyToUnknownIq, setReplyToUnknownIqDefault, setWasAuthenticated, throwAlreadyConnectedExceptionIfAppropriate, throwAlreadyLoggedInExceptionIfAppropriate, throwNotConnectedExceptionIfAppropriate, throwNotConnectedExceptionIfAppropriate, unregisterIQRequestHandler, unregisterIQRequestHandler

Methods inherited from class java.lang.Object

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

Field Detail

XMPP_BOSH_NS

public static final String XMPP_BOSH_NS

The XMPP Over Bosh namespace.

See Also:

Constant Field Values

BOSH_URI

public static final String BOSH_URI

The BOSH namespace from XEP-0124.

See Also:

Constant Field Values

sessionID

protected String sessionID

The session ID for the BOSH session with the connection manager.

Constructor Detail

XMPPBOSHConnection

public XMPPBOSHConnection(String username,
                          String password,
                          boolean https,
                          String host,
                          int port,
                          String filePath,
                          String xmppDomain)

Create a HTTP Binding connection to an XMPP server.

Parameters:

username - the username to use.

password - the password to use.

https - true if you want to use SSL (e.g. false for http://domain.lt:7070/http-bind).

host - the hostname or IP address of the connection manager (e.g. domain.lt for http://domain.lt:7070/http-bind).

port - the port of the connection manager (e.g. 7070 for http://domain.lt:7070/http-bind).

filePath - the file which is described by the URL (e.g. /http-bind for http://domain.lt:7070/http-bind).

xmppDomain - the XMPP service name (e.g. domain.lt for the user alice@domain.lt)

XMPPBOSHConnection

public XMPPBOSHConnection(BOSHConfiguration config)

Create a HTTP Binding connection to an XMPP server.

Parameters:

config - The configuration which is used for this connection.

Method Detail

connectInternal

protected void connectInternal()
                        throws SmackException

Description copied from class: AbstractXMPPConnection

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).

Specified by:

connectInternal in class AbstractXMPPConnection

Throws:

SmackException

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.

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.

loginNonAnonymously

protected void loginNonAnonymously(String username,
                                   String password,
                                   String resource)
                            throws XMPPException,
                                   SmackException,
                                   IOException

Specified by:

loginNonAnonymously in class AbstractXMPPConnection

Throws:

XMPPException

SmackException

IOException

loginAnonymously

protected void loginAnonymously()
                         throws XMPPException,
                                SmackException,
                                IOException

Specified by:

loginAnonymously in class AbstractXMPPConnection

Throws:

XMPPException

SmackException

IOException

send

public 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

Specified by:

send in class AbstractXMPPConnection

Throws:

SmackException.NotConnectedException

sendStanzaInternal

protected void sendStanzaInternal(Stanza packet)
                           throws SmackException.NotConnectedException

Specified by:

sendStanzaInternal in class AbstractXMPPConnection

Throws:

SmackException.NotConnectedException

shutdown

protected void shutdown()

Closes the connection by setting presence to unavailable and closing the HTTP client. The shutdown logic will be used during a planned disconnection or when dealing with an unexpected disconnection. Unlike AbstractXMPPConnection.disconnect() the connection's BOSH stanza(/packet) reader will not be removed; thus connection's state is kept.

Specified by:

shutdown in class AbstractXMPPConnection

send

protected void send(org.igniterealtime.jbosh.ComposableBody body)
             throws org.igniterealtime.jbosh.BOSHException

Send a HTTP request to the connection manager with the provided body element.

Parameters:

body - the body which will be sent.

Throws:

org.igniterealtime.jbosh.BOSHException

initDebugger

protected void initDebugger()

Initialize the SmackDebugger which allows to log and debug XML traffic.

Overrides:

initDebugger in class AbstractXMPPConnection

notifyConnectionError

protected void notifyConnectionError(Exception e)

Sends out a notification that there was an error with the connection and closes the connection.

Parameters:

e - the exception that causes the connection close event.