Class NontransactionalAgentInvocationContext

java.lang.Object

com.flowable.agent.engine.impl.runtime.invocation.BaseAgentInvocationContext

com.flowable.agent.engine.impl.runtime.invocation.NontransactionalAgentInvocationContext

All Implemented Interfaces:

AgentInvocationContext

public class NontransactionalAgentInvocationContext
extends BaseAgentInvocationContext

An implementation of the AgentInvocationContext interface that is used to invoke agent operations when there is no database transaction active (as to not block the database transaction). Instead of using runtime data, this one is based on a JSON document. When an agent operation for example needs to be executed outside a transaction, the operation call is 'prepared' up to the point that the invocation can happen, and then everything is stored in a JSON document. Later on, the JSON is then used to execute the call without blocking the database transaction.

Nested Class Summary

Nested classes/interfaces inherited from interface AgentInvocationContext

AgentInvocationContext.MediaItem

Field Summary

Fields

Modifier and Type	Field	Description
static final String	AGENT_DEFINITION_ID
static final String	AGENT_INSTANCE_ID
static final String	AGENT_OPERATION_KEY
static final String	AGENT_OPERATION_OUTPUT
static final String	AGENT_OUTPUT_SCHEMA
protected AgentDefinitionModel	agentDefinitionModel
protected AgentInstance	agentInstance
protected boolean	agentInstanceLoaded
static final String	CONTENT_ITEM_IDS
protected List<org.flowable.content.api.ContentItem>	contentItemList
static final String	CREATION_TIME
static final String	EVENT_CORRELATION_KEY
static final String	EVENT_DEFINITION_KEY
static final String	GUARDRAIL_VARIABLES
protected GuardrailResult	guardrailResult
protected Map<String,Object>	guardrailVariables
static final String	INVOCATION_ID
protected final tools.jackson.databind.node.ObjectNode	jsonNode
static final String	KNOWLEDGE_BASE_DEFINITION_IDS
protected List<KnowledgeBaseDefinition>	knowledgeBaseDefinitions
static final String	MEDIA
static final String	MEDIA_CONTENT_ITEM_ID
static final String	MEDIA_DATA
static final String	MEDIA_MIME_TYPE
static final String	MEDIA_NAME
protected List<AgentInvocationContext.MediaItem>	mediaItemList
static final String	PARENT_DEPLOYMENT_ID
static final String	SKIP_EVALUATORS
static final String	SYSTEM_MESSAGE
static final String	TENANT_ID
static final String	USER_GROUP_KEYS
static final String	USER_ID
static final String	USER_MESSAGE
protected Collection<String>	userGroupKeys

Fields inherited from class BaseAgentInvocationContext

agentEngineConfiguration

Constructor Summary

Constructors

Constructor	Description
NontransactionalAgentInvocationContext(AgentEngineConfiguration agentEngineConfiguration)
NontransactionalAgentInvocationContext(AgentEngineConfiguration agentEngineConfiguration, tools.jackson.databind.node.ObjectNode jsonNode)

Method Summary

Modifier and Type	Method	Description
AgentDefinitionModel	getAgentDefinitionModel()
AgentInstance	getAgentInstance()
String	getAgentInstanceId()
String	getAgentOperationKey()
List<org.flowable.content.api.ContentItem>	getContentItems()
Date	getCreationTime()
String	getEventCorrelationKey()
String	getEventDefinitionKey()
GuardrailResult	getGuardrailResult()
Map<String,Object>	getGuardrailVariables()	Returns variables that are exclusively passed to guardrail agents.
String	getInvocationId()
tools.jackson.databind.node.ObjectNode	getJsonNode()
List<KnowledgeBaseDefinition>	getKnowledgeBaseDefinitions()
List<AgentInvocationContext.MediaItem>	getMedia()
String	getOutputSchema()
String	getParentDeploymentId()
protected String	getProperty(String propertyName)
Map<String,Object>	getResolvedInputParameters()
String	getSystemMessage()
String	getTenantId()
Collection<String>	getUserGroupKeys()
String	getUserId()
String	getUserMessage()
boolean	isSkipEvaluators()	Whether the automatic (async) evaluator dispatch is suppressed for this invocation.
protected Object	nodeToValue(tools.jackson.databind.JsonNode node)
protected void	putVariableValue(tools.jackson.databind.node.ObjectNode node, String key, Object value)	Writes a variable value to a JSON object node, handling the supported agent parameter types.
void	setAgentDefinitionModel(AgentDefinitionModel agentDefinitionModel)
void	setAgentInstance(AgentInstance agentInstance)
void	setAgentOperationKey(String agentOperationKey)
void	setContentItems(List<org.flowable.content.api.ContentItem> contentItems)
protected void	setCreationTime(Date creationTime)
void	setEventCompletion(String eventDefinitionKey, String eventCorrelationKey)
void	setGuardrailResult(GuardrailResult guardrailResult)
void	setGuardrailVariables(Map<String,Object> guardrailVariables)
void	setInvocationId(String invocationId)
void	setKnowledgeBaseDefinition(KnowledgeBaseDefinition knowledgeBaseDefinition)
void	setKnowledgeBaseDefinitions(List<KnowledgeBaseDefinition> knowledgeBaseDefinitions)
void	setOutputSchema(String outputSchema)
void	setParentDeploymentId(String parentDeploymentId)
protected void	setProperty(String propertyName, String value)
void	setResolvedInputParameters(Map<String,Object> resolvedInputParameters)
void	setSkipEvaluators(boolean skipEvaluators)
void	setSystemMessage(String systemMessage)
void	setTenantId(String tenantId)
void	setUserGroupKeys(Collection<String> groupKeys)
void	setUserId(String userId)
void	setUserMessage(String userMessage)
static tools.jackson.databind.node.ObjectNode	transformToNonTransactionalJson(AgentInvocationContext invocationContext, AgentEngineConfiguration agentEngineConfiguration)

Methods inherited from class BaseAgentInvocationContext

invoke

Methods inherited from class Object

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

Field Details

jsonNode

protected final tools.jackson.databind.node.ObjectNode jsonNode

INVOCATION_ID

public static final String INVOCATION_ID

See Also:

• Constant Field Values

CREATION_TIME

public static final String CREATION_TIME

See Also:

• Constant Field Values

AGENT_INSTANCE_ID

public static final String AGENT_INSTANCE_ID

See Also:

• Constant Field Values

AGENT_DEFINITION_ID

public static final String AGENT_DEFINITION_ID

See Also:

• Constant Field Values

AGENT_OPERATION_KEY

public static final String AGENT_OPERATION_KEY

See Also:

• Constant Field Values

AGENT_OPERATION_OUTPUT

public static final String AGENT_OPERATION_OUTPUT

See Also:

• Constant Field Values

AGENT_OUTPUT_SCHEMA

public static final String AGENT_OUTPUT_SCHEMA

See Also:

• Constant Field Values

KNOWLEDGE_BASE_DEFINITION_IDS

public static final String KNOWLEDGE_BASE_DEFINITION_IDS

See Also:

• Constant Field Values

USER_MESSAGE

public static final String USER_MESSAGE

See Also:

• Constant Field Values

SYSTEM_MESSAGE

public static final String SYSTEM_MESSAGE

See Also:

• Constant Field Values

TENANT_ID

public static final String TENANT_ID

See Also:

• Constant Field Values

USER_ID

public static final String USER_ID

See Also:

• Constant Field Values

PARENT_DEPLOYMENT_ID

public static final String PARENT_DEPLOYMENT_ID

See Also:

• Constant Field Values

USER_GROUP_KEYS

public static final String USER_GROUP_KEYS

See Also:

• Constant Field Values

MEDIA

public static final String MEDIA

See Also:

• Constant Field Values

MEDIA_NAME

public static final String MEDIA_NAME

See Also:

• Constant Field Values

MEDIA_MIME_TYPE

public static final String MEDIA_MIME_TYPE

See Also:

• Constant Field Values

MEDIA_DATA

public static final String MEDIA_DATA

See Also:

• Constant Field Values

MEDIA_CONTENT_ITEM_ID

public static final String MEDIA_CONTENT_ITEM_ID

See Also:

• Constant Field Values

CONTENT_ITEM_IDS

public static final String CONTENT_ITEM_IDS

See Also:

• Constant Field Values

EVENT_DEFINITION_KEY

public static final String EVENT_DEFINITION_KEY

See Also:

• Constant Field Values

EVENT_CORRELATION_KEY

public static final String EVENT_CORRELATION_KEY

See Also:

• Constant Field Values

GUARDRAIL_VARIABLES

public static final String GUARDRAIL_VARIABLES

See Also:

• Constant Field Values

SKIP_EVALUATORS

public static final String SKIP_EVALUATORS

See Also:

• Constant Field Values

agentInstance

protected AgentInstance agentInstance

agentInstanceLoaded

protected boolean agentInstanceLoaded

agentDefinitionModel

protected AgentDefinitionModel agentDefinitionModel

knowledgeBaseDefinitions

protected List<KnowledgeBaseDefinition> knowledgeBaseDefinitions

userGroupKeys

protected Collection<String> userGroupKeys

mediaItemList

protected List<AgentInvocationContext.MediaItem> mediaItemList

contentItemList

protected List<org.flowable.content.api.ContentItem> contentItemList

guardrailVariables

protected Map<String,Object> guardrailVariables

guardrailResult

protected GuardrailResult guardrailResult

Constructor Details

NontransactionalAgentInvocationContext

public NontransactionalAgentInvocationContext(AgentEngineConfiguration agentEngineConfiguration)

NontransactionalAgentInvocationContext

public NontransactionalAgentInvocationContext(AgentEngineConfiguration agentEngineConfiguration,
 tools.jackson.databind.node.ObjectNode jsonNode)

Method Details

getInvocationId

public String getInvocationId()

setInvocationId

public void setInvocationId(String invocationId)

Specified by:

setInvocationId in class BaseAgentInvocationContext

getCreationTime

public Date getCreationTime()

setCreationTime

protected void setCreationTime(Date creationTime)

getAgentInstanceId

public String getAgentInstanceId()

getAgentInstance

public AgentInstance getAgentInstance()

setAgentInstance

public void setAgentInstance(AgentInstance agentInstance)

Specified by:

setAgentInstance in class BaseAgentInvocationContext

getAgentDefinitionModel

public AgentDefinitionModel getAgentDefinitionModel()

setAgentDefinitionModel

public void setAgentDefinitionModel(AgentDefinitionModel agentDefinitionModel)

Specified by:

setAgentDefinitionModel in class BaseAgentInvocationContext

getAgentOperationKey

public String getAgentOperationKey()

setAgentOperationKey

public void setAgentOperationKey(String agentOperationKey)

Specified by:

setAgentOperationKey in class BaseAgentInvocationContext

getOutputSchema

public String getOutputSchema()

setOutputSchema

public void setOutputSchema(String outputSchema)

Specified by:

setOutputSchema in class BaseAgentInvocationContext

getUserMessage

public String getUserMessage()

setUserMessage

public void setUserMessage(String userMessage)

Specified by:

setUserMessage in interface AgentInvocationContext

Specified by:

setUserMessage in class BaseAgentInvocationContext

getSystemMessage

public String getSystemMessage()

setSystemMessage

public void setSystemMessage(String systemMessage)

Specified by:

setSystemMessage in class BaseAgentInvocationContext

getKnowledgeBaseDefinitions

public List<KnowledgeBaseDefinition> getKnowledgeBaseDefinitions()

setKnowledgeBaseDefinition

public void setKnowledgeBaseDefinition(KnowledgeBaseDefinition knowledgeBaseDefinition)

Specified by:

setKnowledgeBaseDefinition in class BaseAgentInvocationContext

setKnowledgeBaseDefinitions

public void setKnowledgeBaseDefinitions(List<KnowledgeBaseDefinition> knowledgeBaseDefinitions)

getTenantId

public String getTenantId()

setTenantId

public void setTenantId(String tenantId)

Specified by:

setTenantId in class BaseAgentInvocationContext

getUserId

public String getUserId()

setUserId

public void setUserId(String userId)

Specified by:

setUserId in class BaseAgentInvocationContext

getParentDeploymentId

public String getParentDeploymentId()

setParentDeploymentId

public void setParentDeploymentId(String parentDeploymentId)

Specified by:

setParentDeploymentId in class BaseAgentInvocationContext

getMedia

public List<AgentInvocationContext.MediaItem> getMedia()

getUserGroupKeys

public Collection<String> getUserGroupKeys()

setUserGroupKeys

public void setUserGroupKeys(Collection<String> groupKeys)

Specified by:

setUserGroupKeys in class BaseAgentInvocationContext

getContentItems

public List<org.flowable.content.api.ContentItem> getContentItems()

setContentItems

public void setContentItems(List<org.flowable.content.api.ContentItem> contentItems)

Specified by:

setContentItems in class BaseAgentInvocationContext

getEventDefinitionKey

public String getEventDefinitionKey()

getEventCorrelationKey

public String getEventCorrelationKey()

setEventCompletion

public void setEventCompletion(String eventDefinitionKey,
 String eventCorrelationKey)

Specified by:

setEventCompletion in class BaseAgentInvocationContext

getResolvedInputParameters

public Map<String,Object> getResolvedInputParameters()

setResolvedInputParameters

public void setResolvedInputParameters(Map<String,Object> resolvedInputParameters)

Specified by:

setResolvedInputParameters in class BaseAgentInvocationContext

getGuardrailVariables

public Map<String,Object> getGuardrailVariables()

Description copied from interface: AgentInvocationContext

Returns variables that are exclusively passed to guardrail agents. These are kept separate from the regular input parameters so the parent agent cannot reference them in its system/user message templates.

setGuardrailVariables

public void setGuardrailVariables(Map<String,Object> guardrailVariables)

Specified by:

setGuardrailVariables in class BaseAgentInvocationContext

putVariableValue

protected void putVariableValue(tools.jackson.databind.node.ObjectNode node,
 String key,
 Object value)

Writes a variable value to a JSON object node, handling the supported agent parameter types. This is the inverse of nodeToValue(JsonNode).

getGuardrailResult

public GuardrailResult getGuardrailResult()

setGuardrailResult

public void setGuardrailResult(GuardrailResult guardrailResult)

isSkipEvaluators

public boolean isSkipEvaluators()

Description copied from interface: AgentInvocationContext

Whether the automatic (async) evaluator dispatch is suppressed for this invocation. Defaults to false (auto-dispatch on).

setSkipEvaluators

public void setSkipEvaluators(boolean skipEvaluators)

Specified by:

setSkipEvaluators in class BaseAgentInvocationContext

nodeToValue

protected Object nodeToValue(tools.jackson.databind.JsonNode node)

getProperty

protected String getProperty(String propertyName)

setProperty

protected void setProperty(String propertyName,
 String value)

getJsonNode

public tools.jackson.databind.node.ObjectNode getJsonNode()

transformToNonTransactionalJson

public static tools.jackson.databind.node.ObjectNode transformToNonTransactionalJson(AgentInvocationContext invocationContext,
 AgentEngineConfiguration agentEngineConfiguration)