Red Hat SummitChapter 256. OpenStack Swift Component
Available as of Camel version 2.19
The openstack-swift component allows messages to be sent to an OpenStack object storage services.
256.1. Dependencies
Maven users will need to add the following dependency to their pom.xml.
pom.xml
<dependency>
<groupId>org.apache.camel</groupId>
<artifactId>camel-openstack</artifactId>
<version>${camel-version}</version>
</dependency>
<dependency>
<groupId>org.apache.camel</groupId>
<artifactId>camel-openstack</artifactId>
<version>${camel-version}</version>
</dependency>
where ${camel-version} must be replaced by the actual version of Camel.
256.2. URI Format
openstack-swift://hosturl[?options]
openstack-swift://hosturl[?options]
You can append query options to the URI in the following format ?options=value&option2=value&…
256.3. URI Options
The OpenStack Swift component has no options.
The OpenStack Swift endpoint is configured using URI syntax:
openstack-swift:host
openstack-swift:hostwith the following path and query parameters:
256.3.1. Path Parameters (1 parameters):
| Name | Description | Default | Type |
|---|---|---|---|
| host | Required OpenStack host url | String |
256.3.2. Query Parameters (9 parameters):
| Name | Description | Default | Type |
|---|---|---|---|
| apiVersion (producer) | OpenStack API version | V3 | String |
| config (producer) | OpenStack configuration | Config | |
| domain (producer) | Authentication domain | default | String |
| operation (producer) | The operation to do | String | |
| password (producer) | Required OpenStack password | String | |
| project (producer) | Required The project ID | String | |
| subsystem (producer) | Required OpenStack Swift subsystem | String | |
| username (producer) | Required OpenStack username | String | |
| synchronous (advanced) | Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported). | false | boolean |
256.4. Spring Boot Auto-Configuration
The component supports 2 options, which are listed below.
| Name | Description | Default | Type |
|---|---|---|---|
| camel.component.openstack-swift.enabled | Enable openstack-swift component | true | Boolean |
| camel.component.openstack-swift.resolve-property-placeholders | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | Boolean |
256.5. Usage
You can use following settings for each subsystem:
256.6. containers
256.6.1. Operations you can perform with the Container producer
| Operation | Description |
|---|---|
|
| Create new container. |
|
| Get the container. |
|
| Get all containers. |
|
| Update the container. |
|
| Delete the container. |
|
| Get metadata. |
|
| Create/update metadata. |
|
| Delete metadata. |
256.6.2. Message headers evaluated by the Volume producer
| Header | Type | Description |
|---|---|---|
|
|
| The operation to perform. |
|
|
| The container name. |
|
|
| Container metadata prefix. |
|
|
| Versions location. |
|
|
| ACL - container read. |
|
|
| ACL - container write. |
|
|
| List options - limit. |
|
|
| List options - marker. |
|
|
| List options - end marker. |
|
|
| List options - delimiter. |
|
|
| List options - path. |
If you need more precise container settings you can create new object of the type org.openstack4j.model.storage.object.options.CreateUpdateContainerOptions (in case of create or update operation) or org.openstack4j.model.storage.object.options.ContainerListOptions for listing containers and send in the message body.
256.7. objects
256.7.1. Operations you can perform with the Object producer
| Operation | Description |
|---|---|
|
| Create new object. |
|
| Get the object. |
|
| Get all objects. |
|
| Get update the object. |
|
| Delete the object. |
|
| Get metadata. |
|
| Create/update metadata. |
256.7.2. Message headers evaluated by the Object producer
| Header | Type | Description |
|---|---|---|
|
|
| The operation to perform. |
|
|
| The container name. |
|
|
| The object name. |
256.8. See Also
- Configuring Camel
- Component
- Endpoint
- Getting Started
- openstack Component
'%20d='M201.5%20305.5c-13.8%200-24.9-11.1-24.9-24.6%200-13.8%2011.1-24.9%2024.9-24.9%2013.6%200%2024.6%2011.1%2024.6%2024.9%200%2013.6-11.1%2024.6-24.6%2024.6zM504%20256c0%20137-111%20248-248%20248S8%20393%208%20256%20119%208%20256%208s248%20111%20248%20248zm-132.3-41.2c-9.4%200-17.7%203.9-23.8%2010-22.4-15.5-52.6-25.5-86.1-26.6l17.4-78.3%2055.4%2012.5c0%2013.6%2011.1%2024.6%2024.6%2024.6%2013.8%200%2024.9-11.3%2024.9-24.9s-11.1-24.9-24.9-24.9c-9.7%200-18%205.8-22.1%2013.8l-61.2-13.6c-3-.8-6.1%201.4-6.9%204.4l-19.1%2086.4c-33.2%201.4-63.1%2011.3-85.5%2026.8-6.1-6.4-14.7-10.2-24.1-10.2-34.9%200-46.3%2046.9-14.4%2062.8-1.1%205-1.7%2010.2-1.7%2015.5%200%2052.6%2059.2%2095.2%20132%2095.2%2073.1%200%20132.3-42.6%20132.3-95.2%200-5.3-.6-10.8-1.9-15.8%2031.3-16%2019.8-62.5-14.9-62.5zM302.8%20331c-18.2%2018.2-76.1%2017.9-93.6%200-2.2-2.2-6.1-2.2-8.3%200-2.5%202.5-2.5%206.4%200%208.6%2022.8%2022.8%2087.3%2022.8%20110.2%200%202.5-2.2%202.5-6.1%200-8.6-2.2-2.2-6.1-2.2-8.3%200zm7.7-75c-13.6%200-24.6%2011.1-24.6%2024.9%200%2013.6%2011.1%2024.6%2024.6%2024.6%2013.8%200%2024.9-11.1%2024.9-24.6%200-13.8-11-24.9-24.9-24.9z'/%3e%3c/svg%3e){kind=small}