Package org.jivesoftware.smack

Class ConnectionConfiguration

java.lang.Object
org.jivesoftware.smack.ConnectionConfiguration
Direct Known Subclasses:
BOSHConfiguration, ModularXmppClientToServerConnectionConfiguration, XMPPTCPConnectionConfiguration
public abstract class ConnectionConfiguration extends Object
The connection configuration used for XMPP client-to-server connections. A well configured XMPP service will typically only require you to provide two parameters: The XMPP address, also known as the JID, of the user and the password. All other configuration parameters could ideally be determined automatically by Smack. Hence, it is often enough to call ConnectionConfiguration.Builder.setXmppAddressAndPassword(CharSequence, String).

Technically there are typically at least two parameters required: Some kind of credentials for authentication. And the XMPP service domain. The credentials often consists of a username and password use for the SASL authentication. But there are also other authentication mechanisms, like client side certificates, which do not require a particular username and password.

There are some misconceptions about XMPP client-to-server parameters: The first is that the username used for authentication will be equal to the localpart of the bound XMPP address after authentication. While this is usually true, it is not required. Technically the username used for authentication and the resulting XMPP address are completely independent from each other. The second common misconception steers from the terms "XMPP host" and "XMPP service domain": An XMPP service host is a system which hosts one or multiple XMPP domains. The "XMPP service domain" will be usually the domainpart of the bound JID. This domain is used to verify the remote endpoint, typically using TLS. This third misconception is that the XMPP service domain is required to become the domainpart of the bound JID. Again, while this is very common to be true, it is not strictly required.

  • Field Details

  • Constructor Details

  • Method Details

    • getHostString

      public String getHostString()

    • getHost

      public DnsName getHost()

    • getHostAddress

      public InetAddress getHostAddress()

    • getPort

      public UInt16 getPort()

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

    • getXmppServiceDomainAsDnsNameIfPossible

      public DnsName getXmppServiceDomainAsDnsNameIfPossible()
      Returns the XMPP service domain as DNS name if possible. Note that since not every XMPP address domainpart is a valid DNS name, this method may return null.
      Returns:
      the XMPP service domain as DNS name or null.
      Since:
      4.3.4

    • getSecurityMode

      public ConnectionConfiguration.SecurityMode getSecurityMode()
      Returns the TLS security mode used when making the connection. By default, the mode is ConnectionConfiguration.SecurityMode.required.
      Returns:
      the security mode.

    • getDnssecMode

      public ConnectionConfiguration.DnssecMode getDnssecMode()

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

    • getLanguage

      public Locale getLanguage()
      Returns the stream language to use when connecting to the server.
      Returns:
      the stream language to use when connecting to the server or null.

    • getXmlLang

      public String getXmlLang()
      Returns the xml:lang string of the stream language to use when connecting to the server.

      If the developer sets the language to null, this will also return null, leading to the removal of the xml:lang tag from the stream.

      Returns:
      the stream language to use when connecting to the server or null.

    • 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:

    • 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 mechanism is enabled in this connection configuration.
      Parameters:
      saslMechanism - TODO javadoc me please
      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 SASL mechanisms supported and announced by the service will be considered.
      Returns:
      the enabled SASL mechanisms or null.