ConnectionConfiguration (Smack Parent POM 4.1.5 API)

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.

Author:

Gaston Dombiak

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.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 String`	`host`
`protected int`	`port`
`protected ProxyInfo`	`proxy`
`protected String`	`serviceName` Hostname of the XMPP server.

Constructor Summary

Constructors
Modifier Constructor and Description

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

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

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`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.
`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.
`String`	`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.
`String`	`getServiceName()` Returns the server name of the target server.
`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.
`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()` Deprecated. Smack processes the 'optional' element of the session stream feature.
`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
  - serviceName
```
protected final String serviceName
```
    Hostname of the XMPP server. 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.
  - host
```
protected final String 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
```
public 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.ifpossible.
    
    Returns:
    
    the security mode.
  - 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
  - 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 is used.
    
    Returns:
    
    true if the new connection about to be establish is going to be debugged.
  - isLegacySessionDisabled
```
@Deprecated
public boolean isLegacySessionDisabled()
```
    Deprecated. Smack processes the 'optional' element of the session stream feature.
    
    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.
    
    See Also:
    
    ConnectionConfiguration.Builder.setLegacySessionDisabled(boolean)
  - 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.
  - 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 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
  - 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.

Class ConnectionConfiguration

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

serviceName

host

port

proxy

allowNullOrEmptyUsername

Constructor Detail

ConnectionConfiguration

Method Detail

getServiceName

getSecurityMode

getKeystorePath

getKeystoreType

getPKCS11Library

getCustomSSLContext

getEnabledSSLProtocols

getEnabledSSLCiphers

getHostnameVerifier

isDebuggerEnabled

isLegacySessionDisabled

getCallbackHandler

getSocketFactory

getUsername

getPassword

getResource

isSendPresence

isCompressionEnabled