Package ru.yoomoney.tech.dbqueue.settings

Class QueueConfigsReader

java.lang.Object

ru.yoomoney.tech.dbqueue.settings.QueueConfigsReader

@ThreadSafe
public class QueueConfigsReader
extends java.lang.Object

Reads queue configuration from file.

File should be a regular Properties file, so format is 'queue-prefix.key.innerkey=val'. Where actual name of 'queue-prefix' is defined in constructor. Settings with other prefixes are ignored.

• Key names of queue settings should contain alphanumeric characters, dashes and underscores.
• Duration settings must be in ISO-8601. see Duration.parse(CharSequence)

Full configuration looks like:

 # see SETTING_TABLE
 queue-prefix.testQueue.table=foo

 # see SETTING_BETWEEN_TASK_TIMEOUT
 queue-prefix.testQueue.between-task-timeout=PT0.1S

 # see SETTING_NO_TASK_TIMEOUT
 queue-prefix.testQueue.no-task-timeout=PT1S

 # see SETTING_FATAL_CRASH_TIMEOUT
 queue-prefix.testQueue.fatal-crash-timeout=PT5S

 # see SETTING_THREAD_COUNT
 queue-prefix.testQueue.thread-count=3

 # see SETTING_RETRY_TYPE
 # values are:
 # VALUE_TASK_RETRY_TYPE_ARITHMETIC
 # VALUE_TASK_RETRY_TYPE_GEOMETRIC
 # VALUE_TASK_RETRY_TYPE_LINEAR
 queue-prefix.testQueue.retry-type=linear

 # see SETTING_RETRY_INTERVAL
 queue-prefix.testQueue.retry-interval=PT30S

 # see SETTING_REENQUEUE_RETRY_TYPE
 # values are:
 # VALUE_REENQUEUE_RETRY_TYPE_MANUAL
 # VALUE_REENQUEUE_RETRY_TYPE_FIXED
 # VALUE_REENQUEUE_RETRY_TYPE_SEQUENTIAL
 # VALUE_REENQUEUE_RETRY_TYPE_ARITHMETIC
 # VALUE_REENQUEUE_RETRY_TYPE_GEOMETRIC
 #
 # VALUE_REENQUEUE_RETRY_TYPE_MANUAL is used by default
 queue-prefix.testQueue.reenqueue-retry-type=fixed

 # see SETTING_REENQUEUE_RETRY_DELAY
 # Required when SETTING_REENQUEUE_RETRY_TYPE is set to 'fixed'
 queue-prefix.testQueue.reenqueue-retry-delay=PT10S

 # see SETTING_REENQUEUE_RETRY_PLAN
 # Required when SETTING_REENQUEUE_RETRY_TYPE is set to 'sequential'
 queue-prefix.testQueue.reenqueue-retry-plan=PT1S,PT2S,PT3S

 # see SETTING_REENQUEUE_RETRY_INITIAL_DELAY
 # PT1S is used by default.
 queue-prefix.testQueue.reenqueue-retry-initial-delay=PT10S

 # see SETTING_REENQUEUE_RETRY_STEP
 # PT2S is used by default.
 queue-prefix.testQueue.reenqueue-retry-step=PT2S

 # see SETTING_REENQUEUE_RETRY_RATIO
 # 2 is used by default.
 queue-prefix.testQueue.reenqueue-retry-ratio=3

 # see SETTING_PROCESSING_MODE
 # values are:
 # VALUE_PROCESSING_MODE_SEPARATE_TRANSACTIONS
 # VALUE_PROCESSING_MODE_USE_EXTERNAL_EXECUTOR
 # VALUE_PROCESSING_MODE_WRAP_IN_TRANSACTION
 queue-prefix.testQueue.processing-mode=use-external-executor

 # see SETTING_ADDITIONAL
 # see QueueSettings.getExtSettings()
 queue-prefix.testQueue.additional-settings.custom-val=custom-key

 # you can define custom settings to use it in enqueueing or processing
 queue-prefix.testQueue.additional-settings.custom=val1
 

Where 'testQueue' is name of a queue you apply configuration to.

Since:

22.08.2017

See Also:

QueueSettings, QueueLocation, FailRetryType, ProcessingMode, QueueConfig

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	SETTING_ADDITIONAL	Representation of QueueSettings.getExtSettings()
static java.lang.String	SETTING_BETWEEN_TASK_TIMEOUT	Representation of PollSettings.getBetweenTaskTimeout()
static java.lang.String	SETTING_FATAL_CRASH_TIMEOUT	Representation of PollSettings.getFatalCrashTimeout()
static java.lang.String	SETTING_ID_SEQUENCE	Representation of QueueLocation.getIdSequence()
static java.lang.String	SETTING_NO_TASK_TIMEOUT	Representation of PollSettings.getNoTaskTimeout()
static java.lang.String	SETTING_PROCESSING_MODE	Representation of ProcessingSettings.getProcessingMode()
static java.lang.String	SETTING_REENQUEUE_RETRY_DELAY	Representation of ReenqueueSettings.getFixedDelayOrThrow()
static java.lang.String	SETTING_REENQUEUE_RETRY_INITIAL_DELAY	Representation of ReenqueueSettings.getInitialDelayOrThrow()
static java.lang.String	SETTING_REENQUEUE_RETRY_PLAN	Representation of ReenqueueSettings.getSequentialPlanOrThrow()
static java.lang.String	SETTING_REENQUEUE_RETRY_RATIO	Representation of ReenqueueSettings.getGeometricRatioOrThrow()
static java.lang.String	SETTING_REENQUEUE_RETRY_STEP	Representation of ReenqueueSettings.getArithmeticStepOrThrow()
static java.lang.String	SETTING_REENQUEUE_RETRY_TYPE	Representation of ReenqueueSettings.getRetryType()
static java.lang.String	SETTING_RETRY_INTERVAL	Representation of FailureSettings.getRetryInterval()
static java.lang.String	SETTING_RETRY_TYPE	Representation of FailureSettings.getRetryType()
static java.lang.String	SETTING_TABLE	Representation of QueueLocation.getTableName()
static java.lang.String	SETTING_THREAD_COUNT	Representation of ProcessingSettings.getThreadCount()
static java.lang.String	VALUE_PROCESSING_MODE_SEPARATE_TRANSACTIONS	Representation of ProcessingMode.SEPARATE_TRANSACTIONS
static java.lang.String	VALUE_PROCESSING_MODE_USE_EXTERNAL_EXECUTOR	Representation of ProcessingMode.USE_EXTERNAL_EXECUTOR
static java.lang.String	VALUE_PROCESSING_MODE_WRAP_IN_TRANSACTION	Representation of ProcessingMode.WRAP_IN_TRANSACTION
static java.lang.String	VALUE_REENQUEUE_RETRY_TYPE_ARITHMETIC	Representation of ReenqueueRetryType.ARITHMETIC
static java.lang.String	VALUE_REENQUEUE_RETRY_TYPE_FIXED	Representation of ReenqueueRetryType.FIXED
static java.lang.String	VALUE_REENQUEUE_RETRY_TYPE_GEOMETRIC	Representation of ReenqueueRetryType.GEOMETRIC
static java.lang.String	VALUE_REENQUEUE_RETRY_TYPE_MANUAL	Representation of ReenqueueRetryType.MANUAL
static java.lang.String	VALUE_REENQUEUE_RETRY_TYPE_SEQUENTIAL	Representation of ReenqueueRetryType.SEQUENTIAL
static java.lang.String	VALUE_TASK_RETRY_TYPE_ARITHMETIC	Representation of FailRetryType.ARITHMETIC_BACKOFF
static java.lang.String	VALUE_TASK_RETRY_TYPE_GEOMETRIC	Representation of FailRetryType.GEOMETRIC_BACKOFF
static java.lang.String	VALUE_TASK_RETRY_TYPE_LINEAR	Representation of FailRetryType.LINEAR_BACKOFF

Constructor Summary

Constructors

Constructor	Description
QueueConfigsReader(java.util.List<java.nio.file.Path> configPaths, java.lang.String settingsPrefix)	Constructor
QueueConfigsReader(java.util.List<java.nio.file.Path> configPaths, java.lang.String settingsPrefix, java.util.function.Supplier<ProcessingSettings.Builder> defaultProcessingSettings, java.util.function.Supplier<PollSettings.Builder> defaultPollSettings, java.util.function.Supplier<FailureSettings.Builder> defaultFailureSettings, java.util.function.Supplier<ReenqueueSettings.Builder> defaultReenqueueSettings)	Constructor

Method Summary

Modifier and Type	Method	Description
java.util.List<java.nio.file.Path>	getConfigPaths()	Get paths to queue configs
java.util.List<QueueConfig>	parse()	Try to parse queues configurations.

Methods inherited from class java.lang.Object

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

Field Detail

VALUE_TASK_RETRY_TYPE_GEOMETRIC

public static final java.lang.String VALUE_TASK_RETRY_TYPE_GEOMETRIC

Representation of FailRetryType.GEOMETRIC_BACKOFF

See Also:

Constant Field Values

VALUE_TASK_RETRY_TYPE_ARITHMETIC

public static final java.lang.String VALUE_TASK_RETRY_TYPE_ARITHMETIC

Representation of FailRetryType.ARITHMETIC_BACKOFF

See Also:

Constant Field Values

VALUE_TASK_RETRY_TYPE_LINEAR

public static final java.lang.String VALUE_TASK_RETRY_TYPE_LINEAR

Representation of FailRetryType.LINEAR_BACKOFF

See Also:

Constant Field Values

VALUE_REENQUEUE_RETRY_TYPE_MANUAL

public static final java.lang.String VALUE_REENQUEUE_RETRY_TYPE_MANUAL

Representation of ReenqueueRetryType.MANUAL

See Also:

Constant Field Values

VALUE_REENQUEUE_RETRY_TYPE_FIXED

public static final java.lang.String VALUE_REENQUEUE_RETRY_TYPE_FIXED

Representation of ReenqueueRetryType.FIXED

See Also:

Constant Field Values

VALUE_REENQUEUE_RETRY_TYPE_SEQUENTIAL

public static final java.lang.String VALUE_REENQUEUE_RETRY_TYPE_SEQUENTIAL

Representation of ReenqueueRetryType.SEQUENTIAL

See Also:

Constant Field Values

VALUE_REENQUEUE_RETRY_TYPE_ARITHMETIC

public static final java.lang.String VALUE_REENQUEUE_RETRY_TYPE_ARITHMETIC

Representation of ReenqueueRetryType.ARITHMETIC

See Also:

Constant Field Values

VALUE_REENQUEUE_RETRY_TYPE_GEOMETRIC

public static final java.lang.String VALUE_REENQUEUE_RETRY_TYPE_GEOMETRIC

Representation of ReenqueueRetryType.GEOMETRIC

See Also:

Constant Field Values

VALUE_PROCESSING_MODE_USE_EXTERNAL_EXECUTOR

public static final java.lang.String VALUE_PROCESSING_MODE_USE_EXTERNAL_EXECUTOR

Representation of ProcessingMode.USE_EXTERNAL_EXECUTOR

See Also:

Constant Field Values

VALUE_PROCESSING_MODE_WRAP_IN_TRANSACTION

public static final java.lang.String VALUE_PROCESSING_MODE_WRAP_IN_TRANSACTION

Representation of ProcessingMode.WRAP_IN_TRANSACTION

See Also:

Constant Field Values

VALUE_PROCESSING_MODE_SEPARATE_TRANSACTIONS

public static final java.lang.String VALUE_PROCESSING_MODE_SEPARATE_TRANSACTIONS

Representation of ProcessingMode.SEPARATE_TRANSACTIONS

See Also:

Constant Field Values

SETTING_PROCESSING_MODE

public static final java.lang.String SETTING_PROCESSING_MODE

Representation of ProcessingSettings.getProcessingMode()

See Also:

Constant Field Values

SETTING_RETRY_TYPE

public static final java.lang.String SETTING_RETRY_TYPE

Representation of FailureSettings.getRetryType()

See Also:

Constant Field Values

SETTING_RETRY_INTERVAL

public static final java.lang.String SETTING_RETRY_INTERVAL

Representation of FailureSettings.getRetryInterval()

See Also:

Constant Field Values

SETTING_REENQUEUE_RETRY_TYPE

public static final java.lang.String SETTING_REENQUEUE_RETRY_TYPE

Representation of ReenqueueSettings.getRetryType()

See Also:

Constant Field Values

SETTING_REENQUEUE_RETRY_PLAN

public static final java.lang.String SETTING_REENQUEUE_RETRY_PLAN

Representation of ReenqueueSettings.getSequentialPlanOrThrow()

See Also:

Constant Field Values

SETTING_REENQUEUE_RETRY_DELAY

public static final java.lang.String SETTING_REENQUEUE_RETRY_DELAY

Representation of ReenqueueSettings.getFixedDelayOrThrow()

See Also:

Constant Field Values

SETTING_REENQUEUE_RETRY_INITIAL_DELAY

public static final java.lang.String SETTING_REENQUEUE_RETRY_INITIAL_DELAY

Representation of ReenqueueSettings.getInitialDelayOrThrow()

See Also:

Constant Field Values

SETTING_REENQUEUE_RETRY_STEP

public static final java.lang.String SETTING_REENQUEUE_RETRY_STEP

Representation of ReenqueueSettings.getArithmeticStepOrThrow()

See Also:

Constant Field Values

SETTING_REENQUEUE_RETRY_RATIO

public static final java.lang.String SETTING_REENQUEUE_RETRY_RATIO

Representation of ReenqueueSettings.getGeometricRatioOrThrow()

See Also:

Constant Field Values

SETTING_THREAD_COUNT

public static final java.lang.String SETTING_THREAD_COUNT

Representation of ProcessingSettings.getThreadCount()

See Also:

Constant Field Values

SETTING_FATAL_CRASH_TIMEOUT

public static final java.lang.String SETTING_FATAL_CRASH_TIMEOUT

Representation of PollSettings.getFatalCrashTimeout()

See Also:

Constant Field Values

SETTING_BETWEEN_TASK_TIMEOUT

public static final java.lang.String SETTING_BETWEEN_TASK_TIMEOUT

Representation of PollSettings.getBetweenTaskTimeout()

See Also:

Constant Field Values

SETTING_NO_TASK_TIMEOUT

public static final java.lang.String SETTING_NO_TASK_TIMEOUT

Representation of PollSettings.getNoTaskTimeout()

See Also:

Constant Field Values

SETTING_TABLE

public static final java.lang.String SETTING_TABLE

Representation of QueueLocation.getTableName()

See Also:

Constant Field Values

SETTING_ID_SEQUENCE

public static final java.lang.String SETTING_ID_SEQUENCE

Representation of QueueLocation.getIdSequence()

See Also:

Constant Field Values

SETTING_ADDITIONAL

public static final java.lang.String SETTING_ADDITIONAL

Representation of QueueSettings.getExtSettings()

See Also:

Constant Field Values

Constructor Detail

QueueConfigsReader

public QueueConfigsReader(@Nonnull
                          java.util.List<java.nio.file.Path> configPaths,
                          @Nonnull
                          java.lang.String settingsPrefix)

Constructor

Parameters:

configPaths - files to read configuration from.

settingsPrefix - prefix that will be used for queue settings.

QueueConfigsReader

public QueueConfigsReader(@Nonnull
                          java.util.List<java.nio.file.Path> configPaths,
                          @Nonnull
                          java.lang.String settingsPrefix,
                          @Nonnull
                          java.util.function.Supplier<ProcessingSettings.Builder> defaultProcessingSettings,
                          @Nonnull
                          java.util.function.Supplier<PollSettings.Builder> defaultPollSettings,
                          @Nonnull
                          java.util.function.Supplier<FailureSettings.Builder> defaultFailureSettings,
                          @Nonnull
                          java.util.function.Supplier<ReenqueueSettings.Builder> defaultReenqueueSettings)

Constructor

Parameters:

configPaths - files to read configuration from.

settingsPrefix - prefix that will be used for queue settings.

defaultProcessingSettings - default ProcessingSettings

defaultPollSettings - default PollSettings

defaultFailureSettings - default FailureSettings

defaultReenqueueSettings - default ReenqueueSettings

Method Detail

getConfigPaths

@Nonnull
public java.util.List<java.nio.file.Path> getConfigPaths()

Get paths to queue configs

Returns:

paths to queue configs

parse

@Nonnull
public java.util.List<QueueConfig> parse()

Try to parse queues configurations.

Returns:

parsed queue configurations