Interface JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder
-
- All Superinterfaces:
org.apache.camel.builder.EndpointConsumerBuilder
,org.apache.camel.EndpointConsumerResolver
- All Known Subinterfaces:
JBPMEndpointBuilderFactory.JBPMEndpointBuilder
- Enclosing interface:
- JBPMEndpointBuilderFactory
public static interface JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder extends org.apache.camel.builder.EndpointConsumerBuilder
Builder for endpoint consumers for the JBPM component.
-
-
Method Summary
All Methods Instance Methods Default Methods Modifier and Type Method Description default JBPMEndpointBuilderFactory.AdvancedJBPMEndpointConsumerBuilder
advanced()
default JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder
attachmentId(Long attachmentId)
attachId to use when retrieving attachments.default JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder
attachmentId(String attachmentId)
attachId to use when retrieving attachments.default JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder
bridgeErrorHandler(boolean bridgeErrorHandler)
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.default JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder
bridgeErrorHandler(String bridgeErrorHandler)
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.default JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder
contentId(Long contentId)
contentId to use when retrieving attachments.default JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder
contentId(String contentId)
contentId to use when retrieving attachments.default JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder
deploymentId(String deploymentId)
The id of the deployment.default JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder
emitterSendItems(Boolean emitterSendItems)
Sets if event produced by emitter should be sent as single items or complete collection.default JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder
emitterSendItems(String emitterSendItems)
Sets if event produced by emitter should be sent as single items or complete collection.default JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder
event(Object event)
the data associated with this event when signalEvent operation is performed.default JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder
event(String event)
the data associated with this event when signalEvent operation is performed.default JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder
eventType(String eventType)
the type of event to use when signalEvent operation is performed.default JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder
identifier(String identifier)
identifier the global identifier.default JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder
maxNumber(Integer maxNumber)
the maximum number of rules that should be fired.default JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder
maxNumber(String maxNumber)
the maximum number of rules that should be fired.default JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder
page(Integer page)
The page to use when retrieving user tasks.default JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder
page(String page)
The page to use when retrieving user tasks.default JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder
pageSize(Integer pageSize)
The page size to use when retrieving user tasks.default JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder
pageSize(String pageSize)
The page size to use when retrieving user tasks.default JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder
password(String password)
Password for authentication.default JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder
processId(String processId)
the id of the process that should be acted upon.default JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder
processInstanceId(Long processInstanceId)
the id of the process instance.default JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder
processInstanceId(String processInstanceId)
the id of the process instance.default JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder
statuses(String statuses)
The list of status to use when filtering tasks.default JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder
statuses(List<String> statuses)
The list of status to use when filtering tasks.default JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder
targetUserId(String targetUserId)
The targetUserId used when delegating a task.default JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder
task(Object task)
The task instance to use with task operations.default JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder
task(String task)
The task instance to use with task operations.default JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder
taskId(Long taskId)
the id of the task.default JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder
taskId(String taskId)
the id of the task.default JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder
timeout(Integer timeout)
A timeout value.default JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder
timeout(String timeout)
A timeout value.default JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder
userId(String userId)
userId to use with task operations.default JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder
userName(String userName)
Username for authentication.default JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder
value(Object value)
the value to assign to the global identifier.default JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder
value(String value)
the value to assign to the global identifier.default JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder
workItemId(Long workItemId)
the id of the work item.default JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder
workItemId(String workItemId)
the id of the work item.
-
-
-
Method Detail
-
advanced
default JBPMEndpointBuilderFactory.AdvancedJBPMEndpointConsumerBuilder advanced()
-
attachmentId
default JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder attachmentId(Long attachmentId)
attachId to use when retrieving attachments. The option is a: <code>java.lang.Long</code> type. Group: common- Parameters:
attachmentId
- the value to set- Returns:
- the dsl builder
-
attachmentId
default JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder attachmentId(String attachmentId)
attachId to use when retrieving attachments. The option will be converted to a <code>java.lang.Long</code> type. Group: common- Parameters:
attachmentId
- the value to set- Returns:
- the dsl builder
-
contentId
default JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder contentId(Long contentId)
contentId to use when retrieving attachments. The option is a: <code>java.lang.Long</code> type. Group: common- Parameters:
contentId
- the value to set- Returns:
- the dsl builder
-
contentId
default JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder contentId(String contentId)
contentId to use when retrieving attachments. The option will be converted to a <code>java.lang.Long</code> type. Group: common- Parameters:
contentId
- the value to set- Returns:
- the dsl builder
-
deploymentId
default JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder deploymentId(String deploymentId)
The id of the deployment. The option is a: <code>java.lang.String</code> type. Required: true Group: common- Parameters:
deploymentId
- the value to set- Returns:
- the dsl builder
-
emitterSendItems
default JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder emitterSendItems(Boolean emitterSendItems)
Sets if event produced by emitter should be sent as single items or complete collection. The option is a: <code>java.lang.Boolean</code> type. Group: common- Parameters:
emitterSendItems
- the value to set- Returns:
- the dsl builder
-
emitterSendItems
default JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder emitterSendItems(String emitterSendItems)
Sets if event produced by emitter should be sent as single items or complete collection. The option will be converted to a <code>java.lang.Boolean</code> type. Group: common- Parameters:
emitterSendItems
- the value to set- Returns:
- the dsl builder
-
event
default JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder event(Object event)
the data associated with this event when signalEvent operation is performed. The option is a: <code>java.lang.Object</code> type. Group: common- Parameters:
event
- the value to set- Returns:
- the dsl builder
-
event
default JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder event(String event)
the data associated with this event when signalEvent operation is performed. The option will be converted to a <code>java.lang.Object</code> type. Group: common- Parameters:
event
- the value to set- Returns:
- the dsl builder
-
eventType
default JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder eventType(String eventType)
the type of event to use when signalEvent operation is performed. The option is a: <code>java.lang.String</code> type. Group: common- Parameters:
eventType
- the value to set- Returns:
- the dsl builder
-
identifier
default JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder identifier(String identifier)
identifier the global identifier. The option is a: <code>java.lang.String</code> type. Group: common- Parameters:
identifier
- the value to set- Returns:
- the dsl builder
-
maxNumber
default JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder maxNumber(Integer maxNumber)
the maximum number of rules that should be fired. The option is a: <code>java.lang.Integer</code> type. Group: common- Parameters:
maxNumber
- the value to set- Returns:
- the dsl builder
-
maxNumber
default JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder maxNumber(String maxNumber)
the maximum number of rules that should be fired. The option will be converted to a <code>java.lang.Integer</code> type. Group: common- Parameters:
maxNumber
- the value to set- Returns:
- the dsl builder
-
page
default JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder page(Integer page)
The page to use when retrieving user tasks. The option is a: <code>java.lang.Integer</code> type. Group: common- Parameters:
page
- the value to set- Returns:
- the dsl builder
-
page
default JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder page(String page)
The page to use when retrieving user tasks. The option will be converted to a <code>java.lang.Integer</code> type. Group: common- Parameters:
page
- the value to set- Returns:
- the dsl builder
-
pageSize
default JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder pageSize(Integer pageSize)
The page size to use when retrieving user tasks. The option is a: <code>java.lang.Integer</code> type. Group: common- Parameters:
pageSize
- the value to set- Returns:
- the dsl builder
-
pageSize
default JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder pageSize(String pageSize)
The page size to use when retrieving user tasks. The option will be converted to a <code>java.lang.Integer</code> type. Group: common- Parameters:
pageSize
- the value to set- Returns:
- the dsl builder
-
processId
default JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder processId(String processId)
the id of the process that should be acted upon. The option is a: <code>java.lang.String</code> type. Group: common- Parameters:
processId
- the value to set- Returns:
- the dsl builder
-
processInstanceId
default JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder processInstanceId(Long processInstanceId)
the id of the process instance. The option is a: <code>java.lang.Long</code> type. Group: common- Parameters:
processInstanceId
- the value to set- Returns:
- the dsl builder
-
processInstanceId
default JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder processInstanceId(String processInstanceId)
the id of the process instance. The option will be converted to a <code>java.lang.Long</code> type. Group: common- Parameters:
processInstanceId
- the value to set- Returns:
- the dsl builder
-
targetUserId
default JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder targetUserId(String targetUserId)
The targetUserId used when delegating a task. The option is a: <code>java.lang.String</code> type. Group: common- Parameters:
targetUserId
- the value to set- Returns:
- the dsl builder
-
task
default JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder task(Object task)
The task instance to use with task operations. The option is a: <code>org.kie.api.task.model.Task</code> type. Group: common- Parameters:
task
- the value to set- Returns:
- the dsl builder
-
task
default JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder task(String task)
The task instance to use with task operations. The option will be converted to a <code>org.kie.api.task.model.Task</code> type. Group: common- Parameters:
task
- the value to set- Returns:
- the dsl builder
-
taskId
default JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder taskId(Long taskId)
the id of the task. The option is a: <code>java.lang.Long</code> type. Group: common- Parameters:
taskId
- the value to set- Returns:
- the dsl builder
-
taskId
default JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder taskId(String taskId)
the id of the task. The option will be converted to a <code>java.lang.Long</code> type. Group: common- Parameters:
taskId
- the value to set- Returns:
- the dsl builder
-
timeout
default JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder timeout(Integer timeout)
A timeout value. The option is a: <code>java.lang.Integer</code> type. Group: common- Parameters:
timeout
- the value to set- Returns:
- the dsl builder
-
timeout
default JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder timeout(String timeout)
A timeout value. The option will be converted to a <code>java.lang.Integer</code> type. Group: common- Parameters:
timeout
- the value to set- Returns:
- the dsl builder
-
userId
default JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder userId(String userId)
userId to use with task operations. The option is a: <code>java.lang.String</code> type. Group: common- Parameters:
userId
- the value to set- Returns:
- the dsl builder
-
value
default JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder value(Object value)
the value to assign to the global identifier. The option is a: <code>java.lang.Object</code> type. Group: common- Parameters:
value
- the value to set- Returns:
- the dsl builder
-
value
default JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder value(String value)
the value to assign to the global identifier. The option will be converted to a <code>java.lang.Object</code> type. Group: common- Parameters:
value
- the value to set- Returns:
- the dsl builder
-
workItemId
default JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder workItemId(Long workItemId)
the id of the work item. The option is a: <code>java.lang.Long</code> type. Group: common- Parameters:
workItemId
- the value to set- Returns:
- the dsl builder
-
workItemId
default JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder workItemId(String workItemId)
the id of the work item. The option will be converted to a <code>java.lang.Long</code> type. Group: common- Parameters:
workItemId
- the value to set- Returns:
- the dsl builder
-
bridgeErrorHandler
default JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder bridgeErrorHandler(boolean bridgeErrorHandler)
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. The option is a: <code>boolean</code> type. Default: false Group: consumer- Parameters:
bridgeErrorHandler
- the value to set- Returns:
- the dsl builder
-
bridgeErrorHandler
default JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder bridgeErrorHandler(String bridgeErrorHandler)
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. The option will be converted to a <code>boolean</code> type. Default: false Group: consumer- Parameters:
bridgeErrorHandler
- the value to set- Returns:
- the dsl builder
-
statuses
default JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder statuses(List<String> statuses)
The list of status to use when filtering tasks. The option is a: <code>java.util.List<java.lang.String></code> type. Group: filter- Parameters:
statuses
- the value to set- Returns:
- the dsl builder
-
statuses
default JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder statuses(String statuses)
The list of status to use when filtering tasks. The option will be converted to a <code>java.util.List<java.lang.String></code> type. Group: filter- Parameters:
statuses
- the value to set- Returns:
- the dsl builder
-
password
default JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder password(String password)
Password for authentication. The option is a: <code>java.lang.String</code> type. Group: security- Parameters:
password
- the value to set- Returns:
- the dsl builder
-
userName
default JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder userName(String userName)
Username for authentication. The option is a: <code>java.lang.String</code> type. Group: security- Parameters:
userName
- the value to set- Returns:
- the dsl builder
-
-