Package org.apache.accumulo.core.conf

Enum ClientProperty

java.lang.Object

java.lang.Enum<ClientProperty>

org.apache.accumulo.core.conf.ClientProperty

All Implemented Interfaces:

Serializable, Comparable<ClientProperty>

public enum ClientProperty
extends Enum<ClientProperty>

Enum Constant Summary

Enum Constants

Enum Constant	Description
AUTH_PRINCIPAL
AUTH_TOKEN
AUTH_TYPE
BATCH_SCANNER_NUM_QUERY_THREADS
BATCH_WRITER_DURABILITY
BATCH_WRITER_LATENCY_MAX
BATCH_WRITER_MEMORY_MAX
BATCH_WRITER_THREADS_MAX
BATCH_WRITER_TIMEOUT_MAX
BULK_LOAD_THREADS
INSTANCE_NAME
INSTANCE_ZOOKEEPERS
INSTANCE_ZOOKEEPERS_TIMEOUT
SASL_ENABLED
SASL_KERBEROS_SERVER_PRIMARY
SASL_QOP
SCANNER_BATCH_SIZE
SSL_ENABLED
SSL_KEYSTORE_PASSWORD
SSL_KEYSTORE_PATH
SSL_KEYSTORE_TYPE
SSL_TRUSTSTORE_PASSWORD
SSL_TRUSTSTORE_PATH
SSL_TRUSTSTORE_TYPE
SSL_USE_JSSE
TRACE_SPAN_RECEIVERS
TRACE_ZOOKEEPER_PATH

Field Summary

Fields

Modifier and Type	Field	Description
static String	TRACE_SPAN_RECEIVER_PREFIX

Method Summary

Modifier and Type	Method	Description
static AuthenticationToken	decodeToken(String className, String tokenString)
static String	encodeToken(AuthenticationToken token)
static AuthenticationToken	getAuthenticationToken(Properties properties)
boolean	getBoolean(Properties properties)
Long	getBytes(Properties properties)
String	getDefaultValue()
String	getDescription()
Integer	getInteger(Properties properties)
String	getKey()
static Properties	getPrefix(Properties properties, String prefix)
String	getSince()
Long	getTimeInMillis(Properties properties)
PropertyType	getType()
String	getValue(Properties properties)
boolean	isEmpty(Properties properties)
boolean	isRequired()
static void	setAuthenticationToken(Properties properties, AuthenticationToken token)
void	setBytes(Properties properties, Long bytes)
static void	setKerberosKeytab(Properties properties, String keytabPath)
static void	setPassword(Properties properties, CharSequence password)
void	setTimeInMillis(Properties properties, Long milliseconds)
static Map<String,String>	toMap(Properties properties)
static void	validate(Properties properties)
static void	validate(Properties properties, boolean validateToken)
static void	validateProperty(Properties properties, ClientProperty prop)
static ClientProperty	valueOf(String name)	Returns the enum constant of this type with the specified name.
static ClientProperty[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

INSTANCE_NAME

public static final ClientProperty INSTANCE_NAME

INSTANCE_ZOOKEEPERS

public static final ClientProperty INSTANCE_ZOOKEEPERS

INSTANCE_ZOOKEEPERS_TIMEOUT

public static final ClientProperty INSTANCE_ZOOKEEPERS_TIMEOUT

AUTH_TYPE

public static final ClientProperty AUTH_TYPE

AUTH_PRINCIPAL

public static final ClientProperty AUTH_PRINCIPAL

AUTH_TOKEN

public static final ClientProperty AUTH_TOKEN

BATCH_WRITER_MEMORY_MAX

public static final ClientProperty BATCH_WRITER_MEMORY_MAX

BATCH_WRITER_LATENCY_MAX

public static final ClientProperty BATCH_WRITER_LATENCY_MAX

BATCH_WRITER_TIMEOUT_MAX

public static final ClientProperty BATCH_WRITER_TIMEOUT_MAX

BATCH_WRITER_THREADS_MAX

public static final ClientProperty BATCH_WRITER_THREADS_MAX

BATCH_WRITER_DURABILITY

public static final ClientProperty BATCH_WRITER_DURABILITY

SCANNER_BATCH_SIZE

public static final ClientProperty SCANNER_BATCH_SIZE

BATCH_SCANNER_NUM_QUERY_THREADS

public static final ClientProperty BATCH_SCANNER_NUM_QUERY_THREADS

BULK_LOAD_THREADS

public static final ClientProperty BULK_LOAD_THREADS

SSL_ENABLED

public static final ClientProperty SSL_ENABLED

SSL_KEYSTORE_PASSWORD

public static final ClientProperty SSL_KEYSTORE_PASSWORD

SSL_KEYSTORE_PATH

public static final ClientProperty SSL_KEYSTORE_PATH

SSL_KEYSTORE_TYPE

public static final ClientProperty SSL_KEYSTORE_TYPE

SSL_TRUSTSTORE_PASSWORD

public static final ClientProperty SSL_TRUSTSTORE_PASSWORD

SSL_TRUSTSTORE_PATH

public static final ClientProperty SSL_TRUSTSTORE_PATH

SSL_TRUSTSTORE_TYPE

public static final ClientProperty SSL_TRUSTSTORE_TYPE

SSL_USE_JSSE

public static final ClientProperty SSL_USE_JSSE

SASL_ENABLED

public static final ClientProperty SASL_ENABLED

SASL_QOP

public static final ClientProperty SASL_QOP

SASL_KERBEROS_SERVER_PRIMARY

public static final ClientProperty SASL_KERBEROS_SERVER_PRIMARY

TRACE_SPAN_RECEIVERS

public static final ClientProperty TRACE_SPAN_RECEIVERS

TRACE_ZOOKEEPER_PATH

public static final ClientProperty TRACE_ZOOKEEPER_PATH

Field Detail

TRACE_SPAN_RECEIVER_PREFIX

public static final String TRACE_SPAN_RECEIVER_PREFIX

See Also:

Constant Field Values

Method Detail

values

public static ClientProperty[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (ClientProperty c : ClientProperty.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static ClientProperty valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getKey

public String getKey()

getDefaultValue

public String getDefaultValue()

getType

public PropertyType getType()

getDescription

public String getDescription()

getSince

public String getSince()

isRequired

public boolean isRequired()

getValue

public String getValue(Properties properties)

isEmpty

public boolean isEmpty(Properties properties)

getBytes

public Long getBytes(Properties properties)

getTimeInMillis

public Long getTimeInMillis(Properties properties)

getInteger

public Integer getInteger(Properties properties)

getBoolean

public boolean getBoolean(Properties properties)

setBytes

public void setBytes(Properties properties,
                     Long bytes)

setTimeInMillis

public void setTimeInMillis(Properties properties,
                            Long milliseconds)

getPrefix

public static Properties getPrefix(Properties properties,
                                   String prefix)

toMap

public static Map<String,String> toMap(Properties properties)

encodeToken

public static String encodeToken(AuthenticationToken token)

decodeToken

public static AuthenticationToken decodeToken(String className,
                                              String tokenString)

setPassword

public static void setPassword(Properties properties,
                               CharSequence password)

setKerberosKeytab

public static void setKerberosKeytab(Properties properties,
                                     String keytabPath)

getAuthenticationToken

public static AuthenticationToken getAuthenticationToken(Properties properties)

setAuthenticationToken

public static void setAuthenticationToken(Properties properties,
                                          AuthenticationToken token)

validateProperty

public static void validateProperty(Properties properties,
                                    ClientProperty prop)

validate

public static void validate(Properties properties,
                            boolean validateToken)

validate

public static void validate(Properties properties)

Throws:

IllegalArgumentException - if Properties does not contain all required