org.jivesoftware.smack
Class SmackConfiguration

java.lang.Object
  org.jivesoftware.smack.SmackConfiguration

public final class SmackConfiguration
extends Object

Represents the configuration of Smack. The configuration is used for:

• Initializing classes by loading them at start-up.
• Getting the current Smack version.
• Getting and setting global library behavior, such as the period of time to wait for replies to packets from the server. Note: setting these values via the API will override settings in the configuration file.

Configuration settings are stored in META-INF/smack-config.xml (typically inside the smack.jar file).

Author:

Gaston Dombiak

Method Summary

static void	addSaslMech(String mech) Add a SASL mechanism to the list to be used.
static void	addSaslMechs(Collection<String> mechs) Add a Collection of SASL mechanisms to the list to be used.
static int	getKeepAliveInterval() Returns the number of milleseconds delay between sending keep-alive requests to the server.
static int	getPacketReplyTimeout() Returns the number of milliseconds to wait for a response from the server.
static List<String>	getSaslMechs() Returns the list of SASL mechanisms to be used.
static String	getVersion() Returns the Smack version information, eg "1.3.0".
static boolean	isDnsSecEnabled() Returns whether or not to verify the DNSSEC signatures of host names.
static void	removeSaslMech(String mech) Remove a SASL mechanism from the list to be used.
static void	removeSaslMechs(Collection<String> mechs) Remove a Collection of SASL mechanisms to the list to be used.
static void	setDnsSecEnabled(boolean dnsSecEnabled) Sets whether or not to verify the DNSSEC signatures of host names.
static void	setKeepAliveInterval(int interval) Sets the number of milleseconds delay between sending keep-alive requests to the server.
static void	setPacketReplyTimeout(int timeout) Sets the number of milliseconds to wait for a response from the server.

Methods inherited from class java.lang.Object

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

Method Detail

getVersion

public static String getVersion()

Returns the Smack version information, eg "1.3.0".

Returns:

the Smack version information.

getPacketReplyTimeout

public static int getPacketReplyTimeout()

Returns the number of milliseconds to wait for a response from the server. The default value is 5000 ms.

Returns:

the milliseconds to wait for a response from the server

setPacketReplyTimeout

public static void setPacketReplyTimeout(int timeout)

Sets the number of milliseconds to wait for a response from the server.

Parameters:

timeout - the milliseconds to wait for a response from the server

getKeepAliveInterval

public static int getKeepAliveInterval()

Returns the number of milleseconds delay between sending keep-alive requests to the server. The default value is 30000 ms. A value of -1 mean no keep-alive requests will be sent to the server.

Returns:

the milliseconds to wait between keep-alive requests, or -1 if no keep-alive should be sent.

setKeepAliveInterval

public static void setKeepAliveInterval(int interval)

Sets the number of milleseconds delay between sending keep-alive requests to the server. The default value is 30000 ms. A value of -1 mean no keep-alive requests will be sent to the server.

Parameters:

interval - the milliseconds to wait between keep-alive requests, or -1 if no keep-alive should be sent.

addSaslMech

public static void addSaslMech(String mech)

Add a SASL mechanism to the list to be used.

Parameters:

mech - the SASL mechanism to be added

addSaslMechs

public static void addSaslMechs(Collection<String> mechs)

Add a Collection of SASL mechanisms to the list to be used.

Parameters:

mechs - the Collection of SASL mechanisms to be added

removeSaslMech

public static void removeSaslMech(String mech)

Remove a SASL mechanism from the list to be used.

Parameters:

mech - the SASL mechanism to be removed

removeSaslMechs

public static void removeSaslMechs(Collection<String> mechs)

Remove a Collection of SASL mechanisms to the list to be used.

Parameters:

mechs - the Collection of SASL mechanisms to be removed

getSaslMechs

public static List<String> getSaslMechs()

Returns the list of SASL mechanisms to be used. If a SASL mechanism is listed here it does not guarantee it will be used. The server may not support it, or it may not be implemented.

Returns:

the list of SASL mechanisms to be used.

setDnsSecEnabled

public static void setDnsSecEnabled(boolean dnsSecEnabled)

Sets whether or not to verify the DNSSEC signatures of host names.

Parameters:

dnsSecEnabled - Whether or not to use DNSSEC.

isDnsSecEnabled

public static boolean isDnsSecEnabled()

Returns whether or not to verify the DNSSEC signatures of host names.

Returns:

Whether or not to use DNSSEC.