GitHub

Поддерживаются как производитель, так и потребитель

Компонент GitHub взаимодействует с API GitHub, инкапсулируя egit-github. В настоящее время он обеспечивает опрос новых запросов, комментариев к запросам, тегов и коммитов. Он также может создавать комментарии к запросам, а также полностью закрывать запрос.

Вместо использования вебхуков этот метод полагается на простое опрашивание (polling). Причины включают:

• Забота о надёжности и стабильности

• Типы данных, которые мы опрашиваем, обычно невелики (кроме того, в API доступно разбиение на страницы)

• Необходимость поддержки приложений, работающих в средах, не доступных публично, где вебхуки не сработают

Обратите внимание, что GitHub API довольно обширен. Поэтому этот компонент может быть легко расширен для поддержки дополнительных взаимодействий.

Пользователям Maven необходимо добавить следующую зависимость для pom.xmlэтого компонента:

<dependency>
    <groupId>org.apache.camel</groupId>
    <artifactId>camel-github</artifactId>
    <version>${camel-version}</version>
</dependency>

URI Format

<span style="color: rgb(0,0,0);">github://endpoint[?options]

</span>

Configuring Options

Компоненты настраиваются на двух отдельных уровнях:

• component level

• edpoint level

Configuring Component Options

На уровне компонента задаются основные и общие настройки, которые впоследствии наследуются endpoints. Это самый высокий уровень конфигурации.

Например, компонент может иметь настройки безопасности, учетные данные для аутентификации, URL-адреса для сетевых подключений и т. д.

Некоторые компоненты имеют всего несколько параметров, в то время как у других их может быть много. Поскольку компоненты обычно имеют предварительно настроенные значения по умолчанию, которые используются в большинстве случаев, вам может понадобиться настроить только несколько параметров компонента или вообще ничего не настраивать.

Компоненты можно настроить с использованием:

• Component DSL.

• Конфигурационного файла (application.properties, *.yaml files, etc).

• Напрямую в Java code.

Configuring Endpoint Options

Обычно больше времени уходит на настройку endpoints, так как они обладают множеством параметров. Эти параметры позволяют настроить поведение endpoint в соответствии с вашими потребностями. Кроме того, параметры делятся на категории в зависимости от того, используется ли endpoint как потребитель (from), как производитель (to) или в обеих ролях.

Настройка endpoints чаще всего выполняется непосредственно в URI endpoint в виде параметров пути и запроса. Также вы можете использовать Endpoint DSL и DataFormat DSL как типобезопасный способ настройки endpoints и форматов данных в Java.

Хорошей практикой при настройке параметров является использование Property Placeholders.

Property placeholders предоставляют несколько преимуществ:

• Помогают избежать использования жестко закодированных URL-адресов, номеров портов, конфиденциальной информации и других настроек.

• Позволяют вынести конфигурацию за пределы кода.

• Делают код более гибким и удобным для повторного использования.

Component properties

Branch Name

• Название ветки.

• По умолчанию:

• Тип: String

Repo Name

• Обязательное поле - название репозитория GitHub.

• По умолчанию:

• Тип: String

Repo Owner

• Тип: Обязательное поле - владелец репозитория GitHub (организация).

• По умолчанию:

• Тип: String

Send Empty Message When Idle

• Если потребитель, работающий в режиме опроса, не обнаружил ни одного файла, вы можете включить эту опцию, чтобы отправлять пустое сообщение (без тела) вместо этого.

• По умолчанию: false

• Тип: boolean

Starting Sha

• Начальный SHA для опроса коммитов с потребителем коммитов. Значение может быть либо конкретным SHA, с которого начинать, либо beginning для начала с самого первого коммита, либо last для начала с последнего коммита.

• По умолчанию: last

• Тип: String

Type

• Обязательное поле - нужно указать какую операцию Git выполнить.

  Возможные значения:

  • CLOSEPULLREQUEST

  • PULLREQUESTCOMMENT

  • COMMIT

  • PULLREQUEST

  • TAG

  • PULLREQUESTSTATE

  • PULLREQUESTFILES

  • GETCOMMITFILE

  • CREATEISSUE

  • EVENT

• По умолчанию:

• Тип: GitHubType

Component scheduler properties

Backoff Error Threshold

• Количество последовательных неудачных опросов (из-за ошибки), после которых должен начать действовать коэффициент понижения частоты опросов (backoffMultiplier).

• По умолчанию:

• Тип: int

Backoff Idle Threshold

• Тип: Количество пустых опросов подряд, после которых должен начать действовать коэффициент понижения частоты опросов (backoffMultiplier).

• По умолчанию:

• Тип: int

Backoff Multiplier

• Позволяет планируемому потребителю в режиме опроса снижать частоту опросов, если произошло несколько последовательных пустых опросов или ошибок. Множитель определяет количество опросов, которые будут пропущены перед следующей попыткой. При использовании этой опции также необходимо настроить параметры backoffIdleThreshold и/или backoffErrorThreshold.

• По умолчанию:

• Тип: int

Delay

• Тип: Количество миллисекунд до следующего опроса.

• По умолчанию: 500

• Тип: long

Greedy

• Если включен режим greedy, то ScheduledPollConsumer снова выполнится немедленно, если предыдущий опрос вернул 1 или больше сообщений.

• По умолчанию: false

• Тип: boolean

Initial Delay

• Количество миллисекунд до начала первого опроса.

• По умолчанию: 1000

• Тип: long

Repeat Count

• Устанавливает максимальный лимит количества срабатываний. Если вы установите значение 1, планировщик сработает только один раз. Если установить значение 5, он сработает пять раз. Значение ноль или отрицательное означает, что срабатывание будет происходить бесконечно.

• По умолчанию: 0

• Тип: long

Run Logging Level

• Потребитель записывает в логи строку начала/завершения при опросе. Эта опция позволяет настроить уровень логирования для этого.

  Возможные значения:

  • TRACE

  • DEBUG

  • INFO

  • WARN

  • ERROR

  • OFF

• По умолчанию: TRACE

• Тип: LoggingLevel

Scheduled Executor Service

• Позволяет настроить пользовательский/общий пул потоков для использования потребителем. По умолчанию у каждого потребителя есть собственный пул потоков с одним потоком.

• По умолчанию:

• Тип: ScheduledExecutorService

Scheduler

• Для использования планировщика cron из компонента camel-spring или camel-quartz. Используйте значение spring или quartz для встроенного планировщика.

• По умолчанию: none

• Тип: Object

Scheduler Properties

• Используется для настройки дополнительных свойств при использовании пользовательского планировщика или любого из планировщиков на основе Quartz или Spring.

• По умолчанию:

• Тип: Map

Start Scheduler

• Указывает, должен ли планировщик запускаться автоматически.

• По умолчанию: true

• Тип: boolean

Time Unit

• Единица измерения времени для опций initialDelay и delay.

  Возможные значения:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

• По умолчанию: MILLISECONDS

• Тип: TimeUnit

Use Fixed Delay

• Управляет тем, будет ли использоваться фиксированная задержка или фиксированная частота.

• По умолчанию: true

• Тип: boolean

Component security properties

Oauth Token

• OAuth-токен GitHub. Должен быть настроен либо на компоненте, либо на endpoint.

• По умолчанию:

• Тип: String

Component advanced properties

Bridge Error Handler

• Предоставляет возможность связать потребителя с маршрутизатором Error Handler Camel. Это позволяет обрабатывать исключения (если возможно), возникающие при получении входящих сообщений потребителем Camel, в виде сообщений, передаваемых в маршрутизатор Error Handler.

  Важно: Это возможно только в том случае, если сторонний компонент позволяет Camel получать уведомления о возникших исключениях. Некоторые компоненты обрабатывают исключения только внутренне, из-за чего использование bridgeErrorHandler становится невозможным. В некоторых случаях мы можем доработать компонент Camel, чтобы интегрировать его со сторонним компонентом и сделать такую возможность доступной в будущих выпусках. По умолчанию потребитель использует org.apache.camel.spi.ExceptionHandler для обработки исключений, которые логируются с уровнем WARN или ERROR и игнорируются.

• По умолчанию: false

• Тип: boolean

Event Fetch Strategy

• Указывает пользовательскую стратегию, которая определяет, как EventsConsumer получает события.

• По умолчанию:

• Тип: GitHubEventFetchStrategy

Exception Handler

• Позволяет потребителю использовать собственный ExceptionHandler.

  Обратите внимание, что если включена опция bridgeErrorHandler, то эта настройка не используется. По умолчанию потребитель обрабатывает исключения, которые логируются с уровнем WARN или ERROR и игнорируются.

• По умолчанию:

• Тип: ExceptionHandler

Exchange Pattern

• Тип: Определяет шаблон взаимодействия, который применяется, когда потребитель создает новый обмен (exchange).

  Возможные значения:

  • InOnly

  • InOut

• По умолчанию:

• Тип: ExchangePattern

Poll Strategy

• Плагинируемая стратегия org.apache.camel.PollingConsumerPollingStrategy, позволяющая предоставить вашу собственную реализацию для управления обработкой ошибок, которые обычно возникают во время операции опроса до того, как Exchange был создан и маршрутизирован в Camel.

• По умолчанию:

• Тип: PollingConsumerPollStrategy

<span style="color: rgb(0,0,0);">

</span>