Package org.apache.hadoop.crypto.key.kms.server

Class KMSConfiguration

java.lang.Object

org.apache.hadoop.crypto.key.kms.server.KMSConfiguration

@Private
public class KMSConfiguration
extends java.lang.Object

Utility class to load KMS configuration files.

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	CONFIG_PREFIX
static long	CURR_KEY_CACHE_TIMEOUT_DEFAULT
static java.lang.String	CURR_KEY_CACHE_TIMEOUT_KEY
static java.lang.String	DEFAULT_KEY_ACL_PREFIX
static java.lang.String	HTTP_ADMINS_KEY
static java.lang.String	HTTP_HOST_DEFAULT
static java.lang.String	HTTP_HOST_KEY
static int	HTTP_PORT_DEFAULT
static java.lang.String	HTTP_PORT_KEY
static java.lang.String	KEY_ACL_PREFIX
static java.lang.String	KEY_ACL_PREFIX_REGEX
static java.lang.String	KEY_AUTHORIZATION_ENABLE
static boolean	KEY_AUTHORIZATION_ENABLE_DEFAULT
static java.lang.String	KEY_CACHE_ENABLE
static boolean	KEY_CACHE_ENABLE_DEFAULT
static long	KEY_CACHE_TIMEOUT_DEFAULT
static java.lang.String	KEY_CACHE_TIMEOUT_KEY
static java.lang.String	KEY_PROVIDER_URI
static java.lang.String	KMS_ACLS_XML
static java.lang.String	KMS_AUDIT_AGGREGATION_WINDOW
static long	KMS_AUDIT_AGGREGATION_WINDOW_DEFAULT
static java.lang.String	KMS_AUDIT_LOGGER_KEY
static java.lang.String	KMS_CONFIG_DIR
static java.lang.String	KMS_DEFAULT_XML
static java.lang.String	KMS_SITE_XML
static java.lang.String	METRICS_PROCESS_NAME_DEFAULT
static java.lang.String	METRICS_PROCESS_NAME_KEY
static java.lang.String	METRICS_SESSION_ID_KEY
static boolean	SSL_ENABLED_DEFAULT
static java.lang.String	SSL_ENABLED_KEY
static java.lang.String	WHITELIST_KEY_ACL_PREFIX

Constructor Summary

Constructors

Constructor	Description
KMSConfiguration()

Method Summary

Modifier and Type	Method	Description
static org.apache.hadoop.conf.Configuration	getACLsConf()
static org.apache.hadoop.conf.Configuration	getKMSConf()
static boolean	isACLsFileNewer(long time)
static void	validateSystemProps()	Validate whether "kms.config.dir" and "log4j.configuration" are defined in the System properties.

Methods inherited from class java.lang.Object

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

Field Detail

KMS_CONFIG_DIR

public static final java.lang.String KMS_CONFIG_DIR

See Also:

Constant Field Values

KMS_DEFAULT_XML

public static final java.lang.String KMS_DEFAULT_XML

See Also:

Constant Field Values

KMS_SITE_XML

public static final java.lang.String KMS_SITE_XML

See Also:

Constant Field Values

KMS_ACLS_XML

public static final java.lang.String KMS_ACLS_XML

See Also:

Constant Field Values

CONFIG_PREFIX

public static final java.lang.String CONFIG_PREFIX

See Also:

Constant Field Values

KEY_ACL_PREFIX

public static final java.lang.String KEY_ACL_PREFIX

See Also:

Constant Field Values

KEY_ACL_PREFIX_REGEX

public static final java.lang.String KEY_ACL_PREFIX_REGEX

See Also:

Constant Field Values

DEFAULT_KEY_ACL_PREFIX

public static final java.lang.String DEFAULT_KEY_ACL_PREFIX

See Also:

Constant Field Values

WHITELIST_KEY_ACL_PREFIX

public static final java.lang.String WHITELIST_KEY_ACL_PREFIX

See Also:

Constant Field Values

HTTP_PORT_KEY

public static final java.lang.String HTTP_PORT_KEY

See Also:

Constant Field Values

HTTP_PORT_DEFAULT

public static final int HTTP_PORT_DEFAULT

See Also:

Constant Field Values

HTTP_HOST_KEY

public static final java.lang.String HTTP_HOST_KEY

See Also:

Constant Field Values

HTTP_HOST_DEFAULT

public static final java.lang.String HTTP_HOST_DEFAULT

See Also:

Constant Field Values

HTTP_ADMINS_KEY

public static final java.lang.String HTTP_ADMINS_KEY

See Also:

Constant Field Values

SSL_ENABLED_KEY

public static final java.lang.String SSL_ENABLED_KEY

See Also:

Constant Field Values

SSL_ENABLED_DEFAULT

public static final boolean SSL_ENABLED_DEFAULT

See Also:

Constant Field Values

KEY_PROVIDER_URI

public static final java.lang.String KEY_PROVIDER_URI

See Also:

Constant Field Values

KEY_CACHE_ENABLE

public static final java.lang.String KEY_CACHE_ENABLE

See Also:

Constant Field Values

KEY_CACHE_TIMEOUT_KEY

public static final java.lang.String KEY_CACHE_TIMEOUT_KEY

See Also:

Constant Field Values

CURR_KEY_CACHE_TIMEOUT_KEY

public static final java.lang.String CURR_KEY_CACHE_TIMEOUT_KEY

See Also:

Constant Field Values

KMS_AUDIT_AGGREGATION_WINDOW

public static final java.lang.String KMS_AUDIT_AGGREGATION_WINDOW

See Also:

Constant Field Values

METRICS_PROCESS_NAME_KEY

public static final java.lang.String METRICS_PROCESS_NAME_KEY

See Also:

Constant Field Values

METRICS_PROCESS_NAME_DEFAULT

public static final java.lang.String METRICS_PROCESS_NAME_DEFAULT

See Also:

Constant Field Values

METRICS_SESSION_ID_KEY

public static final java.lang.String METRICS_SESSION_ID_KEY

See Also:

Constant Field Values

KMS_AUDIT_LOGGER_KEY

public static final java.lang.String KMS_AUDIT_LOGGER_KEY

See Also:

Constant Field Values

KEY_CACHE_ENABLE_DEFAULT

public static final boolean KEY_CACHE_ENABLE_DEFAULT

See Also:

Constant Field Values

KEY_CACHE_TIMEOUT_DEFAULT

public static final long KEY_CACHE_TIMEOUT_DEFAULT

See Also:

Constant Field Values

CURR_KEY_CACHE_TIMEOUT_DEFAULT

public static final long CURR_KEY_CACHE_TIMEOUT_DEFAULT

See Also:

Constant Field Values

KMS_AUDIT_AGGREGATION_WINDOW_DEFAULT

public static final long KMS_AUDIT_AGGREGATION_WINDOW_DEFAULT

See Also:

Constant Field Values

KEY_AUTHORIZATION_ENABLE

public static final java.lang.String KEY_AUTHORIZATION_ENABLE

See Also:

Constant Field Values

KEY_AUTHORIZATION_ENABLE_DEFAULT

public static final boolean KEY_AUTHORIZATION_ENABLE_DEFAULT

See Also:

Constant Field Values

Constructor Detail

KMSConfiguration

public KMSConfiguration()

Method Detail

getKMSConf

public static org.apache.hadoop.conf.Configuration getKMSConf()

getACLsConf

public static org.apache.hadoop.conf.Configuration getACLsConf()

isACLsFileNewer

public static boolean isACLsFileNewer(long time)

validateSystemProps

public static void validateSystemProps()

Validate whether "kms.config.dir" and "log4j.configuration" are defined in the System properties. If not, abort the KMS WebServer.