com.github.ambry.config

Class HelixAccountServiceConfig

java.lang.Object

com.github.ambry.config.HelixAccountServiceConfig

public class HelixAccountServiceConfig
extends java.lang.Object

Config for HelixAccountServiceConfig

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	BACKFILL_ACCOUNTS_TO_NEW_ZNODE
boolean	backFillAccountsToNewZNode If true, HelixAccountService would persist account metadata to ambry-server upon receiving the account metadata change message.
static java.lang.String	BACKUP_DIRECTORY_KEY
java.lang.String	backupDir The directory on the local machine where account data backups will be stored before updating accounts.
static java.lang.String	ENABLE_SERVE_FROM_BACKUP
boolean	enableServeFromBackup If true, HelixAccountService would load the account metadata from local backup file when fetching from helix fails.
static java.lang.String	HELIX_ACCOUNT_SERVICE_PREFIX
static java.lang.String	MAX_BACKUP_FILE_COUNT
int	maxBackupFileCount The maximum number of local backup files kept in disk.
static java.lang.String	TOTAL_NUMBER_OF_VERSION_TO_KEEP
int	totalNumberOfVersionToKeep Total number of previous versions of account metadata to keep in the system.
static java.lang.String	UPDATE_DISABLED
boolean	updateDisabled If true, HelixAccountService would reject all the requests to update accounts.
static java.lang.String	UPDATER_POLLING_INTERVAL_MS_KEY
static java.lang.String	UPDATER_SHUT_DOWN_TIMEOUT_MS_KEY
int	updaterPollingIntervalMs The time interval in second between two consecutive account pulling for the background account updater of HelixAccountService.
int	updaterShutDownTimeoutMs The timeout in ms to shut down the account updater of HelixAccountService.
static java.lang.String	USE_NEW_ZNODE_PATH
boolean	useNewZNodePath If true, then use the new znode path to store list of blob ids that point to account metadata content.
static java.lang.String	ZK_CLIENT_CONNECT_STRING_KEY
java.lang.String	zkClientConnectString The ZooKeeper server address.

Constructor Summary

Constructors

Constructor and Description
HelixAccountServiceConfig(VerifiableProperties verifiableProperties)

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

HELIX_ACCOUNT_SERVICE_PREFIX

public static final java.lang.String HELIX_ACCOUNT_SERVICE_PREFIX

See Also:

Constant Field Values

UPDATER_POLLING_INTERVAL_MS_KEY

public static final java.lang.String UPDATER_POLLING_INTERVAL_MS_KEY

See Also:

Constant Field Values

UPDATER_SHUT_DOWN_TIMEOUT_MS_KEY

public static final java.lang.String UPDATER_SHUT_DOWN_TIMEOUT_MS_KEY

See Also:

Constant Field Values

BACKUP_DIRECTORY_KEY

public static final java.lang.String BACKUP_DIRECTORY_KEY

See Also:

Constant Field Values

MAX_BACKUP_FILE_COUNT

public static final java.lang.String MAX_BACKUP_FILE_COUNT

See Also:

Constant Field Values

ZK_CLIENT_CONNECT_STRING_KEY

public static final java.lang.String ZK_CLIENT_CONNECT_STRING_KEY

See Also:

Constant Field Values

USE_NEW_ZNODE_PATH

public static final java.lang.String USE_NEW_ZNODE_PATH

See Also:

Constant Field Values

UPDATE_DISABLED

public static final java.lang.String UPDATE_DISABLED

See Also:

Constant Field Values

BACKFILL_ACCOUNTS_TO_NEW_ZNODE

public static final java.lang.String BACKFILL_ACCOUNTS_TO_NEW_ZNODE

See Also:

Constant Field Values

ENABLE_SERVE_FROM_BACKUP

public static final java.lang.String ENABLE_SERVE_FROM_BACKUP

See Also:

Constant Field Values

TOTAL_NUMBER_OF_VERSION_TO_KEEP

public static final java.lang.String TOTAL_NUMBER_OF_VERSION_TO_KEEP

See Also:

Constant Field Values

zkClientConnectString

@Config(value="helix.account.service.zk.client.connect.string")
public final java.lang.String zkClientConnectString

The ZooKeeper server address. This config is required when using HelixAccountService.

updaterPollingIntervalMs

@Config(value="helix.account.service.updater.polling.interval.ms")
 @Default(value="60 * 60 * 1000")
public final int updaterPollingIntervalMs

The time interval in second between two consecutive account pulling for the background account updater of HelixAccountService. Setting to 0 to disable it.

updaterShutDownTimeoutMs

@Config(value="helix.account.service.updater.shut.down.timeout.ms")
 @Default(value="60 * 1000")
public final int updaterShutDownTimeoutMs

The timeout in ms to shut down the account updater of HelixAccountService.

backupDir

@Config(value="helix.account.service.backup.dir")
 @Default(value="")
public final java.lang.String backupDir

The directory on the local machine where account data backups will be stored before updating accounts. If this string is empty, backups will be disabled.

maxBackupFileCount

@Config(value="helix.account.service.max.backup.file.count")
 @Default(value="100")
public final int maxBackupFileCount

The maximum number of local backup files kept in disk. When account service exceeds this count, every time it creates a new backup file, it will remove the oldest one.

useNewZNodePath

@Config(value="helix.account.service.use.new.znode.path")
 @Default(value="false")
public final boolean useNewZNodePath

If true, then use the new znode path to store list of blob ids that point to account metadata content.

updateDisabled

@Config(value="helix.account.service.update.disabled")
 @Default(value="false")
public final boolean updateDisabled

If true, HelixAccountService would reject all the requests to update accounts.

backFillAccountsToNewZNode

@Config(value="helix.account.service.backfill.accounts.to.new.znode")
 @Default(value="false")
public final boolean backFillAccountsToNewZNode

If true, HelixAccountService would persist account metadata to ambry-server upon receiving the account metadata change message. This option can't be true with useNewZNodePath at the same time. It should only be enabled while using the old znode path. And there should only be one machine enabling this option.

enableServeFromBackup

@Config(value="helix.account.service.enable.serve.from.backup")
 @Default(value="false")
public final boolean enableServeFromBackup

If true, HelixAccountService would load the account metadata from local backup file when fetching from helix fails. Set it to false while transitioning, since the old backup files don't have up-to-date account metadata.

totalNumberOfVersionToKeep

@Config(value="helix.account.service.total.number.of.version.to.keep")
 @Default(value="100")
public final int totalNumberOfVersionToKeep

Total number of previous versions of account metadata to keep in the system. Every update account http request would generate a new version. And when the number of versions surpasses this number, HelixAccountService will purge the oldest one to make room for the new one.

Constructor Detail

HelixAccountServiceConfig

public HelixAccountServiceConfig(VerifiableProperties verifiableProperties)