Class AgentInstanceBuilderImpl

java.lang.Object

com.flowable.agent.engine.impl.runtime.AgentInstanceBuilderImpl

All Implemented Interfaces:

AgentInstanceBuilder

public class AgentInstanceBuilderImpl
extends Object
implements AgentInstanceBuilder

Field Summary

Fields

Modifier and Type	Field	Description
protected String	agentDefinitionId
protected String	agentDefinitionKey
protected String	agentDefinitionParentDeploymentId
protected String	callbackId
protected String	callbackScopeId
protected String	callbackType
protected final org.flowable.common.engine.impl.interceptor.CommandExecutor	commandExecutor
protected Map<String,Object>	guardrailVariables
protected String	name
protected String	operationKey
protected String	referenceId
protected String	referenceType
protected boolean	skipEvaluators
protected String	startUserId
protected String	tenantId
protected Set<String>	userGroupKeys
protected String	userId
protected Map<String,Object>	variables

Constructor Summary

Constructors

Constructor	Description
AgentInstanceBuilderImpl(org.flowable.common.engine.impl.interceptor.CommandExecutor commandExecutor)

Method Summary

Modifier and Type	Method	Description
AgentInstanceBuilder	agentDefinitionId(String agentDefinitionId)	Set the id of the agent definition
AgentInstanceBuilder	agentDefinitionKey(String agentDefinitionKey)	Set the key of the agent definition, latest version of the agent definition with the given key.
AgentInstanceBuilder	agentDefinitionParentDeploymentId(String parentDeploymentId)	When looking up for an agent definition by key it would first lookup for an agent definition within the given parent deployment.
AgentInstanceBuilder	callbackId(String callbackId)	Sets the callback id to the agent instance.
AgentInstanceBuilder	callbackScopeId(String callbackScopeId)	Sets the callback scope id to the agent instance.
AgentInstanceBuilder	callbackType(String callbackType)	Sets the callback type to the agent instance.
String	getAgentDefinitionId()
String	getAgentDefinitionKey()
String	getAgentDefinitionParentDeploymentId()
String	getCallbackId()
String	getCallbackScopeId()
String	getCallbackType()
Map<String,Object>	getGuardrailVariables()
String	getName()
String	getOperationKey()
String	getReferenceId()
String	getReferenceType()
String	getStartUserId()
String	getTenantId()
Set<String>	getUserGroupKeys()
String	getUserId()
Map<String,Object>	getVariables()
AgentInstanceBuilder	guardrailVariables(Map<String,Object> guardrailVariables)	Sets variables that are exclusively passed to guardrail agents during the invocation pipeline.
boolean	isSkipEvaluators()
AgentInstanceBuilder	name(String name)	Sets the name to the agent instance.
AgentInstanceBuilder	operationKey(String operationKey)	Set the operation key of the operation used to invoke the agent
AgentInstanceBuilder	referenceId(String referenceId)	Sets the reference id to the agent instance.
AgentInstanceBuilder	referenceType(String referenceType)	Sets the reference type to the agent instance.
AgentInstanceBuilder	skipEvaluators()	Suppresses the automatic (async) evaluator dispatch for this invocation.
AgentInstance	start()	Start the agent instance
AgentInstance	startAsync(boolean exclusive)	Start the agent instance asynchronously.
AgentInstanceBuilder	startUserId(String startUserId)	Set the start user id of agent instance
AgentInstanceBuilder	tenantId(String tenantId)	Set the tenant id of agent instance
AgentInstanceBuilder	variables(Map<String,Object> variables)	Sets variables passed to the agent instance.
AgentInstanceBuilder	withUserGroupKeys(Set<String> userGroupKeys)	Set the permission group keys of an agent instance
AgentInstanceBuilder	withUserId(String userId)	Set the permission user id of an agent instance

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

commandExecutor

protected final org.flowable.common.engine.impl.interceptor.CommandExecutor commandExecutor

agentDefinitionId

protected String agentDefinitionId

agentDefinitionKey

protected String agentDefinitionKey

agentDefinitionParentDeploymentId

protected String agentDefinitionParentDeploymentId

operationKey

protected String operationKey

startUserId

protected String startUserId

userId

protected String userId

userGroupKeys

protected Set<String> userGroupKeys

tenantId

protected String tenantId

name

protected String name

callbackScopeId

protected String callbackScopeId

callbackId

protected String callbackId

callbackType

protected String callbackType

referenceId

protected String referenceId

referenceType

protected String referenceType

variables

protected Map<String,Object> variables

guardrailVariables

protected Map<String,Object> guardrailVariables

skipEvaluators

protected boolean skipEvaluators

Constructor Details

AgentInstanceBuilderImpl

public AgentInstanceBuilderImpl(org.flowable.common.engine.impl.interceptor.CommandExecutor commandExecutor)

Method Details

agentDefinitionId

public AgentInstanceBuilder agentDefinitionId(String agentDefinitionId)

Description copied from interface: AgentInstanceBuilder

Set the id of the agent definition

Specified by:

agentDefinitionId in interface AgentInstanceBuilder

agentDefinitionKey

public AgentInstanceBuilder agentDefinitionKey(String agentDefinitionKey)

Description copied from interface: AgentInstanceBuilder

Set the key of the agent definition, latest version of the agent definition with the given key. If agentDefinitionId was set this will be ignored

Specified by:

agentDefinitionKey in interface AgentInstanceBuilder

agentDefinitionParentDeploymentId

public AgentInstanceBuilder agentDefinitionParentDeploymentId(String parentDeploymentId)

Description copied from interface: AgentInstanceBuilder

When looking up for an agent definition by key it would first lookup for an agent definition within the given parent deployment. Then it will fallback to the latest agent definition with the given key.

Specified by:

agentDefinitionParentDeploymentId in interface AgentInstanceBuilder

operationKey

public AgentInstanceBuilder operationKey(String operationKey)

Description copied from interface: AgentInstanceBuilder

Set the operation key of the operation used to invoke the agent

Specified by:

operationKey in interface AgentInstanceBuilder

startUserId

public AgentInstanceBuilder startUserId(String startUserId)

Description copied from interface: AgentInstanceBuilder

Set the start user id of agent instance

Specified by:

startUserId in interface AgentInstanceBuilder

withUserId

public AgentInstanceBuilder withUserId(String userId)

Description copied from interface: AgentInstanceBuilder

Set the permission user id of an agent instance

Specified by:

withUserId in interface AgentInstanceBuilder

withUserGroupKeys

public AgentInstanceBuilder withUserGroupKeys(Set<String> userGroupKeys)

Description copied from interface: AgentInstanceBuilder

Set the permission group keys of an agent instance

Specified by:

withUserGroupKeys in interface AgentInstanceBuilder

tenantId

public AgentInstanceBuilder tenantId(String tenantId)

Description copied from interface: AgentInstanceBuilder

Set the tenant id of agent instance

Specified by:

tenantId in interface AgentInstanceBuilder

variables

public AgentInstanceBuilder variables(Map<String,Object> variables)

Description copied from interface: AgentInstanceBuilder

Sets variables passed to the agent instance.

Specified by:

variables in interface AgentInstanceBuilder

guardrailVariables

public AgentInstanceBuilder guardrailVariables(Map<String,Object> guardrailVariables)

Description copied from interface: AgentInstanceBuilder

Sets variables that are exclusively passed to guardrail agents during the invocation pipeline. These variables are kept separate from the regular input parameters and are not available to the parent agent's system/user message templates.

Specified by:

guardrailVariables in interface AgentInstanceBuilder

name

public AgentInstanceBuilder name(String name)

Description copied from interface: AgentInstanceBuilder

Sets the name to the agent instance.

Specified by:

name in interface AgentInstanceBuilder

callbackScopeId

public AgentInstanceBuilder callbackScopeId(String callbackScopeId)

Description copied from interface: AgentInstanceBuilder

Sets the callback scope id to the agent instance.

Specified by:

callbackScopeId in interface AgentInstanceBuilder

callbackId

public AgentInstanceBuilder callbackId(String callbackId)

Description copied from interface: AgentInstanceBuilder

Sets the callback id to the agent instance.

Specified by:

callbackId in interface AgentInstanceBuilder

callbackType

public AgentInstanceBuilder callbackType(String callbackType)

Description copied from interface: AgentInstanceBuilder

Sets the callback type to the agent instance.

Specified by:

callbackType in interface AgentInstanceBuilder

referenceId

public AgentInstanceBuilder referenceId(String referenceId)

Description copied from interface: AgentInstanceBuilder

Sets the reference id to the agent instance.

Specified by:

referenceId in interface AgentInstanceBuilder

referenceType

public AgentInstanceBuilder referenceType(String referenceType)

Description copied from interface: AgentInstanceBuilder

Sets the reference type to the agent instance.

Specified by:

referenceType in interface AgentInstanceBuilder

skipEvaluators

public AgentInstanceBuilder skipEvaluators()

Description copied from interface: AgentInstanceBuilder

Suppresses the automatic (async) evaluator dispatch for this invocation.

Specified by:

skipEvaluators in interface AgentInstanceBuilder

start

public AgentInstance start()

Description copied from interface: AgentInstanceBuilder

Start the agent instance

Specified by:

start in interface AgentInstanceBuilder

startAsync

public AgentInstance startAsync(boolean exclusive)

Description copied from interface: AgentInstanceBuilder

Start the agent instance asynchronously. This means that the invocation of the agent will be done asynchronously. The preparation would be done synchronously.

Specified by:

startAsync in interface AgentInstanceBuilder

Parameters:

exclusive - whether the async job should be exclusive (only applicable if the callback has been configured)

getAgentDefinitionId

public String getAgentDefinitionId()

getAgentDefinitionKey

public String getAgentDefinitionKey()

getAgentDefinitionParentDeploymentId

public String getAgentDefinitionParentDeploymentId()

getOperationKey

public String getOperationKey()

getStartUserId

public String getStartUserId()

getUserId

public String getUserId()

getUserGroupKeys

public Set<String> getUserGroupKeys()

getTenantId

public String getTenantId()

getName

public String getName()

getCallbackScopeId

public String getCallbackScopeId()

getCallbackId

public String getCallbackId()

getCallbackType

public String getCallbackType()

getReferenceId

public String getReferenceId()

getReferenceType

public String getReferenceType()

getVariables

public Map<String,Object> getVariables()

getGuardrailVariables

public Map<String,Object> getGuardrailVariables()

isSkipEvaluators

public boolean isSkipEvaluators()