| {"component":{"kind":"component","name":"optaplanner","title":"OptaPlanner","description":"Solve planning problems with OptaPlanner.","deprecated":false,"firstVersion":"2.13.0","label":"engine,planning","javaType":"org.apache.camel.component.optaplanner.OptaPlannerComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-optaplanner","version":"3.18.1","scheme":"optaplanner","extendsScheme":"","syntax":"optaplanner:configFile","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false},"headers":{"CamelOptaPlannerSolverId":{"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Specifies the solverId to use.","constantName":"org.apache.camel.component.optaplanner.OptaPlannerConstants#SOLVER_ID"},"CamelOptaPlannerIsAsync":{"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Specify whether to use another thread for submitting Solution instances rather than blocking the current thread.","constantName":"org.apache.camel.component.optaplanner.OptaPlannerConstants#IS_ASYNC"},"CamelOptaPlannerBestSolution":{"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"Object","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The best planning solution.","constantName":"org.apache.camel.component.optaplanner.OptaPlannerConstants#BEST_SOLUTION"},"CamelOptaPlannerIsSolving":{"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Is solving.","constantName":"org.apache.camel.component.optaplanner.OptaPlannerConstants#IS_SOLVING"},"CamelOptaPlannerIsTerminateEarly":{"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"true if terminateEarly has been called since the Solver started.","constantName":"org.apache.camel.component.optaplanner.OptaPlannerConstants#IS_TERMINATE_EARLY"},"CamelOptaPlannerSolverManager":{"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"org.optaplanner.core.api.solver.SolverManager","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Solver Manager.","constantName":"org.apache.camel.component.optaplanner.OptaPlannerConstants#SOLVER_MANAGER"}},"properties":{"configFile":{"kind":"path","displayName":"Config File","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.optaplanner.OptaPlannerConfiguration","configurationField":"configuration","description":"Specifies the location to the solver file. If useSolverManager=FALSE, Camel uses this file and create the Solver. If useSolverManager=TRUE and SolverManager is set in the header {OptaPlannerConstants.SOLVER_MANAGER} : this file is ignored by Camel usage of SolverManager. SolverManager can be injected by DI in Quarkus or Spring."},"problemId":{"kind":"parameter","displayName":"Problem Id","group":"common","label":"common","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"1L","configurationClass":"org.apache.camel.component.optaplanner.OptaPlannerConfiguration","configurationField":"configuration","description":"In case of using SolverManager : the problem id"},"solverId":{"kind":"parameter","displayName":"Solver Id","group":"common","label":"common","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"DEFAULT_SOLVER","configurationClass":"org.apache.camel.component.optaplanner.OptaPlannerConfiguration","configurationField":"configuration","description":"Specifies the solverId to user for the solver instance key"},"useSolverManager":{"kind":"parameter","displayName":"Use Solver Manager","group":"common","label":"common","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.optaplanner.OptaPlannerConfiguration","configurationField":"configuration","description":"use SolverManager instead of XML file config. Use this mode on Quarkus app."},"bridgeErrorHandler":{"kind":"parameter","displayName":"Bridge Error Handler","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"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."},"exceptionHandler":{"kind":"parameter","displayName":"Exception Handler","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.ExceptionHandler","optionalPrefix":"consumer.","deprecated":false,"autowired":false,"secret":false,"description":"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."},"exchangePattern":{"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut","InOptionalOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"async":{"kind":"parameter","displayName":"Async","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.optaplanner.OptaPlannerConfiguration","configurationField":"configuration","description":"Specifies to perform operations in async mode"},"threadPoolSize":{"kind":"parameter","displayName":"Thread Pool Size","group":"producer","label":"producer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":10,"configurationClass":"org.apache.camel.component.optaplanner.OptaPlannerConfiguration","configurationField":"configuration","description":"Specifies the thread pool size to use when async is true"},"lazyStartProducer":{"kind":"parameter","displayName":"Lazy Start Producer","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"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."}}} |