rocks.xmpp.core.session

Class Connection

java.lang.Object

rocks.xmpp.core.session.Connection

All Implemented Interfaces:

Closeable, AutoCloseable

Direct Known Subclasses:

BoshConnection, TcpConnection

public abstract class Connection
extends Object
implements Closeable

The base connection class which provides hostname, port and proxy information.

Author:

Christian Schudt

Field Summary

Fields

Modifier and Type	Field and Description
protected String	hostname
protected int	port

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Connection(String hostname, int port, Proxy proxy) Creates a connection to the specified host and port through a proxy.
protected	Connection(XmppSession xmppSession, ConnectionConfiguration connectionConfiguration) Creates a connection to the specified host and port through a proxy.

Method Summary

Modifier and Type	Method and Description
protected void	compressStream() Compresses the stream.
abstract void	connect() Connects to the server.
String	getHostname() Gets the hostname, which is used for the connection.
int	getPort() Gets the port, which is used for the connection.
Proxy	getProxy() Gets the proxy.
XmppSession	getXmppSession() Gets the XMPP session which is associated with this connection.
void	initialize(XmppSession xmppSession) Deprecated.
protected abstract void	restartStream() Restarts the stream.
abstract void	send(ClientStreamElement clientStreamElement) Sends an element.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.io.Closeable

close

Field Detail

hostname

protected String hostname

port

protected int port

Constructor Detail

Connection

protected Connection(XmppSession xmppSession,
                     ConnectionConfiguration connectionConfiguration)

Creates a connection to the specified host and port through a proxy.

Parameters:

connectionConfiguration - The connection configuration.

Connection

protected Connection(String hostname,
                     int port,
                     Proxy proxy)

Creates a connection to the specified host and port through a proxy.

Parameters:

hostname - The host, which is used to establish the connection.

port - The port, which is used to establish the connection.

proxy - The proxy.

Method Detail

getXmppSession

public final XmppSession getXmppSession()

Gets the XMPP session which is associated with this connection. This method should only be called from the session itself.

Returns:

The XMPP session.

initialize

@Deprecated
public final void initialize(XmppSession xmppSession)

Deprecated.

Sets the XMPP session which is associated with this connection. This method should only be called from the session itself.

Parameters:

xmppSession - The XMPP session.

getHostname

public final String getHostname()

Gets the hostname, which is used for the connection.

Returns:

The hostname.

getPort

public final int getPort()

Gets the port, which is used for the connection.

Returns:

The port.

getProxy

public final Proxy getProxy()

Gets the proxy.

Returns:

The proxy.

restartStream

protected abstract void restartStream()

Restarts the stream.

send

public abstract void send(ClientStreamElement clientStreamElement)

Sends an element.

Parameters:

clientStreamElement - The element.

compressStream

protected void compressStream()

Compresses the stream.

connect

public abstract void connect()
                      throws IOException

Connects to the server.

Throws:

IOException - If no connection could be established, e.g. due to unknown host.