rocks.xmpp.core.session

Class ConnectionConfiguration

java.lang.Object

rocks.xmpp.core.session.ConnectionConfiguration

Direct Known Subclasses:

BoshConnectionConfiguration, TcpConnectionConfiguration

public abstract class ConnectionConfiguration
extends Object

A base class for connection configurations.

All connection methods have a few properties in common, which are abstracted in this class. Among these common properties are hostname, port, proxy, security settings and a timeout.

See Also:

Connection

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ConnectionConfiguration.Builder<T extends ConnectionConfiguration.Builder<T>> An abstract builder class for building immutable configuration objects.

Method Summary

Modifier and Type	Method and Description
abstract Connection	createConnection(XmppSession xmppSession) A factory method to create the connection.
List<CompressionMethod>	getCompressionMethods() Gets the compression methods.
int	getConnectTimeout() Gets the timeout for connection establishment.
String	getHostname() Gets the hostname.
HostnameVerifier	getHostnameVerifier() Gets the hostname verifier.
int	getPort() Gets the port.
Proxy	getProxy() Gets the proxy.
SSLContext	getSSLContext() Gets the SSL context.
boolean	isSecure() Indicates whether the connection is secured by SSL.
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

createConnection

public abstract Connection createConnection(XmppSession xmppSession)

A factory method to create the connection.

Parameters:

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

Returns:

The connection.

getHostname

public final String getHostname()

Gets the hostname.

Returns:

The hostname.

getPort

public final int getPort()

Gets the port.

Returns:

The port.

getProxy

public final Proxy getProxy()

Gets the proxy.

Returns:

The proxy.

isSecure

public final boolean isSecure()

Indicates whether the connection is secured by SSL.

Returns:

If the connection is to be secured.

See Also:

ConnectionConfiguration.Builder.secure(boolean)

getSSLContext

public final SSLContext getSSLContext()

Gets the SSL context.

Returns:

The SSL context.

getHostnameVerifier

public final HostnameVerifier getHostnameVerifier()

Gets the hostname verifier.

Returns:

The hostname verifier.

getConnectTimeout

public final int getConnectTimeout()

Gets the timeout for connection establishment.

Returns:

The timeout.

getCompressionMethods

public final List<CompressionMethod> getCompressionMethods()

Gets the compression methods.

Returns:

The compression methods.

toString

public String toString()

Overrides:

toString in class Object