Package org.apache.zookeeper.client
Class ZKClientConfig
java.lang.Object
org.apache.zookeeper.common.ZKConfig
org.apache.zookeeper.client.ZKClientConfig
Handles client specific properties
- Since:
- 3.5.2
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final int
static final String
This controls whether automatic watch resetting is enabled.static final String
static final String
static final String
static final String
static final String
Setting this to "true" will enable encrypted client-server communication.static final String
static final String
static final String
static final String
static final String
static final String
static final long
Feature is disabled by default.static final String
static final String
Fields inherited from class org.apache.zookeeper.common.ZKConfig
JGSS_NATIVE, JUTE_MAXBUFFER, KINIT_COMMAND
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionlong
Get the value of thekey
property as anlong
.protected void
Now onwards client code will use properties from this class but older clients still be setting properties through system properties.boolean
Returns true if the SASL client is enabled.Methods inherited from class org.apache.zookeeper.common.ZKConfig
addConfiguration, addConfiguration, getBoolean, getBoolean, getInt, getJaasConfKey, getProperty, getProperty, setProperty
-
Field Details
-
ZK_SASL_CLIENT_USERNAME
- See Also:
-
ZK_SASL_CLIENT_USERNAME_DEFAULT
- See Also:
-
ZK_SASL_CLIENT_CANONICALIZE_HOSTNAME
- See Also:
-
ZK_SASL_CLIENT_CANONICALIZE_HOSTNAME_DEFAULT
- See Also:
-
LOGIN_CONTEXT_NAME_KEY
- See Also:
-
LOGIN_CONTEXT_NAME_KEY_DEFAULT
- See Also:
-
ENABLE_CLIENT_SASL_KEY
- See Also:
-
ENABLE_CLIENT_SASL_DEFAULT
- See Also:
-
ZOOKEEPER_SERVER_REALM
- See Also:
-
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:
-
ZOOKEEPER_CLIENT_CNXN_SOCKET
- See Also:
-
SECURE_CLIENT
Setting this to "true" will enable encrypted client-server communication.- See Also:
-
CLIENT_MAX_PACKET_LENGTH_DEFAULT
public static final int CLIENT_MAX_PACKET_LENGTH_DEFAULT- See Also:
-
ZOOKEEPER_REQUEST_TIMEOUT
- See Also:
-
ZOOKEEPER_SERVER_PRINCIPAL
- See Also:
-
ZOOKEEPER_REQUEST_TIMEOUT_DEFAULT
public static final long ZOOKEEPER_REQUEST_TIMEOUT_DEFAULTFeature is disabled by default.- See Also:
-
-
Constructor Details
-
ZKClientConfig
public ZKClientConfig() -
ZKClientConfig
- Throws:
QuorumPeerConfig.ConfigException
-
ZKClientConfig
- Throws:
QuorumPeerConfig.ConfigException
-
-
Method Details
-
handleBackwardCompatibility
protected void handleBackwardCompatibility()Description copied from class:ZKConfig
Now onwards client code will use properties from this class but older clients still be setting properties through system properties. So to make this change backward compatible we should set old system properties in this configuration.- Overrides:
handleBackwardCompatibility
in classZKConfig
-
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 propertyzookeeper.sasl.client
tofalse
. See ZOOKEEPER-1657 for more information.- Returns:
- true if the SASL client is enabled.
-
getLong
Get the value of thekey
property as anlong
. If property is not set, the provideddefaultValue
is returned- Parameters:
key
- property key.defaultValue
- default value.- Returns:
- return property value as an
long
, ordefaultValue
- Throws:
NumberFormatException
- when the value is invalid
-