org.jivesoftware.smack

Class ConnectionConfiguration

java.lang.Object

org.jivesoftware.smack.ConnectionConfiguration

All Implemented Interfaces:

java.lang.Cloneable

Direct Known Subclasses:

BOSHConfiguration

public class ConnectionConfiguration
extends java.lang.Object
implements java.lang.Cloneable

Configuration to use while establishing the connection to the server. It is possible to configure the path to the trustore file that keeps the trusted CA root certificates and enable or disable all or some of the checkings done while verifying server certificates.

It is also possible to configure if TLS, SASL, and compression are used or not.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ConnectionConfiguration.SecurityMode An enumeration for TLS security modes that are available when making a connection to the XMPP server.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.List<HostAddress>	hostAddresses
protected ProxyInfo	proxy

Constructor Summary

Constructors

Constructor and Description
ConnectionConfiguration(java.lang.String serviceName) Creates a new ConnectionConfiguration for the specified service name.
ConnectionConfiguration(java.lang.String host, int port) Creates a new ConnectionConfiguration for a connection that will connect to the desired host and port.
ConnectionConfiguration(java.lang.String host, int port, ProxyInfo proxy) Creates a new ConnectionConfiguration for a connection that will connect to the desired host and port with desired proxy.
ConnectionConfiguration(java.lang.String host, int port, java.lang.String serviceName) Creates a new ConnectionConfiguration using the specified host, port and service name.
ConnectionConfiguration(java.lang.String host, int port, java.lang.String serviceName, ProxyInfo proxy) Creates a new ConnectionConfiguration using the specified host, port and service name.
ConnectionConfiguration(java.lang.String serviceName, ProxyInfo proxy) Creates a new ConnectionConfiguration for the specified service name with specified proxy.

Method Summary

Methods

Modifier and Type	Method and Description
javax.security.auth.callback.CallbackHandler	getCallbackHandler() Returns a CallbackHandler to obtain information, such as the password or principal information during the SASL authentication.
javax.net.ssl.SSLContext	getCustomSSLContext() Gets the custom SSLContext previously set with setCustomSSLContext(SSLContext) for SSL sockets.
java.util.List<HostAddress>	getHostAddresses()
java.lang.String	getKeystorePath() Retuns the path to the keystore file.
java.lang.String	getKeystoreType() Returns the keystore type, or null if it's not set.
java.lang.String	getPassword() Returns the password to use when trying to reconnect to the server.
java.lang.String	getPKCS11Library() Returns the PKCS11 library file location, needed when the Keystore type is PKCS11.
java.lang.String	getResource() Returns the resource to use when trying to reconnect to the server.
RosterStore	getRosterStore() Get the permanent roster store
ConnectionConfiguration.SecurityMode	getSecurityMode() Returns the TLS security mode used when making the connection.
java.lang.String	getServiceName() Returns the server name of the target server.
javax.net.SocketFactory	getSocketFactory() Returns the socket factory used to create new xmppConnection sockets.
java.lang.String	getUsername() Returns the username to use when trying to reconnect to the server.
protected void	init(java.lang.String serviceName, ProxyInfo proxy)
boolean	isCompressionEnabled() Returns true if the connection is going to use stream compression.
boolean	isDebuggerEnabled() Returns true if the new connection about to be establish is going to be debugged.
boolean	isLegacySessionDisabled() Returns true if a Session will be requested on login if the server supports it.
boolean	isReconnectionAllowed() Returns if the reconnection mechanism is allowed to be used.
boolean	isRosterLoadedAtLogin() Returns true if the roster will be loaded from the server when logging in.
boolean	isSendPresence() Returns true if an available presence should be sent when logging in while reconnecting.
void	setCallbackHandler(javax.security.auth.callback.CallbackHandler callbackHandler) Sets a CallbackHandler to obtain information, such as the password or principal information during the SASL authentication.
void	setCompressionEnabled(boolean compressionEnabled) Sets if the connection is going to use stream compression.
void	setCustomSSLContext(javax.net.ssl.SSLContext context) Sets a custom SSLContext for creating SSL sockets.
void	setDebuggerEnabled(boolean debuggerEnabled) Sets if the new connection about to be establish is going to be debugged.
void	setKeystorePath(java.lang.String keystorePath) Sets the path to the keystore file.
void	setKeystoreType(java.lang.String keystoreType) Sets the keystore type.
void	setLegacySessionDisabled(boolean legacySessionDisabled) Sets if a Session will be requested on login if the server supports it.
void	setPKCS11Library(java.lang.String pkcs11Library) Sets the PKCS11 library file location, needed when the Keystore type is PKCS11
void	setReconnectionAllowed(boolean isAllowed) Sets if the reconnection mechanism is allowed to be used.
void	setRosterLoadedAtLogin(boolean rosterLoadedAtLogin) Sets if the roster will be loaded from the server when logging in.
void	setRosterStore(RosterStore store) Set the permanent roster store
void	setSecurityMode(ConnectionConfiguration.SecurityMode securityMode) Sets the TLS security mode used when making the connection.
void	setSendPresence(boolean sendPresence) Sets if an initial available presence will be sent to the server.
void	setSocketFactory(javax.net.SocketFactory socketFactory) Sets the socket factory used to create new xmppConnection sockets.

Methods inherited from class java.lang.Object

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

Field Detail

hostAddresses

protected java.util.List<HostAddress> hostAddresses

proxy

protected ProxyInfo proxy

Constructor Detail

ConnectionConfiguration

public ConnectionConfiguration(java.lang.String serviceName)

Creates a new ConnectionConfiguration for the specified service name. A DNS SRV lookup will be performed to find out the actual host address and port to use for the connection.

Parameters:

serviceName - the name of the service provided by an XMPP server.

ConnectionConfiguration

public ConnectionConfiguration(java.lang.String serviceName,
                       ProxyInfo proxy)

Creates a new ConnectionConfiguration for the specified service name with specified proxy. A DNS SRV lookup will be performed to find out the actual host address and port to use for the connection.

Parameters:

serviceName - the name of the service provided by an XMPP server.

proxy - the proxy through which XMPP is to be connected

ConnectionConfiguration

public ConnectionConfiguration(java.lang.String host,
                       int port,
                       java.lang.String serviceName)

Creates a new ConnectionConfiguration using the specified host, port and service name. This is useful for manually overriding the DNS SRV lookup process that's used with the ConnectionConfiguration(String) constructor. For example, say that an XMPP server is running at localhost in an internal network on port 5222 but is configured to think that it's "example.com" for testing purposes. This constructor is necessary to connect to the server in that case since a DNS SRV lookup for example.com would not point to the local testing server.

Parameters:

host - the host where the XMPP server is running.

port - the port where the XMPP is listening.

serviceName - the name of the service provided by an XMPP server.

ConnectionConfiguration

public ConnectionConfiguration(java.lang.String host,
                       int port,
                       java.lang.String serviceName,
                       ProxyInfo proxy)

Creates a new ConnectionConfiguration using the specified host, port and service name. This is useful for manually overriding the DNS SRV lookup process that's used with the ConnectionConfiguration(String) constructor. For example, say that an XMPP server is running at localhost in an internal network on port 5222 but is configured to think that it's "example.com" for testing purposes. This constructor is necessary to connect to the server in that case since a DNS SRV lookup for example.com would not point to the local testing server.

Parameters:

host - the host where the XMPP server is running.

port - the port where the XMPP is listening.

serviceName - the name of the service provided by an XMPP server.

proxy - the proxy through which XMPP is to be connected

ConnectionConfiguration

public ConnectionConfiguration(java.lang.String host,
                       int port)

Creates a new ConnectionConfiguration for a connection that will connect to the desired host and port.

Parameters:

host - the host where the XMPP server is running.

port - the port where the XMPP is listening.

ConnectionConfiguration

public ConnectionConfiguration(java.lang.String host,
                       int port,
                       ProxyInfo proxy)

Creates a new ConnectionConfiguration for a connection that will connect to the desired host and port with desired proxy.

Parameters:

host - the host where the XMPP server is running.

port - the port where the XMPP is listening.

proxy - the proxy through which XMPP is to be connected

Method Detail

init

protected void init(java.lang.String serviceName,
        ProxyInfo proxy)

getServiceName

public java.lang.String getServiceName()

Returns the server name of the target server.

Returns:

the server name of the target server.

getSecurityMode

public ConnectionConfiguration.SecurityMode getSecurityMode()

Returns the TLS security mode used when making the connection. By default, the mode is ConnectionConfiguration.SecurityMode.enabled.

Returns:

the security mode.

setSecurityMode

public void setSecurityMode(ConnectionConfiguration.SecurityMode securityMode)

Sets the TLS security mode used when making the connection. By default, the mode is ConnectionConfiguration.SecurityMode.enabled.

Parameters:

securityMode - the security mode.

getKeystorePath

public java.lang.String getKeystorePath()

Retuns the path to the keystore file. The key store file contains the certificates that may be used to authenticate the client to the server, in the event the server requests or requires it.

Returns:

the path to the keystore file.

setKeystorePath

public void setKeystorePath(java.lang.String keystorePath)

Sets the path to the keystore file. The key store file contains the certificates that may be used to authenticate the client to the server, in the event the server requests or requires it.

Parameters:

keystorePath - the path to the keystore file.

getKeystoreType

public java.lang.String getKeystoreType()

Returns the keystore type, or null if it's not set.

Returns:

the keystore type.

setKeystoreType

public void setKeystoreType(java.lang.String keystoreType)

Sets the keystore type.

Parameters:

keystoreType - the keystore type.

getPKCS11Library

public java.lang.String getPKCS11Library()

Returns the PKCS11 library file location, needed when the Keystore type is PKCS11.

Returns:

the path to the PKCS11 library file

setPKCS11Library

public void setPKCS11Library(java.lang.String pkcs11Library)

Sets the PKCS11 library file location, needed when the Keystore type is PKCS11

Parameters:

pkcs11Library - the path to the PKCS11 library file

getCustomSSLContext

public javax.net.ssl.SSLContext getCustomSSLContext()

Gets the custom SSLContext previously set with setCustomSSLContext(SSLContext) for SSL sockets. This is null by default.

Returns:

the custom SSLContext or null.

setCustomSSLContext

public void setCustomSSLContext(javax.net.ssl.SSLContext context)

Sets a custom SSLContext for creating SSL sockets.

For more information on how to create a SSLContext see Java Secure Socket Extension (JSEE) Reference Guide: Creating Your Own X509TrustManager

Parameters:

context - the custom SSLContext for new sockets

isCompressionEnabled

public boolean isCompressionEnabled()

Returns true if the connection is going to use stream compression. Stream compression will be requested after TLS was established (if TLS was enabled) and only if the server offered stream compression. With stream compression network traffic can be reduced up to 90%. By default compression is disabled.

Returns:

true if the connection is going to use stream compression.

setCompressionEnabled

public void setCompressionEnabled(boolean compressionEnabled)

Sets if the connection is going to use stream compression. Stream compression will be requested after TLS was established (if TLS was enabled) and only if the server offered stream compression. With stream compression network traffic can be reduced up to 90%. By default compression is disabled.

Parameters:

compressionEnabled - if the connection is going to use stream compression.

isDebuggerEnabled

public boolean isDebuggerEnabled()

Returns true if the new connection about to be establish is going to be debugged. By default the value of SmackConfiguration.DEBUG_ENABLED is used.

Returns:

true if the new connection about to be establish is going to be debugged.

setDebuggerEnabled

public void setDebuggerEnabled(boolean debuggerEnabled)

Sets if the new connection about to be establish is going to be debugged. By default the value of SmackConfiguration.DEBUG_ENABLED is used.

Parameters:

debuggerEnabled - if the new connection about to be establish is going to be debugged.

setReconnectionAllowed

public void setReconnectionAllowed(boolean isAllowed)

Sets if the reconnection mechanism is allowed to be used. By default reconnection is allowed.

Parameters:

isAllowed - if the reconnection mechanism should be enabled for this connection.

isReconnectionAllowed

public boolean isReconnectionAllowed()

Returns if the reconnection mechanism is allowed to be used. By default reconnection is allowed. You can disable the reconnection mechanism with setReconnectionAllowed(boolean).

Returns:

true, if the reconnection mechanism is enabled.

setSocketFactory

public void setSocketFactory(javax.net.SocketFactory socketFactory)

Sets the socket factory used to create new xmppConnection sockets. This is useful when connecting through SOCKS5 proxies.

Parameters:

socketFactory - used to create new sockets.

setSendPresence

public void setSendPresence(boolean sendPresence)

Sets if an initial available presence will be sent to the server. By default an available presence will be sent to the server indicating that this presence is not online and available to receive messages. If you want to log in without being 'noticed' then pass a false value.

Parameters:

sendPresence - true if an initial available presence will be sent while logging in.

isRosterLoadedAtLogin

public boolean isRosterLoadedAtLogin()

Returns true if the roster will be loaded from the server when logging in. This is the common behaviour for clients but sometimes clients may want to differ this or just never do it if not interested in rosters.

Returns:

true if the roster will be loaded from the server when logging in.

setRosterLoadedAtLogin

public void setRosterLoadedAtLogin(boolean rosterLoadedAtLogin)

Sets if the roster will be loaded from the server when logging in. This is the common behaviour for clients but sometimes clients may want to differ this or just never do it if not interested in rosters.

Parameters:

rosterLoadedAtLogin - if the roster will be loaded from the server when logging in.

isLegacySessionDisabled

public boolean isLegacySessionDisabled()

Returns true if a Session will be requested on login if the server supports it. Although this was mandatory on RFC 3921, RFC 6120/6121 don't even mention this part of the protocol.

Returns:

true if a session has to be requested when logging in.

setLegacySessionDisabled

public void setLegacySessionDisabled(boolean legacySessionDisabled)

Sets if a Session will be requested on login if the server supports it. Although this was mandatory on RFC 3921, RFC 6120/6121 don't even mention this part of the protocol.

Parameters:

legacySessionDisabled - if a session has to be requested when logging in.

getCallbackHandler

public javax.security.auth.callback.CallbackHandler getCallbackHandler()

Returns a CallbackHandler to obtain information, such as the password or principal information during the SASL authentication. A CallbackHandler will be used ONLY if no password was specified during the login while using SASL authentication.

Returns:

a CallbackHandler to obtain information, such as the password or principal information during the SASL authentication.

setCallbackHandler

public void setCallbackHandler(javax.security.auth.callback.CallbackHandler callbackHandler)

Sets a CallbackHandler to obtain information, such as the password or principal information during the SASL authentication. A CallbackHandler will be used ONLY if no password was specified during the login while using SASL authentication.

Parameters:

callbackHandler - to obtain information, such as the password or principal information during the SASL authentication.

getSocketFactory

public javax.net.SocketFactory getSocketFactory()

Returns the socket factory used to create new xmppConnection sockets. This is useful when connecting through SOCKS5 proxies.

Returns:

socketFactory used to create new sockets.

getHostAddresses

public java.util.List<HostAddress> getHostAddresses()

setRosterStore

public void setRosterStore(RosterStore store)

Set the permanent roster store

getRosterStore

public RosterStore getRosterStore()

Get the permanent roster store

getUsername

public java.lang.String getUsername()

Returns the username to use when trying to reconnect to the server.

Returns:

the username to use when trying to reconnect to the server.

getPassword

public java.lang.String getPassword()

Returns the password to use when trying to reconnect to the server.

Returns:

the password to use when trying to reconnect to the server.

getResource

public java.lang.String getResource()

Returns the resource to use when trying to reconnect to the server.

Returns:

the resource to use when trying to reconnect to the server.

isSendPresence

public boolean isSendPresence()

Returns true if an available presence should be sent when logging in while reconnecting.

Returns:

true if an available presence should be sent when logging in while reconnecting