OpenStack Swift
Поддерживается только производитель
Компонент Openstack Swift позволяет отправлять сообщения в службы хранения объектов OpenStack.
Dependencies
Пользователям Maven необходимо добавить следующую зависимость в свой файл pom.xml.
pom.xml
<dependency>
<groupId>org.apache.camel</groupId>
<artifactId>camel-openstack</artifactId>
<version>${camel-version}</version>
</dependency>где ${camel-version} необходимо заменить на фактическую версию Camel.
URI Format
openstack-swift://hosturl[?options]
Configuring Options
Компоненты Camel настраиваются на двух отдельных уровнях:
-
уровень компонентов
-
уровень конечной точки
Configuring Component Options
На уровне компонентов задаются общие и общие конфигурации, которые затем наследуются конечными точками. Это самый высокий уровень конфигурации.
Например, компонент может иметь настройки безопасности, учетные данные для аутентификации, URL-адреса для сетевого подключения и т. д.
У некоторых компонентов всего несколько параметров, а у других -- много. Поскольку компоненты обычно имеют предустановленные значения по умолчанию, которые широко используются, зачастую вам может потребоваться настроить лишь несколько параметров компонента, а то и вовсе ни одного.
Вы можете настроить компоненты, используя:
-
Компонент DSL (opens in a new tab) .
-
в файле конфигурации (
application.propertiesфайлы*.yaml, и т.д.). -
непосредственно в коде Java.
Configuring Endpoint Options
Настройка конечных точек обычно занимает больше времени, поскольку у них есть множество параметров. Эти параметры помогают вам настроить функции конечной точки. Параметры также классифицируются по тому, используется ли конечная точка как потребитель ( от ), как производитель ( от ) или и то, и другое.
Конечные точки чаще всего настраиваются непосредственно в URI конечной точки в виде параметров пути и запроса . Вы также можете использовать Endpoint DSL (opens in a new tab) и DataFormat DSL (opens in a new tab) в качестве типобезопасного способа настройки конечных точек и форматов данных в Java.
Хорошей практикой при настройке параметров является использование заполнителей свойств (opens in a new tab) .
Заполнители свойств обеспечивают несколько преимуществ:
-
Они помогают предотвратить использование жестко запрограммированных URL-адресов, номеров портов, конфиденциальной информации и других настроек.
-
Они позволяют вынести конфигурацию за пределы кода.
-
Они помогают коду стать более гибким и пригодным для повторного использования.
В следующих двух разделах перечислены все параметры, сначала для компонента, а затем для конечной точки.
Component Options
Компонент OpenStack Swift поддерживает 2 варианта, которые перечислены ниже.
lazyStartProducer (producer)
-
Следует ли запускать производитель в режиме ленивого запуска (при первом сообщении). Запуск в режиме ленивого запуска позволяет разрешить запуск CamelContext и маршрутов в ситуациях, когда производитель может выйти из строя при запуске, что приведет к сбою запуска маршрута. Отложив запуск в режим ленивого запуска, можно обработать сбой запуска во время маршрутизации сообщений с помощью обработчиков ошибок маршрутизации Camel. Имейте в виду, что после обработки первого сообщения создание и запуск производителя могут занять некоторое время и увеличить общее время обработки.
-
По умолчанию: false
-
Тип: boolean
autowiredEnabled (advanced)
-
Включено ли автоматическое связывание. Это используется для параметров автоматического связывания (параметр должен быть помечен как autowired) путём поиска в реестре экземпляра соответствующего типа, который затем настраивается в компоненте. Это может использоваться для автоматической настройки источников данных JDBC, фабрик JMS-подключений, клиентов AWS и т. д.
-
По умолчанию: true
-
Тип: boolean
Endpoint Options
Конечная точка OpenStack Swift настраивается с использованием синтаксиса URI:
openstack-swift:host
Со следующими параметрами пути и запроса :
Path Parameters (1 parameters)
host (producer)
-
Требуемый URL-адрес хоста OpenStack.
-
По умолчанию:
-
Тип: String
Query Parameters (9 parameters)
apiVersion (producer)
-
Версия API OpenStack.
Значения перечисления:
-
V2
-
V3
-
-
По умолчанию: V3
-
Тип: String
config (producer)
-
Конфигурация OpenStack.
-
По умолчанию:
-
Тип: Config
domain (producer)
-
Домен аутентификации.
-
По умолчанию: default
-
Тип: String
operation (producer)
-
Операция, которую предстоит сделать.
-
По умолчанию:
-
Тип: String
password (producer)
-
Требуется пароль OpenStack.
-
По умолчанию:
-
Тип: String
project (producer)
-
Обязательно Идентификатор проекта.
-
По умолчанию:
-
Тип: String
subsystem (producer)
-
Требуется подсистема OpenStack Swift.
Значения перечисления:
-
objects
-
containers
-
-
По умолчанию:
-
Тип: String
username (producer)
-
Обязательное имя пользователя OpenStack.
-
По умолчанию:
-
Тип: String
lazyStartProducer (producer (advanced))
-
Следует ли запускать производитель в режиме ленивого запуска (при первом сообщении). Запуск в режиме ленивого запуска позволяет разрешить запуск CamelContext и маршрутов в ситуациях, когда производитель может выйти из строя при запуске, что приведет к сбою запуска маршрута. Отложив запуск в режим ленивого запуска, можно обработать сбой запуска во время маршрутизации сообщений с помощью обработчиков ошибок маршрутизации Camel. Имейте в виду, что после обработки первого сообщения создание и запуск производителя могут занять некоторое время и увеличить общее время обработки.
-
По умолчанию: false
-
Тип: boolean
Message Headers
Компонент OpenStack Swift поддерживает 14 заголовков сообщений, которые перечислены ниже:
containerName (object container)
Constant: CONTAINER_NAME (opens in a new tab)
-
Имя контейнера.
-
По умолчанию:
-
Тип: String
objectName (object)
Constant: OBJECT_NAME (opens in a new tab)
-
Имя объекта.
-
По умолчанию:
-
Тип: String
xref:#_endpoint_header_X-Container-Meta-X-Container-Meta- (container)
Constant: CONTAINER_METADATA_PREFIX (opens in a new tab)
-
Префикс метаданных контейнера.
-
По умолчанию:
-
Тип: Map
X-Versions-Location (container)
Constant: VERSIONS_LOCATION (opens in a new tab)
-
Расположение версий.
-
По умолчанию:
-
Тип: String
X-Container-Read (container)
Constant: CONTAINER_READ (opens in a new tab)
-
ACL - чтение контейнера.
-
По умолчанию:
-
Тип: String
X-Container-Write (container)
Constant: CONTAINER_WRITE (opens in a new tab)
-
ACL -- запись в контейнер.
-
По умолчанию:
-
Тип: String
limit (container)
Constant: LIMIT (opens in a new tab)
-
Список вариантов - ограничение.
-
По умолчанию:
-
Тип: Integer
marker (container)
Constant: MARKER (opens in a new tab)
-
Параметры списка - маркер.
-
По умолчанию:
-
Тип: String
end_marker (container)
Constant: END_MARKER (opens in a new tab)
-
Список вариантов - конечный маркер.
-
По умолчанию:
-
Тип: String
delimiter (container)
Constant: DELIMITER (opens in a new tab)
-
Параметры списка - разделитель.
-
По умолчанию:
-
Тип: Character
path (container object)
Constant: PATH (opens in a new tab)
-
Тип: Путь.
-
По умолчанию:
-
Тип: String
operation (producer)
Constant: OPERATION (opens in a new tab)
-
Операция, которую необходимо выполнить.
-
По умолчанию:
-
Тип: String
ID (producer)
Constant: ID (opens in a new tab)
-
ID.
-
По умолчанию:
-
Тип: String
name (producer)
Constant: NAME (opens in a new tab)
-
Имя.
-
По умолчанию:
-
Тип: String
Usage
Для каждой подсистемы вы можете использовать следующие настройки:
Containers
Operations you can perform with the Container producer
create
- Тип: Создайте новый контейнер.
get
- Тип: Возьмите контейнер.
getAll
- По умолчанию: Получите все контейнеры.
update
- Тип: Обновите контейнер.
delete
- Удалить контейнер.
getMetadata
- Получить метаданные.
createUpdateMetadata
- По умолчанию: Создание/обновление метаданных.
deleteMetadata
- Тип: Удалить метаданные
Если вам нужны более точные настройки контейнера, вы можете создать новый объект типа
org.openstack4j.model.storage.object.options.CreateUpdateContainerOptions(в случае операции создания или обновления) илиorg.openstack4j.model.storage.object.options.ContainerListOptionsдля перечисления контейнеров и отправить в теле сообщения.
Objects
Operations you can perform with the Object producer
create
- Создайте новый объект.
get
- Получите объект.
getAll
- Получить все объекты.
update
- Тип: Получить обновление объекта.
delete
- Удалить объект.
getMetadata
- Получить метаданные.
createUpdateMetadata
- Создание/обновление метаданных.
Spring Boot Auto-Configuration
При использовании openstack-swift с Spring Boot обязательно используйте следующую зависимость Maven для поддержки автоматической настройки:
<dependency>
<groupId>org.apache.camel.springboot</groupId>
<artifactId>camel-openstack-starter</artifactId>
<version>x.x.x</version>
<!-- use the same version as your Camel core version -->
</dependency>Компонент поддерживает 18 опций, которые перечислены ниже.
camel.component.openstack-cinder.autowired-enabled
-
Включено ли автоматическое связывание. Это используется для параметров автоматического связывания (параметр должен быть помечен как autowired) путём поиска в реестре экземпляра соответствующего типа, который затем настраивается в компоненте. Это может использоваться для автоматической настройки источников данных JDBC, фабрик JMS-подключений, клиентов AWS и т. д
-
true
-
Boolean
camel.component.openstack-cinder.enabled
-
Включить ли автоматическую настройку компонента openstack-cinder. По умолчанию эта опция включена.
-
По умолчанию:
-
Тип: Boolean
camel.component.openstack-cinder.lazy-start-producer
-
Следует ли запускать производитель в режиме ленивого запуска (при первом сообщении). Запуск в режиме ленивого запуска позволяет разрешить запуск CamelContext и маршрутов в ситуациях, когда производитель может выйти из строя при запуске, что приведет к сбою запуска маршрута. Отложив запуск в режим ленивого запуска, можно обработать сбой запуска во время маршрутизации сообщений с помощью обработчиков ошибок маршрутизации Camel. Имейте в виду, что после обработки первого сообщения создание и запуск производителя могут занять некоторое время и увеличить общее время обработки.
-
По умолчанию: false
-
Тип: Boolean
camel.component.openstack-glance.autowired-enabled
-
Включено ли автоматическое связывание. Это используется для параметров автоматического связывания (параметр должен быть помечен как autowired) путём поиска в реестре экземпляра соответствующего типа, который затем настраивается в компоненте. Это может использоваться для автоматической настройки источников данных JDBC, фабрик JMS-подключений, клиентов AWS и т. д.
-
По умолчанию: true
-
Тип: Boolean
camel.component.openstack-glance.enabled
-
Включить ли автоматическую настройку компонента openstack-glance. По умолчанию эта опция включена.
-
По умолчанию:
-
Тип: Boolean
camel.component.openstack-glance.lazy-start-producer
-
Следует ли запускать производитель в режиме ленивого запуска (при первом сообщении). Запуск в режиме ленивого запуска позволяет разрешить запуск CamelContext и маршрутов в ситуациях, когда производитель может выйти из строя при запуске, что приведет к сбою запуска маршрута. Отложив запуск в режим ленивого запуска, можно обработать сбой запуска во время маршрутизации сообщений с помощью обработчиков ошибок маршрутизации Camel. Имейте в виду, что после обработки первого сообщения создание и запуск производителя могут занять некоторое время и увеличить общее время обработки.
-
По умолчанию: false
-
Тип: Boolean
camel.component.openstack-keystone.autowired-enabled
-
Включено ли автоматическое связывание. Это используется для параметров автоматического связывания (параметр должен быть помечен как autowired) путём поиска в реестре экземпляра соответствующего типа, который затем настраивается в компоненте. Это может использоваться для автоматической настройки источников данных JDBC, фабрик JMS-подключений, клиентов AWS и т. д.
-
По умолчанию: true
-
Тип: Boolean
camel.component.openstack-keystone.enabled
-
Включить ли автоматическую настройку компонента openstack-keystone. По умолчанию эта опция включена
-
По умолчанию:
-
Тип: Boolean
camel.component.openstack-keystone.lazy-start-producer
-
Следует ли запускать производитель в режиме ленивого запуска (при первом сообщении). Запуск в режиме ленивого запуска позволяет разрешить запуск CamelContext и маршрутов в ситуациях, когда производитель может выйти из строя при запуске, что приведет к сбою запуска маршрута. Отложив запуск в режим ленивого запуска, можно обработать сбой запуска во время маршрутизации сообщений с помощью обработчиков ошибок маршрутизации Camel. Имейте в виду, что после обработки первого сообщения создание и запуск производителя могут занять некоторое время и увеличить общее время обработки.
-
По умолчанию: false
-
Тип: Boolean
camel.component.openstack-neutron.autowired-enabled
-
Включено ли автоматическое связывание. Это используется для параметров автоматического связывания (параметр должен быть помечен как autowired) путём поиска в реестре экземпляра соответствующего типа, который затем настраивается в компоненте. Это может использоваться для автоматической настройки источников данных JDBC, фабрик JMS-подключений, клиентов AWS и т. д.
-
По умолчанию: true
-
Тип: Boolean
camel.component.openstack-neutron.enabled
-
Включить ли автоматическую настройку компонента openstack-neutron. По умолчанию эта опция включена.
-
По умолчанию:
-
Тип: Boolean
camel.component.openstack-neutron.lazy-start-producer
-
Следует ли запускать производитель в режиме ленивого запуска (при первом сообщении). Запуск в режиме ленивого запуска позволяет разрешить запуск CamelContext и маршрутов в ситуациях, когда производитель может выйти из строя при запуске, что приведет к сбою запуска маршрута. Отложив запуск в режим ленивого запуска, можно обработать сбой запуска во время маршрутизации сообщений с помощью обработчиков ошибок маршрутизации Camel. Имейте в виду, что после обработки первого сообщения создание и запуск производителя могут занять некоторое время и увеличить общее время обработки.
-
По умолчанию: false
-
Тип: Boolean
camel.component.openstack-nova.autowired-enabled
-
Включено ли автоматическое связывание. Это используется для параметров автоматического связывания (параметр должен быть помечен как autowired) путём поиска в реестре экземпляра соответствующего типа, который затем настраивается в компоненте. Это может использоваться для автоматической настройки источников данных JDBC, фабрик JMS-подключений, клиентов AWS и т. д.
-
По умолчанию: true
-
Тип: Boolean
camel.component.openstack-nova.enabled
-
Включить ли автоматическую настройку компонента openstack-nova. По умолчанию эта опция включена.
-
По умолчанию:
-
Тип: Boolean
camel.component.openstack-nova.lazy-start-producer
-
Следует ли запускать производитель в режиме ленивого запуска (при первом сообщении). Запуск в режиме ленивого запуска позволяет разрешить запуск CamelContext и маршрутов в ситуациях, когда производитель может выйти из строя при запуске, что приведет к сбою запуска маршрута. Отложив запуск в режим ленивого запуска, можно обработать сбой запуска во время маршрутизации сообщений с помощью обработчиков ошибок маршрутизации Camel. Имейте в виду, что после обработки первого сообщения создание и запуск производителя могут занять некоторое время и увеличить общее время обработки.
-
По умолчанию: false
-
Тип: Boolean
camel.component.openstack-swift.autowired-enabled
-
Включено ли автоматическое связывание. Это используется для параметров автоматического связывания (параметр должен быть помечен как autowired) путём поиска в реестре экземпляра соответствующего типа, который затем настраивается в компоненте. Это может использоваться для автоматической настройки источников данных JDBC, фабрик JMS-подключений, клиентов AWS и т. д.
-
По умолчанию: true
-
Тип: Boolean
camel.component.openstack-swift.enabled
-
Включить ли автоматическую настройку компонента openstack-swift. По умолчанию эта опция включена.
-
По умолчанию:
-
Тип: Boolean
camel.component.openstack-swift.lazy-start-producer
-
Следует ли запускать производитель в режиме ленивого запуска (при первом сообщении). Запуск в режиме ленивого запуска позволяет разрешить запуск CamelContext и маршрутов в ситуациях, когда производитель может выйти из строя при запуске, что приведет к сбою запуска маршрута. Отложив запуск в режим ленивого запуска, можно обработать сбой запуска во время маршрутизации сообщений с помощью обработчиков ошибок маршрутизации Camel. Имейте в виду, что после обработки первого сообщения создание и запуск производителя могут занять некоторое время и увеличить общее время обработки.
-
По умолчанию: false
-
Тип: Boolean