ConnectionConfiguration.Builder (smack-core 4.2.0-beta2 API)

java.lang.Object
- org.jivesoftware.smack.ConnectionConfiguration.Builder<B,C>

Type Parameters:

B - the builder type parameter.

C - the resulting connection configuration type parameter.

Enclosing class:

ConnectionConfiguration
```
public abstract static class ConnectionConfiguration.Builder<B extends ConnectionConfiguration.Builder<B,C>,C extends ConnectionConfiguration>
extends java.lang.Object
```
A builder for XMPP connection configurations.
This is an abstract class that uses the builder design pattern and the "getThis() trick" to recover the type of the builder in a class hierarchies with a self-referential generic supertype. Otherwise chaining of build instructions from the superclasses followed by build instructions of a sublcass would not be possible, because the superclass build instructions would return the builder of the superclass and not the one of the subclass. You can read more about it a Angelika Langer's Generics FAQ, especially the entry What is the "getThis()" trick?.

Constructor Summary

Constructors
Modifier Constructor and Description

protected Builder()

Constructors
Modifier	Constructor and Description
`protected`	`Builder()`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`B`	`addEnabledSaslMechanism(java.util.Collection<java.lang.String> saslMechanisms)` Enable the given SASL mechanisms.
`B`	`addEnabledSaslMechanism(java.lang.String saslMechanism)` Add the given mechanism to the enabled ones.
`B`	`allowEmptyOrNullUsernames()` Allow `null` or the empty String as username.
`abstract C`	`build()`
`protected abstract B`	`getThis()`
`B`	`performSaslAnonymousAuthentication()` Perform anonymous authentication using SASL ANONYMOUS.
`B`	`performSaslExternalAuthentication(javax.net.ssl.SSLContext sslContext)` Perform authentication using SASL EXTERNAL.
`B`	`setAuthzid(org.jxmpp.jid.EntityBareJid authzid)` Set the XMPP address to be used as authorization identity.
`B`	`setCallbackHandler(javax.security.auth.callback.CallbackHandler callbackHandler)` Sets a CallbackHandler to obtain information, such as the password or principal information during the SASL authentication.
`B`	`setCustomSSLContext(javax.net.ssl.SSLContext context)` Sets a custom SSLContext for creating SSL sockets.
`B`	`setDebuggerEnabled(boolean debuggerEnabled)` Sets if the new connection about to be establish is going to be debugged.
`B`	`setEnabledSSLCiphers(java.lang.String[] enabledSSLCiphers)` Set the enabled SSL/TLS ciphers.
`B`	`setEnabledSSLProtocols(java.lang.String[] enabledSSLProtocols)` Set the enabled SSL/TLS protocols.
`B`	`setHost(java.lang.String host)`
`B`	`setHostnameVerifier(javax.net.ssl.HostnameVerifier verifier)` Set the HostnameVerifier used to verify the hostname of SSLSockets used by XMPP connections created with this ConnectionConfiguration.
`B`	`setKeystorePath(java.lang.String keystorePath)` Sets the path to the keystore file.
`B`	`setKeystoreType(java.lang.String keystoreType)` Sets the keystore type.
`B`	`setLegacySessionDisabled(boolean legacySessionDisabled)` Deprecated. Smack processes the 'optional' element of the session stream feature.
`B`	`setPKCS11Library(java.lang.String pkcs11Library)` Sets the PKCS11 library file location, needed when the Keystore type is PKCS11.
`B`	`setPort(int port)`
`B`	`setProxyInfo(ProxyInfo proxyInfo)` Set the information about the Proxy used for the connection.
`B`	`setResource(java.lang.CharSequence resource)` Set the resource to use.
`B`	`setResource(org.jxmpp.jid.parts.Resourcepart resource)` Set the resource to use.
`B`	`setSecurityMode(ConnectionConfiguration.SecurityMode securityMode)` Sets the TLS security mode used when making the connection.
`B`	`setSendPresence(boolean sendPresence)` Sets if an initial available presence will be sent to the server.
`B`	`setServiceName(org.jxmpp.jid.DomainBareJid serviceName)` Deprecated. use `setXmppDomain(DomainBareJid)` instead.
`B`	`setSocketFactory(javax.net.SocketFactory socketFactory)` Sets the socket factory used to create new xmppConnection sockets.
`B`	`setUsernameAndPassword(java.lang.CharSequence username, java.lang.String password)` Set the XMPP entities username and password.
`B`	`setXmppDomain(org.jxmpp.jid.DomainBareJid xmppServiceDomain)` Set the service name of this XMPP service (i.e., the XMPP domain).

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Builder
```
protected Builder()
```
- Method Detail
  - setUsernameAndPassword
```
public B setUsernameAndPassword(java.lang.CharSequence username,
                                java.lang.String password)
```
    Set the XMPP entities username and password.
    The username is usually the localpart of the clients JID. But some SASL mechanisms or services may require a different format (e.g. the full JID) as used authorization identity.
    
    Parameters:
    
    username - the username or authorization identity
    
    password - the password or token used to authenticate
    
    Returns:
    
    a reference to this builder.
  - setServiceName
```
@Deprecated
public B setServiceName(org.jxmpp.jid.DomainBareJid serviceName)
```
    Deprecated. use setXmppDomain(DomainBareJid) instead.
    
    Set the service name of this XMPP service (i.e., the XMPP domain).
    
    Parameters:
    
    serviceName - the service name
    
    Returns:
    
    a reference to this builder.
  - setXmppDomain
```
public B setXmppDomain(org.jxmpp.jid.DomainBareJid xmppServiceDomain)
```
    Set the service name of this XMPP service (i.e., the XMPP domain).
    
    Parameters:
    
    xmppServiceDomain - the service name
    
    Returns:
    
    a reference to this builder.
  - setResource
```
public B setResource(org.jxmpp.jid.parts.Resourcepart resource)
```
    Set the resource to use.
    If resource is null, then the server will automatically create a resource for the client. Default resource is "Smack".
    
    Parameters:
    
    resource - the resource to use.
    
    Returns:
    
    a reference to this builder.
  - setResource
```
public B setResource(java.lang.CharSequence resource)
              throws org.jxmpp.stringprep.XmppStringprepException
```
    Set the resource to use.
    
    Parameters:
    
    resource - the non-null CharSequence to use a resource.
    
    Returns:
    
    a reference ot this builder.
    
    Throws:
    
    org.jxmpp.stringprep.XmppStringprepException - if the CharSequence is not a valid resourcepart.
    
    See Also:
    
    setResource(Resourcepart)
  - setHost
```
public B setHost(java.lang.String host)
```
  - setPort
```
public B setPort(int port)
```
  - setCallbackHandler
```
public B 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.
    
    Returns:
    
    a reference to this builder.
  - setSecurityMode
```
public B setSecurityMode(ConnectionConfiguration.SecurityMode securityMode)
```
    Sets the TLS security mode used when making the connection. By default, the mode is ConnectionConfiguration.SecurityMode.ifpossible.
    
    Parameters:
    
    securityMode - the security mode.
    
    Returns:
    
    a reference to this builder.
  - setKeystorePath
```
public B 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.
    
    Returns:
    
    a reference to this builder.
  - setKeystoreType
```
public B setKeystoreType(java.lang.String keystoreType)
```
    Sets the keystore type.
    
    Parameters:
    
    keystoreType - the keystore type.
    
    Returns:
    
    a reference to this builder.
  - setPKCS11Library
```
public B 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.
    
    Returns:
    
    a reference to this builder.
  - setCustomSSLContext
```
public B 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.
    
    Returns:
    
    a reference to this builder.
  - setEnabledSSLProtocols
```
public B setEnabledSSLProtocols(java.lang.String[] enabledSSLProtocols)
```
    Set the enabled SSL/TLS protocols.
    
    Parameters:
    
    enabledSSLProtocols -
    
    Returns:
    
    a reference to this builder.
  - setEnabledSSLCiphers
```
public B setEnabledSSLCiphers(java.lang.String[] enabledSSLCiphers)
```
    Set the enabled SSL/TLS ciphers.
    
    Parameters:
    
    enabledSSLCiphers - the enabled SSL/TLS ciphers
    
    Returns:
    
    a reference to this builder.
  - setHostnameVerifier
```
public B setHostnameVerifier(javax.net.ssl.HostnameVerifier verifier)
```
    Set the HostnameVerifier used to verify the hostname of SSLSockets used by XMPP connections created with this ConnectionConfiguration.
    
    Parameters:
    
    verifier -
    
    Returns:
    
    a reference to this builder.
  - setLegacySessionDisabled
```
@Deprecated
public B setLegacySessionDisabled(boolean legacySessionDisabled)
```
    Deprecated. Smack processes the 'optional' element of the session stream feature.
    
    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.
    Deprecation notice: This setting is no longer required in most cases because Smack processes the 'optional' element eventually found in the session stream feature. See also Here Lies Extensible Messaging and Presence Protocol (XMPP) Session Establishment
    
    Parameters:
    
    legacySessionDisabled - if a session has to be requested when logging in.
    
    Returns:
    
    a reference to this builder.
  - setSendPresence
```
public B 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.
    
    Returns:
    
    a reference to this builder.
  - setDebuggerEnabled
```
public B setDebuggerEnabled(boolean debuggerEnabled)
```
    Sets if the new connection about to be establish is going to be debugged. By default the value of SmackConfiguration.DEBUG is used.
    
    Parameters:
    
    debuggerEnabled - if the new connection about to be establish is going to be debugged.
    
    Returns:
    
    a reference to this builder.
  - setSocketFactory
```
public B 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.
    
    Returns:
    
    a reference to this builder.
  - setProxyInfo
```
public B setProxyInfo(ProxyInfo proxyInfo)
```
    Set the information about the Proxy used for the connection.
    
    Parameters:
    
    proxyInfo - the Proxy information.
    
    Returns:
    
    a reference to this builder.
  - allowEmptyOrNullUsernames
```
public B allowEmptyOrNullUsernames()
```
    Allow null or the empty String as username. Some SASL mechanisms (e.g. SASL External) may also signal the username (as "authorization identity"), in which case Smack should not throw an IllegalArgumentException when the username is not set.
    
    Returns:
    
    a reference to this builder.
  - performSaslAnonymousAuthentication
```
public B performSaslAnonymousAuthentication()
```
    Perform anonymous authentication using SASL ANONYMOUS. Your XMPP service must support this authentication mechanism. This method also calls addEnabledSaslMechanism(String) with "ANONYMOUS" as argument.
    
    Returns:
    
    a reference to this builder.
  - performSaslExternalAuthentication
```
public B performSaslExternalAuthentication(javax.net.ssl.SSLContext sslContext)
```
    Perform authentication using SASL EXTERNAL. Your XMPP service must support this authentication mechanism. This method also calls addEnabledSaslMechanism(String) with "EXTERNAL" as argument. It also calls allowEmptyOrNullUsernames() and setSecurityMode(ConnectionConfiguration.SecurityMode) to ConnectionConfiguration.SecurityMode.required.
    
    Returns:
    
    a reference to this builder.
  - addEnabledSaslMechanism
```
public B addEnabledSaslMechanism(java.lang.String saslMechanism)
```
    Add the given mechanism to the enabled ones. See addEnabledSaslMechanism(Collection) for a discussion about enabled SASL mechanisms.
    
    Parameters:
    
    saslMechanism - the name of the mechanism to enable.
    
    Returns:
    
    a reference to this builder.
  - addEnabledSaslMechanism
```
public B addEnabledSaslMechanism(java.util.Collection<java.lang.String> saslMechanisms)
```
    Enable the given SASL mechanisms. If you never add a mechanism to the set of enabled ones, all mechanisms known to Smack will be enabled. Only explicitly enable particular SASL mechanisms if you want to limit the used mechanisms to the enabled ones.
    
    Parameters:
    
    saslMechanisms - a collection of names of mechanisms to enable.
    
    Returns:
    
    a reference to this builder.
  - setAuthzid
```
public B setAuthzid(org.jxmpp.jid.EntityBareJid authzid)
```
    Set the XMPP address to be used as authorization identity.
    In XMPP, authorization identities are bare jids. In general, callers should allow the server to select the authorization identifier automatically, and not call this. Note that setting the authzid does not set the XMPP service domain, which should typically match. Calling this will also SASL CRAM, since this mechanism does not support authzid.
    
    Parameters:
    
    authzid - The BareJid to be requested as the authorization identifier.
    
    Returns:
    
    a reference to this builder.
    
    Since:
    
    4.2
    
    See Also:
    
    RFC 6120 § 6.3.8. Authorization Identity
  - build
```
public abstract C build()
```
  - getThis
```
protected abstract B getThis()
```

Class ConnectionConfiguration.Builder<B extends ConnectionConfiguration.Builder<B,C>,C extends ConnectionConfiguration>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Builder

Method Detail

setUsernameAndPassword

setServiceName

setXmppDomain

setResource

setResource

setHost

setPort

setCallbackHandler

setSecurityMode

setKeystorePath

setKeystoreType

setPKCS11Library

setCustomSSLContext

setEnabledSSLProtocols

setEnabledSSLCiphers

setHostnameVerifier

setLegacySessionDisabled

setSendPresence

setDebuggerEnabled

setSocketFactory

setProxyInfo

allowEmptyOrNullUsernames

performSaslAnonymousAuthentication

performSaslExternalAuthentication

addEnabledSaslMechanism

addEnabledSaslMechanism

setAuthzid

build

getThis