camel-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From acosent...@apache.org
Subject camel git commit: Added camel-optaplanner docs to Gitbook
Date Tue, 17 May 2016 08:33:10 GMT
Repository: camel
Updated Branches:
  refs/heads/master 7d165439c -> e5c7f624f


Added camel-optaplanner docs to Gitbook


Project: http://git-wip-us.apache.org/repos/asf/camel/repo
Commit: http://git-wip-us.apache.org/repos/asf/camel/commit/e5c7f624
Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/e5c7f624
Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/e5c7f624

Branch: refs/heads/master
Commit: e5c7f624f6bef1c1666489aef92abf74a81dba93
Parents: 7d16543
Author: Andrea Cosentino <ancosen@gmail.com>
Authored: Tue May 17 10:30:32 2016 +0200
Committer: Andrea Cosentino <ancosen@gmail.com>
Committed: Tue May 17 10:30:32 2016 +0200

----------------------------------------------------------------------
 .../src/main/docs/optaplanner.adoc              | 153 +++++++++++++++++++
 docs/user-manual/en/SUMMARY.md                  |   1 +
 2 files changed, 154 insertions(+)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/camel/blob/e5c7f624/components/camel-optaplanner/src/main/docs/optaplanner.adoc
----------------------------------------------------------------------
diff --git a/components/camel-optaplanner/src/main/docs/optaplanner.adoc b/components/camel-optaplanner/src/main/docs/optaplanner.adoc
new file mode 100644
index 0000000..e6c6f16
--- /dev/null
+++ b/components/camel-optaplanner/src/main/docs/optaplanner.adoc
@@ -0,0 +1,153 @@
+[[OptaPlanner-OptaPlanner]]
+OptaPlanner
+~~~~~~~~~~~
+
+*Available as of Camel 2.13*
+
+The *optaplanner:* component solves the planning problem contained in a
+message with http://www.optaplanner.org/[OptaPlanner]. +
+ For example: feed it an unsolved Vehicle Routing problem and it solves
+it.
+
+The component supports consumer as BestSolutionChangedEvent listener and
+producer for processing Solution and ProblemFactChange
+
+Maven users will need to add the following dependency to their `pom.xml`
+for this component:
+
+[source,xml]
+------------------------------------------------------------------------------------
+<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>
+------------------------------------------------------------------------------------
+
+[[OptaPlanner-URIformat]]
+URI format
+^^^^^^^^^^
+
+[source,java]
+----------------------------------
+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&...`
+
+[[OptaPlanner-URIOptions]]
+OptaPlanner Options
+^^^^^^^^^^^
+
+
+// component options: START
+The OptaPlanner component has no options.
+// component options: END
+
+
+
+// endpoint options: START
+The OptaPlanner component supports 8 endpoint options which are listed below:
+
+{% raw %}
+[width="100%",cols="2s,1,1m,1m,5",options="header"]
+|=======================================================================
+| Name | Group | Default | Java Type | Description
+| configFile | common |  | String | *Required* Specifies the location to the solver file
+| solverId | common | DEFAULT_SOLVER | String | Specifies the solverId to user for the solver
instance key
+| bridgeErrorHandler | consumer | false | boolean | 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/ERROR level and ignored.
+| exceptionHandler | consumer (advanced) |  | ExceptionHandler | To let the consumer use
a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options
is not in use. By default the consumer will deal with exceptions that will be logged at WARN/ERROR
level and ignored.
+| async | producer | false | boolean | Specifies to perform operations in async mode
+| threadPoolSize | producer | 10 | int | Specifies the thread pool size to use when async
is true
+| exchangePattern | advanced | InOnly | ExchangePattern | Sets the default exchange pattern
when creating an exchange
+| synchronous | advanced | false | boolean | Sets whether synchronous processing should be
strictly used or Camel is allowed to use asynchronous processing (if supported).
+|=======================================================================
+{% endraw %}
+// endpoint options: END
+
+
+[[OptaPlanner-MessageHeaders]]
+Message Headers
+^^^^^^^^^^^^^^^
+
+[width="100%",cols="10%,10%,10%,10%,60%",options="header",]
+|=======================================================================
+|Name |Default Value |Type |Context |Description
+
+|CamelOptaPlannerSolverId |null |String |Shared |Specifies the solverId to use
+
+|CamelOptaPlannerIsAsync |PUT |String |Producer |Specify whether to use another thread for
submitting Solution instances
+rather than blocking the current thread.
+|=======================================================================
+
+[[OptaPlanner-MessageBody]]
+Message Body
+^^^^^^^^^^^^
+
+Camel takes the planning problem for the IN body, solves it and returns
+it on the OUT body. (since v 2.16) The IN body object supports the following use cases:
+
+* If the body is instance of Solution, then it will be solved using the
+solver identified by solverId and either synchronously or
+asynchronously.
+* If the body is instance of ProblemFactChange, then it will trigger
+addProblemFactChange. If the processing is asynchronously, then it will
+wait till isEveryProblemFactChangeProcessed before returning result.
+* If the body is none of the above types, then the producer will return
+the best result from the solver identified by solverId
+
+[[OptaPlanner-Termination]]
+Termination
+^^^^^^^^^^^
+
+The solving will take as long as specified in the `solverConfig`.
+
+[source,xml]
+-----------------------------------------------------------------------------
+<solver>
+  ...
+  <termination>
+    <!-- Terminate after 10 seconds, unless it's not feasible by then yet -->
+    <terminationCompositionStyle>AND</terminationCompositionStyle>
+    <secondsSpentLimit>10</secondsSpentLimit>
+    <bestScoreLimit>-1hard/0soft</bestScoreLimit>
+  </termination>
+  ...
+<solver>
+-----------------------------------------------------------------------------
+
+ 
+
+[[OptaPlanner-Samples]]
+Samples
++++++++
+
+Solve an planning problem that's on the ActiveMQ queue with OptaPlanner:
+
+[source,java]
+--------------------------------------------------
+from("activemq:My.Queue").
+  .to("optaplanner:/org/foo/barSolverConfig.xml");
+--------------------------------------------------
+
+Expose OptaPlanner as a REST service:
+
+[source,java]
+-------------------------------------------------------
+from("cxfrs:bean:rsServer?bindingStyle=SimpleConsumer")
+  .to("optaplanner:/org/foo/barSolverConfig.xml");
+-------------------------------------------------------
+
+[[OptaPlanner-SeeAlso]]
+See Also
+^^^^^^^^
+
+* link:configuring-camel.html[Configuring Camel]
+* link:component.html[Component]
+* link:endpoint.html[Endpoint]
+* link:getting-started.html[Getting Started]
+

http://git-wip-us.apache.org/repos/asf/camel/blob/e5c7f624/docs/user-manual/en/SUMMARY.md
----------------------------------------------------------------------
diff --git a/docs/user-manual/en/SUMMARY.md b/docs/user-manual/en/SUMMARY.md
index b29fe6b..5ff2e96 100644
--- a/docs/user-manual/en/SUMMARY.md
+++ b/docs/user-manual/en/SUMMARY.md
@@ -211,6 +211,7 @@
     * [NATS](nats.adoc)
     * [Olingo2](olingo2.adoc)
     * [Openshift](openshift.adoc)
+    * [Optaplanner](optaplanner.adoc)
     * [Properties](properties.adoc)
     * [Quickfix](quickfix.adoc)
     * [Scp](scp.adoc)


Mime
View raw message