OptaPlanner
Available as of Camel 2.13
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.
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:solverConfig[?options]
The solverConfig is the classpath-local URI of the solverConfig, for example /org/foo/barSolverConfig.xml.
You can append query options to the URI in the following format, ?option=value&option=value&...
Options
No options supported yet.
Message Headers
No message headers supported yet.
Message Body
Camel takes the planning problem for the IN body, solves it and returns it on the OUT body.
The IN body object must implement the optaplanner interface Solution.
Termination
The solving will take as long as specified in the solverConfig.
<solver>
...
<termination>
<!-- Terminate after 10 seconds, unless it's not feasible by then yet -->
<terminationCompositionStyle>AND</terminationCompositionStyle>
<maximumSecondsSpend>10</maximumSecondsSpend>
<scoreAttained>-1hard/0soft</scoreAttained>
</termination>
...
<solver>
NOTE While the Solver is solving, it will effectively hog that camel thread. Future improvements might include solving in a separate thread:
- Asynchronous solving: 1 request starts the solving and registers a callback. When the Solver terminates, the best Solution is returned through the callback.
- 2 phase request solving: 1 request starts the solving on a separate thread. Another request (with an id to the first request) terminates the Solver with Solver.terminateEarly() and returns the best Solution.
Samples
Solve an planning problem that's on the ActiveMQ queue with OptaPlanner:
from("activemq:My.Queue").
.to("optaplanner:/org/foo/barSolverConfig.xml");
Expose OptaPlanner as a REST service:
from("cxfrs:bean:rsServer?bindingStyle=SimpleConsumer")
.to("optaplanner:/org/foo/barSolverConfig.xml");