| {"component":{"kind":"component","name":"jbpm","title":"JBPM","description":"Interact with jBPM workflow engine over REST.","deprecated":false,"firstVersion":"2.6.0","label":"api,workflow","javaType":"org.apache.camel.component.jbpm.JBPMComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-jbpm","version":"3.18.1","scheme":"jbpm","extendsScheme":"","syntax":"jbpm:connectionURL","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false},"headers":{"CamelJBPMValue":{"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Object","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The value to assign to the global identifier","constantName":"org.apache.camel.component.jbpm.JBPMConstants#VALUE"},"CamelJBPMOperation":{"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":"PUT","description":"The operation to perform. The operation name must be prefixed with CamelJBPMOperation and the name of the operation. See the full list above. It is case-insensitive.","constantName":"org.apache.camel.component.jbpm.JBPMConstants#OPERATION"},"CamelJBPMProcessId":{"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The id of the process that should be acted upon","constantName":"org.apache.camel.component.jbpm.JBPMConstants#PROCESS_ID"},"CamelJBPMProcessInstanceId":{"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The id of the process instance","constantName":"org.apache.camel.component.jbpm.JBPMConstants#PROCESS_INSTANCE_ID"},"CamelJBPMParameters":{"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Map<String, Object>","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The variables that should be set for various operations","constantName":"org.apache.camel.component.jbpm.JBPMConstants#PARAMETERS"},"CamelJBPMEventType":{"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The type of event to use when signalEvent operation is performed","constantName":"org.apache.camel.component.jbpm.JBPMConstants#EVENT_TYPE"},"CamelJBPMEvent":{"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Object","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The type of the received event. Possible values defined here org.infinispan.notifications.cachelistener.event.Event.Type","constantName":"org.apache.camel.component.jbpm.JBPMConstants#EVENT"},"CamelJBPMMaxNumber":{"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The maximum number of rules that should be fired","constantName":"org.apache.camel.component.jbpm.JBPMConstants#MAX_NUMBER"},"CamelJBPMIdentifier":{"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The global identifier","constantName":"org.apache.camel.component.jbpm.JBPMConstants#IDENTIFIER"},"CamelJBPMWorkItemId":{"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The id of the work item","constantName":"org.apache.camel.component.jbpm.JBPMConstants#WORK_ITEM_ID"},"CamelJBPMTaskId":{"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The id of the task","constantName":"org.apache.camel.component.jbpm.JBPMConstants#TASK_ID"},"CamelJBPMTask":{"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"org.kie.api.task.model.Task","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The task instance to use with task operations","constantName":"org.apache.camel.component.jbpm.JBPMConstants#TASK"},"CamelJBPMUserId":{"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The userId to use with task operations","constantName":"org.apache.camel.component.jbpm.JBPMConstants#USER_ID"},"CamelJBPMTargetUserId":{"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The targetUserId used when delegating a task","constantName":"org.apache.camel.component.jbpm.JBPMConstants#TARGET_USER_ID"},"CamelJBPMAttachmentId":{"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The attachId to use when retrieving attachments","constantName":"org.apache.camel.component.jbpm.JBPMConstants#ATTACHMENT_ID"},"CamelJBPMContentId":{"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The contentId to use when retrieving attachments","constantName":"org.apache.camel.component.jbpm.JBPMConstants#CONTENT_ID"},"CamelJBPMEntityList":{"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"List<String>","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The potentialOwners when nominateTask operation is performed","constantName":"org.apache.camel.component.jbpm.JBPMConstants#ENTITY_LIST"},"CamelJBPMStatusList":{"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"List<String>","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The list of status to use when filtering tasks.","constantName":"org.apache.camel.component.jbpm.JBPMConstants#STATUS_LIST"},"CamelJBPMResultPage":{"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The page to use when retrieving user tasks","constantName":"org.apache.camel.component.jbpm.JBPMConstants#RESULT_PAGE"},"CamelJBPMResultPageSize":{"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Integer","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The page size to use when retrieving user tasks","constantName":"org.apache.camel.component.jbpm.JBPMConstants#RESULT_PAGE_SIZE"}},"properties":{"connectionURL":{"kind":"path","displayName":"Connection URL","group":"common","label":"","required":true,"type":"string","javaType":"java.net.URL","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jbpm.JBPMConfiguration","configurationField":"configuration","description":"The URL to the jBPM server."},"eventListenerType":{"kind":"path","displayName":"Event Listener Type","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jbpm.JBPMConfiguration","configurationField":"configuration","description":"Sets the event listener type to attach to"},"attachmentId":{"kind":"parameter","displayName":"Attachment Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jbpm.JBPMConfiguration","configurationField":"configuration","description":"attachId to use when retrieving attachments"},"contentId":{"kind":"parameter","displayName":"Content Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jbpm.JBPMConfiguration","configurationField":"configuration","description":"contentId to use when retrieving attachments"},"deploymentId":{"kind":"parameter","displayName":"Deployment Id","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jbpm.JBPMConfiguration","configurationField":"configuration","description":"The id of the deployment"},"emitterSendItems":{"kind":"parameter","displayName":"Emitter Send Items","group":"common","label":"","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jbpm.JBPMConfiguration","configurationField":"configuration","description":"Sets if event produced by emitter should be sent as single items or complete collection"},"event":{"kind":"parameter","displayName":"Event","group":"common","label":"","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jbpm.JBPMConfiguration","configurationField":"configuration","description":"the data associated with this event when signalEvent operation is performed"},"eventType":{"kind":"parameter","displayName":"Event Type","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jbpm.JBPMConfiguration","configurationField":"configuration","description":"the type of event to use when signalEvent operation is performed"},"identifier":{"kind":"parameter","displayName":"Identifier","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jbpm.JBPMConfiguration","configurationField":"configuration","description":"identifier the global identifier"},"maxNumber":{"kind":"parameter","displayName":"Max Number","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jbpm.JBPMConfiguration","configurationField":"configuration","description":"the maximum number of rules that should be fired"},"page":{"kind":"parameter","displayName":"Page","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jbpm.JBPMConfiguration","configurationField":"configuration","description":"The page to use when retrieving user tasks"},"pageSize":{"kind":"parameter","displayName":"Page Size","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jbpm.JBPMConfiguration","configurationField":"configuration","description":"The page size to use when retrieving user tasks"},"processId":{"kind":"parameter","displayName":"Process Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jbpm.JBPMConfiguration","configurationField":"configuration","description":"the id of the process that should be acted upon"},"processInstanceId":{"kind":"parameter","displayName":"Process Instance Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jbpm.JBPMConfiguration","configurationField":"configuration","description":"the id of the process instance"},"targetUserId":{"kind":"parameter","displayName":"Target User Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jbpm.JBPMConfiguration","configurationField":"configuration","description":"The targetUserId used when delegating a task"},"task":{"kind":"parameter","displayName":"Task","group":"common","label":"","required":false,"type":"object","javaType":"org.kie.api.task.model.Task","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jbpm.JBPMConfiguration","configurationField":"configuration","description":"The task instance to use with task operations"},"taskId":{"kind":"parameter","displayName":"Task Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jbpm.JBPMConfiguration","configurationField":"configuration","description":"the id of the task"},"timeout":{"kind":"parameter","displayName":"Timeout","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jbpm.JBPMConfiguration","configurationField":"configuration","description":"A timeout value"},"userId":{"kind":"parameter","displayName":"User Id","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jbpm.JBPMConfiguration","configurationField":"configuration","description":"userId to use with task operations"},"value":{"kind":"parameter","displayName":"Value","group":"common","label":"","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jbpm.JBPMConfiguration","configurationField":"configuration","description":"the value to assign to the global identifier"},"workItemId":{"kind":"parameter","displayName":"Work Item Id","group":"common","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jbpm.JBPMConfiguration","configurationField":"configuration","description":"the id of the work item"},"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."},"synchronous":{"kind":"parameter","displayName":"Synchronous","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Sets whether synchronous processing should be strictly used"},"operation":{"kind":"parameter","displayName":"Operation","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"defaultValue":"startProcess","configurationClass":"org.apache.camel.component.jbpm.JBPMConfiguration","configurationField":"configuration","description":"The operation to perform"},"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."},"entities":{"kind":"parameter","displayName":"Entities","group":"advanced","label":"advanced","required":false,"type":"array","javaType":"java.util.List<java.lang.String>","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jbpm.JBPMConfiguration","configurationField":"configuration","description":"The potentialOwners when nominateTask operation is performed"},"extraJaxbClasses":{"kind":"parameter","displayName":"Extra Jaxb Classes","group":"advanced","label":"advanced","required":false,"type":"string","javaType":"java.lang.Class[]","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jbpm.JBPMConfiguration","configurationField":"configuration","description":"To load additional classes when working with XML"},"parameters":{"kind":"parameter","displayName":"Parameters","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"java.util.Map<java.lang.String, java.lang.Object>","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jbpm.JBPMConfiguration","configurationField":"configuration","description":"the variables that should be set for various operations"},"statuses":{"kind":"parameter","displayName":"Statuses","group":"filter","label":"filter","required":false,"type":"array","javaType":"java.util.List<java.lang.String>","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jbpm.JBPMConfiguration","configurationField":"configuration","description":"The list of status to use when filtering tasks"},"password":{"kind":"parameter","displayName":"Password","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.jbpm.JBPMConfiguration","configurationField":"configuration","description":"Password for authentication"},"userName":{"kind":"parameter","displayName":"User Name","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.jbpm.JBPMConfiguration","configurationField":"configuration","description":"Username for authentication"}}} |