org.jivesoftware.smack

Class ConnectionConfiguration

java.lang.Object

org.jivesoftware.smack.ConnectionConfiguration

Direct Known Subclasses:

BOSHConfiguration, XMPPTCPConnectionConfiguration

public abstract class ConnectionConfiguration
extends Object

Configuration to use while establishing the connection to the server.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ConnectionConfiguration.Builder<B extends ConnectionConfiguration.Builder<B,C>,C extends ConnectionConfiguration> A builder for XMPP connection configurations.
static class	ConnectionConfiguration.DnssecMode Determines the requested DNSSEC security mode.
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 boolean	allowNullOrEmptyUsername
protected DnsName	host
protected InetAddress	hostAddress
protected int	port
protected ProxyInfo	proxy
protected DomainBareJid	xmppServiceDomain The XMPP domain of the XMPP Service.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ConnectionConfiguration(ConnectionConfiguration.Builder<?,?> builder)

Method Summary

Modifier and Type	Method and Description
EntityBareJid	getAuthzid() Returns the optional XMPP address to be requested as the SASL authorization identity.
CallbackHandler	getCallbackHandler() Returns a CallbackHandler to obtain information, such as the password or principal information during the SASL authentication.
SSLContext	getCustomSSLContext() Gets the custom SSLContext previously set with ConnectionConfiguration.Builder.setCustomSSLContext(SSLContext) for SSL sockets.
X509TrustManager	getCustomX509TrustManager()
SmackDebuggerFactory	getDebuggerFactory() Returns the Smack debugger factory.
ConnectionConfiguration.DnssecMode	getDnssecMode()
Set<String>	getEnabledSaslMechanisms() Return the explicitly enabled SASL mechanisms.
String[]	getEnabledSSLCiphers() Return the enabled SSL/TLS ciphers.
String[]	getEnabledSSLProtocols() Return the enabled SSL/TLS protocols.
HostnameVerifier	getHostnameVerifier() Returns the configured HostnameVerifier of this ConnectionConfiguration or the Smack default HostnameVerifier configured with SmackConfiguration.setDefaultHostnameVerifier(HostnameVerifier).
String	getKeystorePath() Retuns the path to the keystore file.
String	getKeystoreType() Returns the keystore type, or null if it's not set.
String	getPassword() Returns the password to use when trying to reconnect to the server.
String	getPKCS11Library() Returns the PKCS11 library file location, needed when the Keystore type is PKCS11.
ProxyInfo	getProxyInfo() Get the configured proxy information (if any).
Resourcepart	getResource() Returns the resource to use when trying to reconnect to the server.
ConnectionConfiguration.SecurityMode	getSecurityMode() Returns the TLS security mode used when making the connection.
DomainBareJid	getServiceName() Deprecated. use getXMPPServiceDomain() instead.
SocketFactory	getSocketFactory() Returns the socket factory used to create new xmppConnection sockets.
CharSequence	getUsername() Returns the username to use when trying to reconnect to the server.
DomainBareJid	getXMPPServiceDomain() Returns the XMPP domain used by this configuration.
boolean	isCompressionEnabled() Returns true if the connection is going to use stream compression.
boolean	isEnabledSaslMechanism(String saslMechanism) Check if the given SASL mechansism is enabled in this connection configuration.
boolean	isSendPresence() Returns true if an available presence should be sent when logging in while reconnecting.

Methods inherited from class java.lang.Object

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

Field Detail

xmppServiceDomain

protected final DomainBareJid xmppServiceDomain

The XMPP domain of the XMPP Service. Usually servers use the same service name as the name of the server. However, there are some servers like google where host would be talk.google.com and the serviceName would be gmail.com.

hostAddress

protected final InetAddress hostAddress

host

protected final DnsName host

port

protected final int port

proxy

protected final ProxyInfo proxy

allowNullOrEmptyUsername

protected final boolean allowNullOrEmptyUsername

Constructor Detail

ConnectionConfiguration

protected ConnectionConfiguration(ConnectionConfiguration.Builder<?,?> builder)

Method Detail

getServiceName

@Deprecated
public DomainBareJid getServiceName()

Deprecated. use getXMPPServiceDomain() instead.

Returns the server name of the target server.

Returns:

the server name of the target server.

getXMPPServiceDomain

public DomainBareJid getXMPPServiceDomain()

Returns the XMPP domain used by this configuration.

Returns:

the XMPP domain.

getSecurityMode

public ConnectionConfiguration.SecurityMode getSecurityMode()

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

Returns:

the security mode.

getDnssecMode

public ConnectionConfiguration.DnssecMode getDnssecMode()

getCustomX509TrustManager

public X509TrustManager getCustomX509TrustManager()

getKeystorePath

public 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.

getKeystoreType

public String getKeystoreType()

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

Returns:

the keystore type.

getPKCS11Library

public String getPKCS11Library()

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

Returns:

the path to the PKCS11 library file

getCustomSSLContext

public SSLContext getCustomSSLContext()

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

Returns:

the custom SSLContext or null.

getEnabledSSLProtocols

public String[] getEnabledSSLProtocols()

Return the enabled SSL/TLS protocols.

Returns:

the enabled SSL/TLS protocols

getEnabledSSLCiphers

public String[] getEnabledSSLCiphers()

Return the enabled SSL/TLS ciphers.

Returns:

the enabled SSL/TLS ciphers

getHostnameVerifier

public HostnameVerifier getHostnameVerifier()

Returns the configured HostnameVerifier of this ConnectionConfiguration or the Smack default HostnameVerifier configured with SmackConfiguration.setDefaultHostnameVerifier(HostnameVerifier).

Returns:

a configured HostnameVerifier or null

getDebuggerFactory

public SmackDebuggerFactory getDebuggerFactory()

Returns the Smack debugger factory.

Returns:

the Smack debugger factory or null

getCallbackHandler

public 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.

getSocketFactory

public 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.

getProxyInfo

public ProxyInfo getProxyInfo()

Get the configured proxy information (if any).

Returns:

the configured proxy information or null.

getUsername

public CharSequence 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 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 Resourcepart 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.

getAuthzid

public EntityBareJid getAuthzid()

Returns the optional XMPP address to be requested as the SASL authorization identity.

Returns:

the authorization identifier.

Since:

4.2

See Also:

RFC 6120 § 6.3.8. Authorization Identity

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

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.

isEnabledSaslMechanism

public boolean isEnabledSaslMechanism(String saslMechanism)

Check if the given SASL mechansism is enabled in this connection configuration.

Parameters:

saslMechanism -

Returns:

true if the given SASL mechanism is enabled, false otherwise.

getEnabledSaslMechanisms

public Set<String> getEnabledSaslMechanisms()

Return the explicitly enabled SASL mechanisms. May return null if no SASL mechanisms where explicitly enabled, i.e. all SALS mechanisms supported and announced by the service will be considered.

Returns:

the enabled SASL mechanisms or null.