org.jivesoftware.smack

Class XMPPBOSHConnection

java.lang.Object

org.jivesoftware.smack.XMPPConnection

org.jivesoftware.smack.XMPPBOSHConnection

public class XMPPBOSHConnection
extends org.jivesoftware.smack.XMPPConnection

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

See Also:

XMPPConnection

Nested Class Summary

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

org.jivesoftware.smack.XMPPConnection.FromMode, org.jivesoftware.smack.XMPPConnection.InterceptorWrapper, org.jivesoftware.smack.XMPPConnection.ListenerWrapper

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	authID The BOSH equivalent of the stream ID which is used for DIGEST authentication.
static java.lang.String	BOSH_URI The BOSH namespace from XEP-0124.
protected java.lang.String	sessionID The session ID for the BOSH session with the connection manager.
static java.lang.String	XMPP_BOSH_NS The XMPP Over Bosh namespace.

Fields inherited from class org.jivesoftware.smack.XMPPConnection

collectors, compressionHandler, connectionCounterValue, connectionListeners, debugger, interceptors, reader, recvListeners, saslAuthentication, sendListeners, writer

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
void	connect()
void	disconnect(org.jivesoftware.smack.packet.Presence unavailablePresence)
java.lang.String	getConnectionID()
java.lang.String	getUser()
protected void	initDebugger() Initialize the SmackDebugger which allows to log and debug XML traffic.
boolean	isAnonymous()
boolean	isAuthenticated()
boolean	isConnected()
boolean	isSecureConnection()
boolean	isUsingCompression()
void	login(java.lang.String username, java.lang.String password, java.lang.String resource)
void	loginAnonymously()
protected void	notifyConnectionError(java.lang.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.
protected void	shutdown(org.jivesoftware.smack.packet.Presence unavailablePresence) Closes the connection by setting presence to unavailable and closing the HTTP client.

Methods inherited from class org.jivesoftware.smack.XMPPConnection

addConnectionCreationListener, addConnectionListener, addPacketInterceptor, addPacketListener, addPacketSendingListener, createPacketCollector, createPacketCollectorAndSend, disconnect, getConfiguration, getConnectionCounter, getConnectionCreationListeners, getConnectionListeners, getFromMode, getHost, getPacketCollectors, getPacketInterceptors, getPacketListeners, getPacketReplyTimeout, getPacketSendingListeners, getPort, getRoster, getSASLAuthentication, getServiceCapsNode, getServiceName, isRosterVersioningSupported, login, processPacket, removeConnectionCreationListener, removeConnectionListener, removePacketCollector, removePacketInterceptor, removePacketListener, removePacketSendingListener, schedule, sendPacket, setFromMode, setPacketReplyTimeout, setRosterVersioningSupported, setServiceCapsNode

Methods inherited from class java.lang.Object

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

Field Detail

XMPP_BOSH_NS

public static final java.lang.String XMPP_BOSH_NS

The XMPP Over Bosh namespace.

See Also:

Constant Field Values

BOSH_URI

public static final java.lang.String BOSH_URI

The BOSH namespace from XEP-0124.

See Also:

Constant Field Values

authID

protected java.lang.String authID

The BOSH equivalent of the stream ID which is used for DIGEST authentication.

sessionID

protected java.lang.String sessionID

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

Constructor Detail

XMPPBOSHConnection

public XMPPBOSHConnection(boolean https,
                  java.lang.String host,
                  int port,
                  java.lang.String filePath,
                  java.lang.String xmppDomain)

Create a HTTP Binding connection to a XMPP server.

Parameters:

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 a XMPP server.

Parameters:

config - The configuration which is used for this connection.

Method Detail

connect

public void connect()
             throws org.jivesoftware.smack.SmackException

Specified by:

connect in class org.jivesoftware.smack.XMPPConnection

Throws:

org.jivesoftware.smack.SmackException

getConnectionID

public java.lang.String getConnectionID()

Specified by:

getConnectionID in class org.jivesoftware.smack.XMPPConnection

getUser

public java.lang.String getUser()

Specified by:

getUser in class org.jivesoftware.smack.XMPPConnection

isAnonymous

public boolean isAnonymous()

Specified by:

isAnonymous in class org.jivesoftware.smack.XMPPConnection

isAuthenticated

public boolean isAuthenticated()

Specified by:

isAuthenticated in class org.jivesoftware.smack.XMPPConnection

isConnected

public boolean isConnected()

Specified by:

isConnected in class org.jivesoftware.smack.XMPPConnection

isSecureConnection

public boolean isSecureConnection()

Specified by:

isSecureConnection in class org.jivesoftware.smack.XMPPConnection

isUsingCompression

public boolean isUsingCompression()

Specified by:

isUsingCompression in class org.jivesoftware.smack.XMPPConnection

login

public void login(java.lang.String username,
         java.lang.String password,
         java.lang.String resource)
           throws org.jivesoftware.smack.XMPPException,
                  org.jivesoftware.smack.SmackException,
                  java.io.IOException

Specified by:

login in class org.jivesoftware.smack.XMPPConnection

Throws:

org.jivesoftware.smack.XMPPException

org.jivesoftware.smack.SmackException

java.io.IOException

loginAnonymously

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

Specified by:

loginAnonymously in class org.jivesoftware.smack.XMPPConnection

Throws:

org.jivesoftware.smack.XMPPException

org.jivesoftware.smack.SmackException

java.io.IOException

disconnect

public void disconnect(org.jivesoftware.smack.packet.Presence unavailablePresence)

Specified by:

disconnect in class org.jivesoftware.smack.XMPPConnection

shutdown

protected void shutdown(org.jivesoftware.smack.packet.Presence unavailablePresence)

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 XMPPConnection.disconnect() the connection's BOSH packet reader and Roster will not be removed; thus connection's state is kept.

Parameters:

unavailablePresence - the presence packet to send during shutdown.

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 org.jivesoftware.smack.XMPPConnection

notifyConnectionError

protected void notifyConnectionError(java.lang.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.