OpenStack Neutron :: Apache Camel

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.

URI Format

openstack-neutron://hosturl[?options]

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

URI Options

The OpenStack Neutron component supports 2 options, which are listed below.

Name	Description	Default	Type
lazyStartProducer (producer)	Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel’s routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing.	false	boolean
basicPropertyBinding (advanced)	Deprecated Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities	false	boolean

Name

Description

Default

Type

lazyStartProducer (producer)

Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel’s routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing.

false

boolean

basicPropertyBinding (advanced)

Deprecated Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities

false

boolean

The OpenStack Neutron endpoint is configured using URI syntax:

openstack-neutron:host

with the following path and query parameters:

Path Parameters (1 parameters):

Name	Description	Default	Type
host	Required OpenStack host url		String

Name

Description

Default

Type

host

Required OpenStack host url

String

Query Parameters (11 parameters):

Name	Description	Default	Type
apiVersion (producer)	OpenStack API version. There are 2 enums and the value can be one of: V2, V3	V3	String
config (producer)	OpenStack configuration		Config
domain (producer)	Authentication domain	default	String
lazyStartProducer (producer)	Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel’s routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing.	false	boolean
operation (producer)	The operation to do		String
password (producer)	Required OpenStack password		String
project (producer)	Required The project ID		String
subsystem (producer)	Required OpenStack Neutron subsystem. There are 4 enums and the value can be one of: networks, subnets, ports, routers		String
username (producer)	Required OpenStack username		String
basicPropertyBinding (advanced)	Whether the endpoint should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities	false	boolean
synchronous (advanced)	Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported).	false	boolean

Name

Description

Default

Type

apiVersion (producer)

OpenStack API version. There are 2 enums and the value can be one of: V2, V3

V3

String

config (producer)

OpenStack configuration

Config

domain (producer)

Authentication domain

default

String

lazyStartProducer (producer)

Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel’s routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing.

false

boolean

operation (producer)

The operation to do

String

password (producer)

Required OpenStack password

String

project (producer)

Required The project ID

String

subsystem (producer)

Required OpenStack Neutron subsystem. There are 4 enums and the value can be one of: networks, subnets, ports, routers

String

username (producer)

Required OpenStack username

String

basicPropertyBinding (advanced)

Whether the endpoint should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities

false

boolean

synchronous (advanced)

Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported).

false

boolean

Usage

You can use following settings for each subsystem:

networks

Operations you can perform with the Network producer

Operation Description

Operation	Description
`create`	Create new network.
`get`	Get the network.
`getAll`	Get all networks.
`delete`	Delete the network.

create

Create new network.

get

Get the network.

getAll

Get all networks.

delete

Delete the network.

Message headers evaluated by the Network producer

Header Type Description

Header	Type	Description
`operation`	`String`	The operation to perform.
`ID`	`String`	ID of the network.
`name`	`String`	The network name.
`tenantId`	`String`	Tenant ID.
`adminStateUp`	`Boolean`	AdminStateUp header.
`networkType`	`org.openstack4j.model.network.NetworkType`	Network type.
`physicalNetwork`	`String`	Physical network.
`segmentId`	`String`	Segment ID.
`isShared`	`Boolean`	Is shared.
`isRouterExternal`	`Boolean`	Is router external.

operation

String

The operation to perform.

ID

String

ID of the network.

name

String

The network name.

tenantId

String

Tenant ID.

adminStateUp

Boolean

AdminStateUp header.

networkType

org.openstack4j.model.network.NetworkType

Network type.

physicalNetwork

String

Physical network.

segmentId

String

Segment ID.

isShared

Boolean

Is shared.

isRouterExternal

Boolean

Is router external.

If you need more precise network settings you can create new object of the type org.openstack4j.model.network.Network and send in the message body.

subnets

Operations you can perform with the Subnet producer

Operation Description

Operation	Description
`create`	Create new subnet.
`get`	Get the subnet.
`getAll`	Get all subnets.
`delete`	Delete the subnet.
`action`	Perform an action on the subnet.

create

Create new subnet.

get

Get the subnet.

getAll

Get all subnets.

delete

Delete the subnet.

action

Perform an action on the subnet.

Message headers evaluated by the Subnet producer

Header Type Description

Header	Type	Description
`operation`	`String`	The operation to perform.
`ID`	`String`	ID of the subnet.
`name`	`String`	The subnet name.
`networkId`	`String`	Network ID.
`enableDHCP`	`Boolean`	Enable DHCP.
`gateway`	`String`	Gateway.

operation

String

The operation to perform.

ID

String

ID of the subnet.

name

String

The subnet name.

networkId

String

Network ID.

enableDHCP

Boolean

Enable DHCP.

gateway

String

Gateway.

If you need more precise subnet settings you can create new object of the type org.openstack4j.model.network.Subnet and send in the message body.

ports

Operations you can perform with the Port producer

Operation Description

Operation	Description
`create`	Create new port.
`get`	Get the port.
`getAll`	Get all ports.
`update`	Update the port.
`delete`	Delete the port.

create

Create new port.

get

Get the port.

getAll

Get all ports.

update

Update the port.

delete

Delete the port.

Message headers evaluated by the Port producer

Header Type Description

Header	Type	Description
`operation`	`String`	The operation to perform.
`name`	`String`	The port name.
`networkId`	`String`	Network ID.
`tenantId`	`String`	Tenant ID.
`deviceId`	`String`	Device ID.
`macAddress`	`String`	MAC address.

operation

String

The operation to perform.

name

String

The port name.

networkId

String

Network ID.

tenantId

String

Tenant ID.

deviceId

String

Device ID.

macAddress

String

MAC address.

routers

Operations you can perform with the Router producer

Operation Description

Operation	Description
`create`	Create new router.
`get`	Get the router.
`getAll`	Get all routers.
`update`	Update the router.
`delete`	Delete the router.
`attachInterface`	Attach an interface.
`detachInterface`	Detach an interface.

create

Create new router.

get

Get the router.

getAll

Get all routers.

update

Update the router.

delete

Delete the router.

attachInterface

Attach an interface.

detachInterface

Detach an interface.

Message headers evaluated by the Port producer

Header Type Description

Header	Type	Description
`operation`	`String`	The operation to perform.
`name`	`String`	The router name.
`routerId`	`String`	Router ID.
`subnetId`	`String`	Subnet ID.
`portId`	`String`	Port ID.
`interfaceType`	`org.openstack4j.model.network.AttachInterfaceType`	Interface type.
`tenantId`	`String`	Tenant ID.

operation

String

The operation to perform.

name

String

The router name.

routerId

String

Router ID.

subnetId

String

Subnet ID.

portId

String

Port ID.

interfaceType

org.openstack4j.model.network.AttachInterfaceType

Interface type.

tenantId

String

Tenant ID.

Spring Boot Auto-Configuration

When using openstack with Spring Boot make sure to use the following Maven dependency to have support for auto configuration:

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

The component supports 18 options, which are listed below.

Name	Description	Default	Type
camel.component.openstack-cinder.autowired-enabled	Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc.	true	Boolean
camel.component.openstack-cinder.enabled	Whether to enable auto configuration of the openstack-cinder component. This is enabled by default.		Boolean
camel.component.openstack-cinder.lazy-start-producer	Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel’s routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing.	false	Boolean
camel.component.openstack-glance.autowired-enabled	Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc.	true	Boolean
camel.component.openstack-glance.enabled	Whether to enable auto configuration of the openstack-glance component. This is enabled by default.		Boolean
camel.component.openstack-glance.lazy-start-producer	Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel’s routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing.	false	Boolean
camel.component.openstack-keystone.autowired-enabled	Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc.	true	Boolean
camel.component.openstack-keystone.enabled	Whether to enable auto configuration of the openstack-keystone component. This is enabled by default.		Boolean
camel.component.openstack-keystone.lazy-start-producer	Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel’s routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing.	false	Boolean
camel.component.openstack-neutron.autowired-enabled	Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc.	true	Boolean
camel.component.openstack-neutron.enabled	Whether to enable auto configuration of the openstack-neutron component. This is enabled by default.		Boolean
camel.component.openstack-neutron.lazy-start-producer	Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel’s routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing.	false	Boolean
camel.component.openstack-nova.autowired-enabled	Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc.	true	Boolean
camel.component.openstack-nova.enabled	Whether to enable auto configuration of the openstack-nova component. This is enabled by default.		Boolean
camel.component.openstack-nova.lazy-start-producer	Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel’s routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing.	false	Boolean
camel.component.openstack-swift.autowired-enabled	Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc.	true	Boolean
camel.component.openstack-swift.enabled	Whether to enable auto configuration of the openstack-swift component. This is enabled by default.		Boolean
camel.component.openstack-swift.lazy-start-producer	Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel’s routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing.	false	Boolean

Name

Description

Default

Type

camel.component.openstack-cinder.autowired-enabled

Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc.

true

Boolean

camel.component.openstack-cinder.enabled

Whether to enable auto configuration of the openstack-cinder component. This is enabled by default.

Boolean

camel.component.openstack-cinder.lazy-start-producer

Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel’s routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing.

false

Boolean

camel.component.openstack-glance.autowired-enabled

Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc.

true

Boolean

camel.component.openstack-glance.enabled

Whether to enable auto configuration of the openstack-glance component. This is enabled by default.

Boolean

camel.component.openstack-glance.lazy-start-producer

Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel’s routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing.

false

Boolean

camel.component.openstack-keystone.autowired-enabled

Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc.

true

Boolean

camel.component.openstack-keystone.enabled

Whether to enable auto configuration of the openstack-keystone component. This is enabled by default.

Boolean

camel.component.openstack-keystone.lazy-start-producer

Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel’s routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing.

false

Boolean

camel.component.openstack-neutron.autowired-enabled

Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc.

true

Boolean

camel.component.openstack-neutron.enabled

Whether to enable auto configuration of the openstack-neutron component. This is enabled by default.

Boolean

camel.component.openstack-neutron.lazy-start-producer

Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel’s routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing.

false

Boolean

camel.component.openstack-nova.autowired-enabled

Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc.

true

Boolean

camel.component.openstack-nova.enabled

Whether to enable auto configuration of the openstack-nova component. This is enabled by default.

Boolean

camel.component.openstack-nova.lazy-start-producer

Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel’s routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing.

false

Boolean

camel.component.openstack-swift.autowired-enabled

Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc.

true

Boolean

camel.component.openstack-swift.enabled

Whether to enable auto configuration of the openstack-swift component. This is enabled by default.

Boolean

camel.component.openstack-swift.lazy-start-producer

Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel’s routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing.

false

Boolean