Package org.apache.camel.builder.endpoint.dsl

Interface JBPMEndpointBuilderFactory.JBPMEndpointBuilder

All Superinterfaces:

org.apache.camel.builder.EndpointConsumerBuilder, org.apache.camel.EndpointConsumerResolver, org.apache.camel.builder.EndpointProducerBuilder, org.apache.camel.EndpointProducerResolver, JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder, JBPMEndpointBuilderFactory.JBPMEndpointProducerBuilder

Enclosing interface:

JBPMEndpointBuilderFactory

public static interface JBPMEndpointBuilderFactory.JBPMEndpointBuilder
extends JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder, JBPMEndpointBuilderFactory.JBPMEndpointProducerBuilder

Builder for endpoint for the JBPM component.

Method Summary

Modifier and Type	Method	Description
default JBPMEndpointBuilderFactory.AdvancedJBPMEndpointBuilder	advanced()
default JBPMEndpointBuilderFactory.JBPMEndpointBuilder	attachmentId(Long attachmentId)	attachId to use when retrieving attachments.
default JBPMEndpointBuilderFactory.JBPMEndpointBuilder	attachmentId(String attachmentId)	attachId to use when retrieving attachments.
default JBPMEndpointBuilderFactory.JBPMEndpointBuilder	contentId(Long contentId)	contentId to use when retrieving attachments.
default JBPMEndpointBuilderFactory.JBPMEndpointBuilder	contentId(String contentId)	contentId to use when retrieving attachments.
default JBPMEndpointBuilderFactory.JBPMEndpointBuilder	deploymentId(String deploymentId)	The id of the deployment.
default JBPMEndpointBuilderFactory.JBPMEndpointBuilder	emitterSendItems(Boolean emitterSendItems)	Sets if event produced by emitter should be sent as single items or complete collection.
default JBPMEndpointBuilderFactory.JBPMEndpointBuilder	emitterSendItems(String emitterSendItems)	Sets if event produced by emitter should be sent as single items or complete collection.
default JBPMEndpointBuilderFactory.JBPMEndpointBuilder	event(Object event)	the data associated with this event when signalEvent operation is performed.
default JBPMEndpointBuilderFactory.JBPMEndpointBuilder	event(String event)	the data associated with this event when signalEvent operation is performed.
default JBPMEndpointBuilderFactory.JBPMEndpointBuilder	eventType(String eventType)	the type of event to use when signalEvent operation is performed.
default JBPMEndpointBuilderFactory.JBPMEndpointBuilder	identifier(String identifier)	identifier the global identifier.
default JBPMEndpointBuilderFactory.JBPMEndpointBuilder	maxNumber(Integer maxNumber)	the maximum number of rules that should be fired.
default JBPMEndpointBuilderFactory.JBPMEndpointBuilder	maxNumber(String maxNumber)	the maximum number of rules that should be fired.
default JBPMEndpointBuilderFactory.JBPMEndpointBuilder	page(Integer page)	The page to use when retrieving user tasks.
default JBPMEndpointBuilderFactory.JBPMEndpointBuilder	page(String page)	The page to use when retrieving user tasks.
default JBPMEndpointBuilderFactory.JBPMEndpointBuilder	pageSize(Integer pageSize)	The page size to use when retrieving user tasks.
default JBPMEndpointBuilderFactory.JBPMEndpointBuilder	pageSize(String pageSize)	The page size to use when retrieving user tasks.
default JBPMEndpointBuilderFactory.JBPMEndpointBuilder	password(String password)	Password for authentication.
default JBPMEndpointBuilderFactory.JBPMEndpointBuilder	processId(String processId)	the id of the process that should be acted upon.
default JBPMEndpointBuilderFactory.JBPMEndpointBuilder	processInstanceId(Long processInstanceId)	the id of the process instance.
default JBPMEndpointBuilderFactory.JBPMEndpointBuilder	processInstanceId(String processInstanceId)	the id of the process instance.
default JBPMEndpointBuilderFactory.JBPMEndpointBuilder	statuses(String statuses)	The list of status to use when filtering tasks.
default JBPMEndpointBuilderFactory.JBPMEndpointBuilder	statuses(List<String> statuses)	The list of status to use when filtering tasks.
default JBPMEndpointBuilderFactory.JBPMEndpointBuilder	targetUserId(String targetUserId)	The targetUserId used when delegating a task.
default JBPMEndpointBuilderFactory.JBPMEndpointBuilder	task(String task)	The task instance to use with task operations.
default JBPMEndpointBuilderFactory.JBPMEndpointBuilder	task(org.kie.api.task.model.Task task)	The task instance to use with task operations.
default JBPMEndpointBuilderFactory.JBPMEndpointBuilder	taskId(Long taskId)	the id of the task.
default JBPMEndpointBuilderFactory.JBPMEndpointBuilder	taskId(String taskId)	the id of the task.
default JBPMEndpointBuilderFactory.JBPMEndpointBuilder	timeout(Integer timeout)	A timeout value.
default JBPMEndpointBuilderFactory.JBPMEndpointBuilder	timeout(String timeout)	A timeout value.
default JBPMEndpointBuilderFactory.JBPMEndpointBuilder	userId(String userId)	userId to use with task operations.
default JBPMEndpointBuilderFactory.JBPMEndpointBuilder	userName(String userName)	Username for authentication.
default JBPMEndpointBuilderFactory.JBPMEndpointBuilder	value(Object value)	the value to assign to the global identifier.
default JBPMEndpointBuilderFactory.JBPMEndpointBuilder	value(String value)	the value to assign to the global identifier.
default JBPMEndpointBuilderFactory.JBPMEndpointBuilder	workItemId(Long workItemId)	the id of the work item.
default JBPMEndpointBuilderFactory.JBPMEndpointBuilder	workItemId(String workItemId)	the id of the work item.

Methods inherited from interface org.apache.camel.builder.EndpointConsumerBuilder

doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, expr, getUri

Methods inherited from interface org.apache.camel.EndpointConsumerResolver

resolve, resolve

Methods inherited from interface org.apache.camel.builder.EndpointProducerBuilder

doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, expr, getUri

Methods inherited from interface org.apache.camel.EndpointProducerResolver

resolve, resolve

Methods inherited from interface org.apache.camel.builder.endpoint.dsl.JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder

bridgeErrorHandler, bridgeErrorHandler

Methods inherited from interface org.apache.camel.builder.endpoint.dsl.JBPMEndpointBuilderFactory.JBPMEndpointProducerBuilder

lazyStartProducer, lazyStartProducer, operation

Method Detail

advanced

default JBPMEndpointBuilderFactory.AdvancedJBPMEndpointBuilder advanced()

Specified by:

advanced in interface JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder

Specified by:

advanced in interface JBPMEndpointBuilderFactory.JBPMEndpointProducerBuilder

attachmentId

default JBPMEndpointBuilderFactory.JBPMEndpointBuilder attachmentId(Long attachmentId)

attachId to use when retrieving attachments. The option is a: <code>java.lang.Long</code> type. Group: common

Specified by:

attachmentId in interface JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder

Specified by:

attachmentId in interface JBPMEndpointBuilderFactory.JBPMEndpointProducerBuilder

Parameters:

attachmentId - the value to set

Returns:

the dsl builder

attachmentId

default JBPMEndpointBuilderFactory.JBPMEndpointBuilder attachmentId(String attachmentId)

attachId to use when retrieving attachments. The option will be converted to a <code>java.lang.Long</code> type. Group: common

Specified by:

attachmentId in interface JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder

Specified by:

attachmentId in interface JBPMEndpointBuilderFactory.JBPMEndpointProducerBuilder

Parameters:

attachmentId - the value to set

Returns:

the dsl builder

contentId

default JBPMEndpointBuilderFactory.JBPMEndpointBuilder contentId(Long contentId)

contentId to use when retrieving attachments. The option is a: <code>java.lang.Long</code> type. Group: common

Specified by:

contentId in interface JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder

Specified by:

contentId in interface JBPMEndpointBuilderFactory.JBPMEndpointProducerBuilder

Parameters:

contentId - the value to set

Returns:

the dsl builder

contentId

default JBPMEndpointBuilderFactory.JBPMEndpointBuilder contentId(String contentId)

contentId to use when retrieving attachments. The option will be converted to a <code>java.lang.Long</code> type. Group: common

Specified by:

contentId in interface JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder

Specified by:

contentId in interface JBPMEndpointBuilderFactory.JBPMEndpointProducerBuilder

Parameters:

contentId - the value to set

Returns:

the dsl builder

deploymentId

default JBPMEndpointBuilderFactory.JBPMEndpointBuilder deploymentId(String deploymentId)

The id of the deployment. The option is a: <code>java.lang.String</code> type. Required: true Group: common

Specified by:

deploymentId in interface JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder

Specified by:

deploymentId in interface JBPMEndpointBuilderFactory.JBPMEndpointProducerBuilder

Parameters:

deploymentId - the value to set

Returns:

the dsl builder

emitterSendItems

default JBPMEndpointBuilderFactory.JBPMEndpointBuilder 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

Specified by:

emitterSendItems in interface JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder

Specified by:

emitterSendItems in interface JBPMEndpointBuilderFactory.JBPMEndpointProducerBuilder

Parameters:

emitterSendItems - the value to set

Returns:

the dsl builder

emitterSendItems

default JBPMEndpointBuilderFactory.JBPMEndpointBuilder 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

Specified by:

emitterSendItems in interface JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder

Specified by:

emitterSendItems in interface JBPMEndpointBuilderFactory.JBPMEndpointProducerBuilder

Parameters:

emitterSendItems - the value to set

Returns:

the dsl builder

event

default JBPMEndpointBuilderFactory.JBPMEndpointBuilder 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

Specified by:

event in interface JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder

Specified by:

event in interface JBPMEndpointBuilderFactory.JBPMEndpointProducerBuilder

Parameters:

event - the value to set

Returns:

the dsl builder

event

default JBPMEndpointBuilderFactory.JBPMEndpointBuilder 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

Specified by:

event in interface JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder

Specified by:

event in interface JBPMEndpointBuilderFactory.JBPMEndpointProducerBuilder

Parameters:

event - the value to set

Returns:

the dsl builder

eventType

default JBPMEndpointBuilderFactory.JBPMEndpointBuilder 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

Specified by:

eventType in interface JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder

Specified by:

eventType in interface JBPMEndpointBuilderFactory.JBPMEndpointProducerBuilder

Parameters:

eventType - the value to set

Returns:

the dsl builder

identifier

default JBPMEndpointBuilderFactory.JBPMEndpointBuilder identifier(String identifier)

identifier the global identifier. The option is a: <code>java.lang.String</code> type. Group: common

Specified by:

identifier in interface JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder

Specified by:

identifier in interface JBPMEndpointBuilderFactory.JBPMEndpointProducerBuilder

Parameters:

identifier - the value to set

Returns:

the dsl builder

maxNumber

default JBPMEndpointBuilderFactory.JBPMEndpointBuilder maxNumber(Integer maxNumber)

the maximum number of rules that should be fired. The option is a: <code>java.lang.Integer</code> type. Group: common

Specified by:

maxNumber in interface JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder

Specified by:

maxNumber in interface JBPMEndpointBuilderFactory.JBPMEndpointProducerBuilder

Parameters:

maxNumber - the value to set

Returns:

the dsl builder

maxNumber

default JBPMEndpointBuilderFactory.JBPMEndpointBuilder 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

Specified by:

maxNumber in interface JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder

Specified by:

maxNumber in interface JBPMEndpointBuilderFactory.JBPMEndpointProducerBuilder

Parameters:

maxNumber - the value to set

Returns:

the dsl builder

page

default JBPMEndpointBuilderFactory.JBPMEndpointBuilder page(Integer page)

The page to use when retrieving user tasks. The option is a: <code>java.lang.Integer</code> type. Group: common

Specified by:

page in interface JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder

Specified by:

page in interface JBPMEndpointBuilderFactory.JBPMEndpointProducerBuilder

Parameters:

page - the value to set

Returns:

the dsl builder

page

default JBPMEndpointBuilderFactory.JBPMEndpointBuilder 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

Specified by:

page in interface JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder

Specified by:

page in interface JBPMEndpointBuilderFactory.JBPMEndpointProducerBuilder

Parameters:

page - the value to set

Returns:

the dsl builder

pageSize

default JBPMEndpointBuilderFactory.JBPMEndpointBuilder pageSize(Integer pageSize)

The page size to use when retrieving user tasks. The option is a: <code>java.lang.Integer</code> type. Group: common

Specified by:

pageSize in interface JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder

Specified by:

pageSize in interface JBPMEndpointBuilderFactory.JBPMEndpointProducerBuilder

Parameters:

pageSize - the value to set

Returns:

the dsl builder

pageSize

default JBPMEndpointBuilderFactory.JBPMEndpointBuilder 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

Specified by:

pageSize in interface JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder

Specified by:

pageSize in interface JBPMEndpointBuilderFactory.JBPMEndpointProducerBuilder

Parameters:

pageSize - the value to set

Returns:

the dsl builder

processId

default JBPMEndpointBuilderFactory.JBPMEndpointBuilder 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

Specified by:

processId in interface JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder

Specified by:

processId in interface JBPMEndpointBuilderFactory.JBPMEndpointProducerBuilder

Parameters:

processId - the value to set

Returns:

the dsl builder

processInstanceId

default JBPMEndpointBuilderFactory.JBPMEndpointBuilder processInstanceId(Long processInstanceId)

the id of the process instance. The option is a: <code>java.lang.Long</code> type. Group: common

Specified by:

processInstanceId in interface JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder

Specified by:

processInstanceId in interface JBPMEndpointBuilderFactory.JBPMEndpointProducerBuilder

Parameters:

processInstanceId - the value to set

Returns:

the dsl builder

processInstanceId

default JBPMEndpointBuilderFactory.JBPMEndpointBuilder processInstanceId(String processInstanceId)

the id of the process instance. The option will be converted to a <code>java.lang.Long</code> type. Group: common

Specified by:

processInstanceId in interface JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder

Specified by:

processInstanceId in interface JBPMEndpointBuilderFactory.JBPMEndpointProducerBuilder

Parameters:

processInstanceId - the value to set

Returns:

the dsl builder

targetUserId

default JBPMEndpointBuilderFactory.JBPMEndpointBuilder targetUserId(String targetUserId)

The targetUserId used when delegating a task. The option is a: <code>java.lang.String</code> type. Group: common

Specified by:

targetUserId in interface JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder

Specified by:

targetUserId in interface JBPMEndpointBuilderFactory.JBPMEndpointProducerBuilder

Parameters:

targetUserId - the value to set

Returns:

the dsl builder

task

default JBPMEndpointBuilderFactory.JBPMEndpointBuilder task(org.kie.api.task.model.Task task)

The task instance to use with task operations. The option is a: <code>org.kie.api.task.model.Task</code> type. Group: common

Specified by:

task in interface JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder

Specified by:

task in interface JBPMEndpointBuilderFactory.JBPMEndpointProducerBuilder

Parameters:

task - the value to set

Returns:

the dsl builder

task

default JBPMEndpointBuilderFactory.JBPMEndpointBuilder 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

Specified by:

task in interface JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder

Specified by:

task in interface JBPMEndpointBuilderFactory.JBPMEndpointProducerBuilder

Parameters:

task - the value to set

Returns:

the dsl builder

taskId

default JBPMEndpointBuilderFactory.JBPMEndpointBuilder taskId(Long taskId)

the id of the task. The option is a: <code>java.lang.Long</code> type. Group: common

Specified by:

taskId in interface JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder

Specified by:

taskId in interface JBPMEndpointBuilderFactory.JBPMEndpointProducerBuilder

Parameters:

taskId - the value to set

Returns:

the dsl builder

taskId

default JBPMEndpointBuilderFactory.JBPMEndpointBuilder taskId(String taskId)

the id of the task. The option will be converted to a <code>java.lang.Long</code> type. Group: common

Specified by:

taskId in interface JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder

Specified by:

taskId in interface JBPMEndpointBuilderFactory.JBPMEndpointProducerBuilder

Parameters:

taskId - the value to set

Returns:

the dsl builder

timeout

default JBPMEndpointBuilderFactory.JBPMEndpointBuilder timeout(Integer timeout)

A timeout value. The option is a: <code>java.lang.Integer</code> type. Group: common

Specified by:

timeout in interface JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder

Specified by:

timeout in interface JBPMEndpointBuilderFactory.JBPMEndpointProducerBuilder

Parameters:

timeout - the value to set

Returns:

the dsl builder

timeout

default JBPMEndpointBuilderFactory.JBPMEndpointBuilder timeout(String timeout)

A timeout value. The option will be converted to a <code>java.lang.Integer</code> type. Group: common

Specified by:

timeout in interface JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder

Specified by:

timeout in interface JBPMEndpointBuilderFactory.JBPMEndpointProducerBuilder

Parameters:

timeout - the value to set

Returns:

the dsl builder

userId

default JBPMEndpointBuilderFactory.JBPMEndpointBuilder userId(String userId)

userId to use with task operations. The option is a: <code>java.lang.String</code> type. Group: common

Specified by:

userId in interface JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder

Specified by:

userId in interface JBPMEndpointBuilderFactory.JBPMEndpointProducerBuilder

Parameters:

userId - the value to set

Returns:

the dsl builder

value

default JBPMEndpointBuilderFactory.JBPMEndpointBuilder value(Object value)

the value to assign to the global identifier. The option is a: <code>java.lang.Object</code> type. Group: common

Specified by:

value in interface JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder

Specified by:

value in interface JBPMEndpointBuilderFactory.JBPMEndpointProducerBuilder

Parameters:

value - the value to set

Returns:

the dsl builder

value

default JBPMEndpointBuilderFactory.JBPMEndpointBuilder 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

Specified by:

value in interface JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder

Specified by:

value in interface JBPMEndpointBuilderFactory.JBPMEndpointProducerBuilder

Parameters:

value - the value to set

Returns:

the dsl builder

workItemId

default JBPMEndpointBuilderFactory.JBPMEndpointBuilder workItemId(Long workItemId)

the id of the work item. The option is a: <code>java.lang.Long</code> type. Group: common

Specified by:

workItemId in interface JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder

Specified by:

workItemId in interface JBPMEndpointBuilderFactory.JBPMEndpointProducerBuilder

Parameters:

workItemId - the value to set

Returns:

the dsl builder

workItemId

default JBPMEndpointBuilderFactory.JBPMEndpointBuilder workItemId(String workItemId)

the id of the work item. The option will be converted to a <code>java.lang.Long</code> type. Group: common

Specified by:

workItemId in interface JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder

Specified by:

workItemId in interface JBPMEndpointBuilderFactory.JBPMEndpointProducerBuilder

Parameters:

workItemId - the value to set

Returns:

the dsl builder

statuses

default JBPMEndpointBuilderFactory.JBPMEndpointBuilder statuses(List<String> statuses)

The list of status to use when filtering tasks. The option is a: <code>java.util.List&lt;java.lang.String&gt;</code> type. Group: filter

Specified by:

statuses in interface JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder

Specified by:

statuses in interface JBPMEndpointBuilderFactory.JBPMEndpointProducerBuilder

Parameters:

statuses - the value to set

Returns:

the dsl builder

statuses

default JBPMEndpointBuilderFactory.JBPMEndpointBuilder statuses(String statuses)

The list of status to use when filtering tasks. The option will be converted to a <code>java.util.List&lt;java.lang.String&gt;</code> type. Group: filter

Specified by:

statuses in interface JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder

Specified by:

statuses in interface JBPMEndpointBuilderFactory.JBPMEndpointProducerBuilder

Parameters:

statuses - the value to set

Returns:

the dsl builder

password

default JBPMEndpointBuilderFactory.JBPMEndpointBuilder password(String password)

Password for authentication. The option is a: <code>java.lang.String</code> type. Group: security

Specified by:

password in interface JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder

Specified by:

password in interface JBPMEndpointBuilderFactory.JBPMEndpointProducerBuilder

Parameters:

password - the value to set

Returns:

the dsl builder

userName

default JBPMEndpointBuilderFactory.JBPMEndpointBuilder userName(String userName)

Username for authentication. The option is a: <code>java.lang.String</code> type. Group: security

Specified by:

userName in interface JBPMEndpointBuilderFactory.JBPMEndpointConsumerBuilder

Specified by:

userName in interface JBPMEndpointBuilderFactory.JBPMEndpointProducerBuilder

Parameters:

userName - the value to set

Returns:

the dsl builder