Scheduler
Общее описание
Компонент Scheduler используется для инициализации потока по установленному расписанию. Этот компонент похож на компонент Timer, но обладает большей функциональностью в отношении планирования.
Блок Scheduler может использоваться в качестве:
- блока-отправителя.
Настройка блока
В данном разделе описаны параметры блока Scheduler, которые необходимо заполнить при настройке и примеры заполнения значений этих параметров.
Базовые параметры блока Scheduler
| Название в UI | Название атрибута | Обязательный | Описание | Значение по умолчанию | Тип данных |
|---|---|---|---|---|---|
| Name | name | Да | Название планировщика | Строка | |
| Include Metadata | includeMetadata | Определяет следует ли отправлять в обработку внутреннего движка метаданные, такие как время срабатывания, название планировщика, количество планировщиков и т.д. | False | Логическое значение | |
| Send Empty Message When Idle | sendEmptyMessageWhenIdle | Определяет нужно ли возвращать пустое сообщение, если планировщик запустился, но в результате не было создано или обработано никаких данных. | False | Логическое значение | |
| Backoff Error Threshold | backoffErrorThreshold | Количество последовательно полученных ошибок обработки, после которого планировщик перейдет в режим пропуска запусков | Целочисленное значение | ||
| Backoff Idle Threshold | backoffIdleThreshold | Количество последовательных запросов, которые не привели к созданию или обработке данных. После достижения установленного количества планировщик перейдет в режим пропуска запусков | Целочисленное значение | ||
| Backoff Multiplier | backoffMultiplier | Если достигнуто количество последовательно полученных ошибок, заданное в параметре Backoff Error Threshold или количество последовательных пустых запросов, установленных в параметре Backoff Idle Threshold, то следующие срабатывания планировщика будут пропущены столько раз, сколько указано в Backoff Multiplier. После пропуска заданного количества срабатываний планировщик начнет работать в обычном режиме, пока снова не перейдет в режим пропуска запусков. Этот параметр следует задавать в том случае, если установлены параметры Backoff Error Threshold и/или Backoff Idle Threshold. | Целочисленное значение | ||
| Delay | delay | Промежуток времени в миллисекундах до следующего срабатывания планировщика. | 500 | Длинное целое значение | |
| Greedy | greedy | Если значение параметра установлено в True, то после того как планировщик сработал и привел к созданию или обработке данных, он сразу сработает еще раз. | False | Логическое значение | |
| Initial Delay | initialDelay | Промежуток времени в миллисекундах до первого срабатывания. | 1000 | Длинное целое значение | |
| Pool size | poolSize | Количество тредов в пуле, который будет использовать планировщик. | 1 | Целочисленное значение | |
| Repeat Count | repeatCount | Задает максимальное количество срабатываний. Соответственно, если вы установите значение 1, планировщик сработает только один раз. Если вы установите значение 5, планировщик сработает пять раз. Нулевое или отрицательное значение означает, что планировщик срабатывает постоянно без ограничений по количеству срабатываний. | 0 | Длинное целое значение | |
| Run Logging Level | runLoggingLevel | При инициации потока по планировщику будет происходить логирование старта и финиша этого события. Данный параметр позволяет настроить уровень логирования Возможные значения:
| TRACE | Список | |
| Scheduled Executor Service | scheduledExecutorService | Позволяет задать имя пользовательского/общего пула потоков, который будет использоваться планировщиком. По умолчанию, каждый планировщик использует свой собственный пул. | Строка | ||
| Scheduler | scheduler | Позволяет указать имя CRON-планировщика из компонента Spring или Camel-Quartz. Используйте Value Spring или Quartz для встроенного планировщика. | none | Строка | |
| Scheduler Properties | schedulerProperties | Применяется для настройки дополнительных свойств при использовании пользовательского планировщика или любого из планировщиков на основе Camel-Quartz и Spring. | Строка | ||
| Start Scheduler | startScheduler | Определяет следует ли автоматически запускать планировщик. | True | Логическое значение | |
| Time Unit | timeUnit | Задает единицы измерения времени для параметров Initial Delay и Delay. Возможные значения:
| Milliseconds | Список | |
| Use Fixed Delay | use Fixed Delay | Определяет нужно ли использовать фиксированную задержку после выполнения последнего запуска планировщика или строго выполнять запуск по установленному расписанию. Если значение параметра True, то между запусками будет фиксированная пауза, равная значению, выставленному в Delay. Если значение параметра False, то запуск планировщика будет строго привязан к расписанию и пауза, заданная в параметре Delay будет считаться от старта запуска планировщика а не с момента окончания его действия. | True | Логическое значение |
Расширенные параметры блока Scheduler
| Название в UI | Название | Обязательный | Описание | Значение по умолчанию | Тип данных |
|---|---|---|---|---|---|
| Bridge Error Handler | bridgeErrorHandler | Позволяет передавать возникшую ошибку из блока «наверх», т. е. на уровень потока, позволяя самостоятельно сконфигурировать собственные правила обработки ошибки через вспомогательные блоки. Примечание: это возможно только в том случае, если сторонний компонент позволяет системе получать оповещение о возникновении исключения. Некоторые компоненты обрабатывают это только внутренне, и поэтому применение Bridge Error Handler невозможно. По умолчанию блок будет использовать встроенный обработчик для обработки исключений, который залогирует возникшую ошибку и продолжит работу. | False | Логическое значение | |
| Exception Handler | exceptionHandler | Задает пользовательский обработчик исключений. Примечание: По умолчанию обработке подлежат исключения, регистрируемые на уровне WARN и ERROR, которые затем игнорируются и не влияют на выполнение логики. | Строка | ||
| Exchange Pattern | exchangePattern | Устанавливает стиль взаимодействия с присоединенной частью потока. Возможные значения:
| Список | ||
| Poll Strategy | pollStrategy | Подключаемая стратегия, позволяющая вам предоставить свою пользовательскую реализацию для управления обработкой ошибок, которые обычно возникают на первых этапах инициации потока согласно расписанию планировщика | Строка | ||
| Synchronous | synchronous | Определяет, следует ли использовать только синхронную обработку. | False | Логическое значение |