rocks.xmpp.core.session

Class TcpConnectionConfiguration

java.lang.Object

rocks.xmpp.core.net.client.ClientConnectionConfiguration

rocks.xmpp.core.net.client.TcpConnectionConfiguration<java.net.Socket>

rocks.xmpp.core.session.TcpConnectionConfiguration

All Implemented Interfaces:

ConnectionConfiguration

Deprecated.

Use SocketConnectionConfiguration

@Deprecated
public class TcpConnectionConfiguration
extends TcpConnectionConfiguration<java.net.Socket>

A configuration for a TCP connection. It allows you to configure various connection settings for a TCP socket connection, most importantly the host address and port, but also a whitespace keep-alive interval, a custom socket factory, a custom SSL context and compression methods.

Usage

In order to create an instance of this class you have to use the builder pattern as shown below.

TcpConnectionConfiguration tcpConfiguration = TcpConnectionConfiguration.builder()
.hostname("localhost")
.port(5222)
.sslContext(sslContext)
.channelEncryption(ChannelEncryption.DISABLED)
.build();

This class is immutable.

See Also:

BoshConnectionConfiguration, SocketConnection

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TcpConnectionConfiguration.Builder Deprecated. A builder to create a TcpConnectionConfiguration instance.

Method Summary

Modifier and Type	Method and Description
static TcpConnectionConfiguration.Builder	builder() Deprecated. Creates a new builder for this class.
Connection	createConnection(XmppSession xmppSession) Deprecated. A factory method to create the connection.
static TcpConnectionConfiguration	getDefault() Deprecated. Gets the default configuration.
javax.net.SocketFactory	getSocketFactory() Deprecated. Gets the socket factory.
static void	setDefault(TcpConnectionConfiguration configuration) Deprecated. Sets the default configuration.
java.lang.String	toString() Deprecated.

Methods inherited from class rocks.xmpp.core.net.client.TcpConnectionConfiguration

getKeepAliveInterval

Methods inherited from class rocks.xmpp.core.net.client.ClientConnectionConfiguration

getChannelEncryption, getCompressionMethods, getConnectTimeout, getHostname, getHostnameVerifier, getPort, getProxy, getSSLContext

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

builder

public static TcpConnectionConfiguration.Builder builder()

Deprecated.

Creates a new builder for this class.

Returns:

The builder.

getDefault

public static TcpConnectionConfiguration getDefault()

Deprecated.

Gets the default configuration.

Returns:

The default configuration.

setDefault

public static void setDefault(TcpConnectionConfiguration configuration)

Deprecated.

Sets the default configuration.

Parameters:

configuration - The default configuration.

createConnection

public final Connection createConnection(XmppSession xmppSession)
                                  throws java.lang.Exception

Deprecated.

Description copied from class: ClientConnectionConfiguration

A factory method to create the connection.

Specified by:

createConnection in class ClientConnectionConfiguration

Parameters:

xmppSession - The XMPP session, which is associated with the connection.

Returns:

The connection.

Throws:

java.lang.Exception - Any exception which may occur during connection establishment.

getSocketFactory

public final javax.net.SocketFactory getSocketFactory()

Deprecated.

Gets the socket factory.

Returns:

The socket factory.

toString

public final java.lang.String toString()

Deprecated.

Overrides:

toString in class ClientConnectionConfiguration