Package org.apache.hadoop.registry.client.impl.zk

Interface ZookeeperConfigOptions

All Known Implementing Classes:

MicroZookeeperService

public interface ZookeeperConfigOptions

Configuration options which are internal to Zookeeper, as well as some other ZK constants

Zookeeper options are passed via system properties prior to the ZK Methods/classes being invoked. This implies that:

1. There can only be one instance of a ZK client or service class in a single JVM —else their configuration options will conflict.
2. It is safest to set these properties immediately before invoking ZK operations.

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	DEFAULT_ZK_ENABLE_SASL_CLIENT	Default flag for the ZK client: "true".
static java.lang.String	PROP_ZK_ALLOW_FAILED_SASL_CLIENTS	should the ZK Server Allow failed SASL clients: "zookeeper.allowSaslFailedClients".
static java.lang.String	PROP_ZK_ENABLE_SASL_CLIENT	Enable SASL secure clients: "zookeeper.sasl.client".
static java.lang.String	PROP_ZK_KINIT_PATH	Path to a kinit binary: "zookeeper.kinit".
static java.lang.String	PROP_ZK_SASL_CLIENT_CONTEXT	System property for the JAAS client context : "zookeeper.sasl.clientconfig".
static java.lang.String	PROP_ZK_SASL_CLIENT_USERNAME	The SASL client username: "zookeeper.sasl.client.username".
static java.lang.String	PROP_ZK_SERVER_MAINTAIN_CONNECTION_DESPITE_SASL_FAILURE	Should ZK Server allow failed SASL clients to downgrade to classic authentication on a SASL auth failure: "zookeeper.maintain_connection_despite_sasl_failure".
static java.lang.String	PROP_ZK_SERVER_REALM	Kerberos realm of the server: "zookeeper.server.realm".
static java.lang.String	PROP_ZK_SERVER_SASL_CONTEXT	The SASL Server context, referring to a context in the JVM's JAAS context file: "zookeeper.sasl.serverconfig"
static java.lang.String	SCHEME_DIGEST	ID scheme for digest auth: "digest".
static java.lang.String	SCHEME_SASL	ID scheme for SASL: "sasl".

Field Detail

PROP_ZK_ENABLE_SASL_CLIENT

static final java.lang.String PROP_ZK_ENABLE_SASL_CLIENT

Enable SASL secure clients: "zookeeper.sasl.client". This is usually set to true, with ZK set to fall back to non-SASL authentication if the SASL auth fails by the property PROP_ZK_SERVER_MAINTAIN_CONNECTION_DESPITE_SASL_FAILURE.

As a result, clients will default to attempting SASL-authentication, but revert to classic authentication/anonymous access on failure.

See Also:

Constant Field Values

DEFAULT_ZK_ENABLE_SASL_CLIENT

static final java.lang.String DEFAULT_ZK_ENABLE_SASL_CLIENT

Default flag for the ZK client: "true".

See Also:

Constant Field Values

PROP_ZK_SASL_CLIENT_CONTEXT

static final java.lang.String PROP_ZK_SASL_CLIENT_CONTEXT

System property for the JAAS client context : "zookeeper.sasl.clientconfig". For SASL authentication to work, this must point to a context within the

Default value is derived from ZKClientConfig.LOGIN_CONTEXT_NAME_KEY

See Also:

Constant Field Values

PROP_ZK_SASL_CLIENT_USERNAME

static final java.lang.String PROP_ZK_SASL_CLIENT_USERNAME

The SASL client username: "zookeeper.sasl.client.username".

Set this to the short name of the client, e.g, "user", not user/host, or user/host@REALM

See Also:

Constant Field Values

PROP_ZK_SERVER_SASL_CONTEXT

static final java.lang.String PROP_ZK_SERVER_SASL_CONTEXT

The SASL Server context, referring to a context in the JVM's JAAS context file: "zookeeper.sasl.serverconfig"

See Also:

Constant Field Values

PROP_ZK_SERVER_MAINTAIN_CONNECTION_DESPITE_SASL_FAILURE

static final java.lang.String PROP_ZK_SERVER_MAINTAIN_CONNECTION_DESPITE_SASL_FAILURE

Should ZK Server allow failed SASL clients to downgrade to classic authentication on a SASL auth failure: "zookeeper.maintain_connection_despite_sasl_failure".

See Also:

Constant Field Values

PROP_ZK_ALLOW_FAILED_SASL_CLIENTS

static final java.lang.String PROP_ZK_ALLOW_FAILED_SASL_CLIENTS

should the ZK Server Allow failed SASL clients: "zookeeper.allowSaslFailedClients".

See Also:

Constant Field Values

PROP_ZK_SERVER_REALM

static final java.lang.String PROP_ZK_SERVER_REALM

Kerberos realm of the server: "zookeeper.server.realm".

See Also:

Constant Field Values

PROP_ZK_KINIT_PATH

static final java.lang.String PROP_ZK_KINIT_PATH

Path to a kinit binary: "zookeeper.kinit". Defaults to "/usr/bin/kinit"

See Also:

Constant Field Values

SCHEME_SASL

static final java.lang.String SCHEME_SASL

ID scheme for SASL: "sasl".

See Also:

Constant Field Values

SCHEME_DIGEST

static final java.lang.String SCHEME_DIGEST

ID scheme for digest auth: "digest".

See Also:

Constant Field Values