org.apache.zookeeper.client

Class ZKClientConfig

java.lang.Object

org.apache.zookeeper.common.ZKConfig

org.apache.zookeeper.client.ZKClientConfig

@InterfaceAudience.Public
public class ZKClientConfig
extends org.apache.zookeeper.common.ZKConfig

Handles client specific properties

Since:

3.5.2

Field Summary

Fields

Modifier and Type	Field and Description
static int	CLIENT_MAX_PACKET_LENGTH_DEFAULT
static java.lang.String	DISABLE_AUTO_WATCH_RESET This controls whether automatic watch resetting is enabled.
static java.lang.String	ENABLE_CLIENT_SASL_DEFAULT
static java.lang.String	ENABLE_CLIENT_SASL_KEY
static java.lang.String	LOGIN_CONTEXT_NAME_KEY
static java.lang.String	LOGIN_CONTEXT_NAME_KEY_DEFAULT
static java.lang.String	SECURE_CLIENT Setting this to "true" will enable encrypted client-server communication.
static java.lang.String	ZK_SASL_CLIENT_USERNAME
static java.lang.String	ZK_SASL_CLIENT_USERNAME_DEFAULT
static java.lang.String	ZOOKEEPER_CLIENT_CNXN_SOCKET
static java.lang.String	ZOOKEEPER_SERVER_REALM

Fields inherited from class org.apache.zookeeper.common.ZKConfig

JGSS_NATIVE, JUTE_MAXBUFFER, KINIT_COMMAND, SSL_AUTHPROVIDER, SSL_KEYSTORE_LOCATION, SSL_KEYSTORE_PASSWD, SSL_TRUSTSTORE_LOCATION, SSL_TRUSTSTORE_PASSWD

Constructor Summary

Constructors

Constructor and Description
ZKClientConfig()
ZKClientConfig(java.io.File configFile)
ZKClientConfig(java.lang.String configPath)

Method Summary

Modifier and Type	Method and Description
boolean	isSaslClientEnabled() Returns true if the SASL client is enabled.

Methods inherited from class org.apache.zookeeper.common.ZKConfig

addConfiguration, addConfiguration, getBoolean, getInt, getJaasConfKey, getProperty, getProperty, setProperty

Methods inherited from class java.lang.Object

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

Field Detail

ZK_SASL_CLIENT_USERNAME

public static final java.lang.String ZK_SASL_CLIENT_USERNAME

See Also:

Constant Field Values

ZK_SASL_CLIENT_USERNAME_DEFAULT

public static final java.lang.String ZK_SASL_CLIENT_USERNAME_DEFAULT

See Also:

Constant Field Values

LOGIN_CONTEXT_NAME_KEY

public static final java.lang.String LOGIN_CONTEXT_NAME_KEY

See Also:

Constant Field Values

LOGIN_CONTEXT_NAME_KEY_DEFAULT

public static final java.lang.String LOGIN_CONTEXT_NAME_KEY_DEFAULT

See Also:

Constant Field Values

ENABLE_CLIENT_SASL_KEY

public static final java.lang.String ENABLE_CLIENT_SASL_KEY

See Also:

Constant Field Values

ENABLE_CLIENT_SASL_DEFAULT

public static final java.lang.String ENABLE_CLIENT_SASL_DEFAULT

See Also:

Constant Field Values

ZOOKEEPER_SERVER_REALM

public static final java.lang.String ZOOKEEPER_SERVER_REALM

See Also:

Constant Field Values

DISABLE_AUTO_WATCH_RESET

public static final java.lang.String DISABLE_AUTO_WATCH_RESET

This controls whether automatic watch resetting is enabled. Clients automatically reset watches during session reconnect, this option allows the client to turn off this behavior by setting the property "zookeeper.disableAutoWatchReset" to "true"

See Also:

Constant Field Values

ZOOKEEPER_CLIENT_CNXN_SOCKET

public static final java.lang.String ZOOKEEPER_CLIENT_CNXN_SOCKET

See Also:

Constant Field Values

SECURE_CLIENT

public static final java.lang.String SECURE_CLIENT

Setting this to "true" will enable encrypted client-server communication.

See Also:

Constant Field Values

CLIENT_MAX_PACKET_LENGTH_DEFAULT

public static final int CLIENT_MAX_PACKET_LENGTH_DEFAULT

See Also:

Constant Field Values

Constructor Detail

ZKClientConfig

public ZKClientConfig()

ZKClientConfig

public ZKClientConfig(java.io.File configFile)
               throws org.apache.zookeeper.server.quorum.QuorumPeerConfig.ConfigException

Throws:

org.apache.zookeeper.server.quorum.QuorumPeerConfig.ConfigException

ZKClientConfig

public ZKClientConfig(java.lang.String configPath)
               throws org.apache.zookeeper.server.quorum.QuorumPeerConfig.ConfigException

Throws:

org.apache.zookeeper.server.quorum.QuorumPeerConfig.ConfigException

Method Detail

isSaslClientEnabled

public boolean isSaslClientEnabled()

Returns true if the SASL client is enabled. By default, the client is enabled but can be disabled by setting the system property zookeeper.sasl.client to false. See ZOOKEEPER-1657 for more information.

Returns:

true if the SASL client is enabled.