Chapter 243. 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.

243.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>

where ${camel-version} must be replaced by the actual version of Camel.

243.2. URI Format

openstack-swift://hosturl[?options]

You can append query options to the URI in the following format ?options=value&option2=value&…​

243.3. URI Options

The OpenStack Swift component has no options.

The OpenStack Swift endpoint is configured using URI syntax:

openstack-swift:host

with the following path and query parameters:

243.3.1. Path Parameters (1 parameters):

NameDescriptionDefaultType

host

Required OpenStack host url

 

String

243.3.2. Query Parameters (9 parameters):

NameDescriptionDefaultType

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

243.4. Usage

You can use following settings for each subsystem:

243.5. containers

243.5.1. Operations you can perform with the Container producer

OperationDescription

create

Create new container.

get

Get the container.

getAll

Get all containers.

update

Update the container.

delete

Delete the container.

getMetadata

Get metadata.

createUpdateMetadata

Create/update metadata.

deleteMetadata

Delete metadata.

243.5.2. Message headers evaluated by the Volume producer

HeaderTypeDescription

operation

String

The operation to perform.

name

String

The container name.

X-Container-Meta-

Map

Container metadata prefix.

X-Versions-Location

String

Versions location.

X-Container-Read

String

ACL - container read.

X-Container-Write

String

ACL - container write.

limit

Integer

List options - limit.

marker

String

List options - marker.

end_marker

String

List options - end marker.

delimiter

Character

List options - delimiter.

path

String

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.

243.6. objects

243.6.1. Operations you can perform with the Object producer

OperationDescription

create

Create new object.

get

Get the object.

getAll

Get all objects.

update

Get update the object.

delete

Delete the object.

getMetadata

Get metadata.

createUpdateMetadata

Create/update metadata.

243.6.2. Message headers evaluated by the Object producer

HeaderTypeDescription

operation

String

The operation to perform.

containerName

String

The container name.

objectName

String

The object name.

243.7. See Also

  • Configuring Camel
  • Component
  • Endpoint
  • Getting Started
  • openstack Component