OptaPlanner

Since Camel 2.13

Both producer and consumer are supported

The Optaplanner component solves the planning problem contained in a message with OptaPlanner.
For example: feed it an unsolved Vehicle Routing problem and it solves it.

The component supports consumer listening for SloverManager results and producer for processing Solution and ProblemChange.

Maven users will need to add the following dependency to their pom.xml for this component:

<dependency>
    <groupId>org.apache.camel</groupId>
    <artifactId>camel-optaplanner</artifactId>
    <version>x.x.x</version><!-- use the same version as your Camel core version -->
</dependency>

URI format

optaplanner:problemName[?options]

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

Configuring Options

Camel components are configured on two separate levels:

  • component level

  • endpoint level

Configuring Component Options

The component level is the highest level which holds general and common configurations that are inherited by the endpoints. For example a component may have security settings, credentials for authentication, urls for network connection and so forth.

Some components only have a few options, and others may have many. Because components typically have pre configured defaults that are commonly used, then you may often only need to configure a few options on a component; or none at all.

Configuring components can be done with the Component DSL, in a configuration file (application.properties|yaml), or directly with Java code.

Configuring Endpoint Options

Where you find yourself configuring the most is on endpoints, as endpoints often have many options, which allows you to configure what you need the endpoint to do. The options are also categorized into whether the endpoint is used as consumer (from) or as a producer (to), or used for both.

Configuring endpoints is most often done directly in the endpoint URI as path and query parameters. You can also use the Endpoint DSL and DataFormat DSL as a type safe way of configuring endpoints and data formats in Java.

A good practice when configuring options is to use Property Placeholders, which allows to not hardcode urls, port numbers, sensitive information, and other settings. In other words placeholders allows to externalize the configuration from your code, and gives more flexibility and reuse.

The following two sections lists all the options, firstly for the component followed by the endpoint.

Component Options

The OptaPlanner component supports 3 options, which are listed below.

Name Description Default Type

bridgeErrorHandler (consumer)

Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored.

false

boolean

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

autowiredEnabled (advanced)

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

Endpoint Options

The OptaPlanner endpoint is configured using URI syntax:

optaplanner:problemName

with the following path and query parameters:

Path Parameters (1 parameters)

Name Description Default Type

problemName (common)

Required Problem name.

String

Query Parameters (10 parameters)

Name Description Default Type

problemId (common)

In case of using SolverManager : the problem id.

1L

Long

solverId (common)

Specifies the solverId to user for the solver instance key.

DEFAULT_SOLVER

String

bridgeErrorHandler (consumer (advanced))

Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored.

false

boolean

exceptionHandler (consumer (advanced))

To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this option is not in use. By default the consumer will deal with exceptions, that will be logged at WARN or ERROR level and ignored.

ExceptionHandler

exchangePattern (consumer (advanced))

Sets the exchange pattern when the consumer creates an exchange.

Enum values:

  • InOnly

  • InOut

ExchangePattern

async (producer)

Specifies to perform operations in async mode.

false

boolean

threadPoolSize (producer)

Specifies the thread pool size to use when async is true.

10

int

lazyStartProducer (producer (advanced))

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

configFile (configFile)

If SolverManager is absent from the header \{OptaPlannerConstants.SOLVER_MANAGER} : A SolverManager will be created using this Optaplanner config file.

String

solverManager (solverManager)

SolverManager.

SolverManager

Message Headers

The OptaPlanner component supports 5 message header(s), which is/are listed below:

Name Description Default Type

CamelOptaPlannerSolverId (producer)

Constant: SOLVER_ID

Specifies the solverId to use.

String

CamelOptaPlannerIsAsync (producer)

Constant: IS_ASYNC

Specify whether to use another thread for submitting Solution instances rather than blocking the current thread.

Boolean

CamelOptaPlannerBestSolution (consumer)

Constant: BEST_SOLUTION

The best planning solution.

Object

CamelOptaPlannerIsSolving (producer)

Constant: IS_SOLVING

Is solving.

Boolean

CamelOptaPlannerSolverManager (producer)

Constant: SOLVER_MANAGER

The Solver Manager.

SolverManager

Message Body

Camel takes the planning problem for the IN body, solves it and returns it on the OUT body. The IN body object supports the following use cases:

  • If the body contains the PlanningSolution annotation, then it will be solved using the solver identified by solverId and either synchronously or asynchronously.

  • If the body is instance of ProblemChange, then it will trigger addProblemFactChange.

  • If the body is none of the above types, then the producer will return the best result from the solver identified by solverId

Samples

Solve a planning problem that’s on the ActiveMQ queue with OptaPlanner, passing the SolverManager:

from("activemq:My.Queue").
  .to("optaplanner:problemName?solverManager=#solverManager");

Expose OptaPlanner as a REST service, passing the Solver configuration file:

from("cxfrs:bean:rsServer?bindingStyle=SimpleConsumer")
  .to("optaplanner:problemName?configFile=/org/foo/barSolverConfig.xml");

Spring Boot Auto-Configuration

When using optaplanner 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-optaplanner-starter</artifactId>
  <version>x.x.x</version>
  <!-- use the same version as your Camel core version -->
</dependency>

The component supports 4 options, which are listed below.

Name Description Default Type

camel.component.optaplanner.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.optaplanner.bridge-error-handler

Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored.

false

Boolean

camel.component.optaplanner.enabled

Whether to enable auto configuration of the optaplanner component. This is enabled by default.

Boolean

camel.component.optaplanner.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
Back to top