Class AgentInvocationContextImpl

java.lang.Object

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

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

All Implemented Interfaces:

AgentInvocationContext

public class AgentInvocationContextImpl
extends BaseAgentInvocationContext

Nested Class Summary

Nested classes/interfaces inherited from interface AgentInvocationContext

AgentInvocationContext.MediaItem

Field Summary

Fields

Modifier and Type	Field	Description
protected AgentDefinitionModel	agentDefinitionModel
protected AgentInstance	agentInstance
protected String	agentOperationKey
protected List<org.flowable.content.api.ContentItem>	contentItems
protected final Date	creationTime
protected String	eventCorrelationKey
protected String	eventDefinitionKey
protected GuardrailResult	guardrailResult
protected Map<String,Object>	guardrailVariables
protected String	invocationId
protected List<KnowledgeBaseDefinition>	knowledgeBaseDefinitions
protected List<AgentInvocationContext.MediaItem>	media
protected String	outputSchema
protected String	parentDeploymentId
protected Map<String,Object>	resolvedInputParameters
protected boolean	skipEvaluators
protected String	systemMessage
protected String	tenantId
protected Collection<String>	userGroupKeys
protected String	userId
protected String	userMessage

Fields inherited from class BaseAgentInvocationContext

agentEngineConfiguration

Constructor Summary

Constructors

Constructor	Description
AgentInvocationContextImpl(AgentEngineConfiguration agentEngineConfiguration)

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()
List<KnowledgeBaseDefinition>	getKnowledgeBaseDefinitions()
List<AgentInvocationContext.MediaItem>	getMedia()
String	getOutputSchema()
String	getParentDeploymentId()
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.
void	setAgentDefinitionModel(AgentDefinitionModel agentDefinitionModel)
void	setAgentInstance(AgentInstance agentInstance)
void	setAgentOperationKey(String agentOperationKey)
void	setContentItems(List<org.flowable.content.api.ContentItem> contentItems)
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	setOutputSchema(String outputSchema)
void	setParentDeploymentId(String parentDeploymentId)
void	setResolvedInputParameters(Map<String,Object> resolvedInputParameters)
void	setSkipEvaluators(boolean skipEvaluators)
void	setSystemMessage(String systemMessage)
void	setTenantId(String tenantId)
void	setUserGroupKeys(Collection<String> userGroupKeys)
void	setUserId(String userId)
void	setUserMessage(String userMessage)

Methods inherited from class BaseAgentInvocationContext

invoke

Methods inherited from class Object

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

Field Details

creationTime

protected final Date creationTime

agentInstance

protected AgentInstance agentInstance

invocationId

protected String invocationId

userId

protected String userId

parentDeploymentId

protected String parentDeploymentId

agentDefinitionModel

protected AgentDefinitionModel agentDefinitionModel

agentOperationKey

protected String agentOperationKey

outputSchema

protected String outputSchema

userMessage

protected String userMessage

systemMessage

protected String systemMessage

knowledgeBaseDefinitions

protected List<KnowledgeBaseDefinition> knowledgeBaseDefinitions

tenantId

protected String tenantId

userGroupKeys

protected Collection<String> userGroupKeys

media

protected List<AgentInvocationContext.MediaItem> media

contentItems

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

eventDefinitionKey

protected String eventDefinitionKey

eventCorrelationKey

protected String eventCorrelationKey

resolvedInputParameters

protected Map<String,Object> resolvedInputParameters

guardrailVariables

protected Map<String,Object> guardrailVariables

guardrailResult

protected GuardrailResult guardrailResult

skipEvaluators

protected boolean skipEvaluators

Constructor Details

AgentInvocationContextImpl

public AgentInvocationContextImpl(AgentEngineConfiguration agentEngineConfiguration)

Method Details

getInvocationId

public String getInvocationId()

setInvocationId

public void setInvocationId(String invocationId)

Specified by:

setInvocationId in class BaseAgentInvocationContext

getCreationTime

public Date getCreationTime()

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

getKnowledgeBaseDefinitions

public List<KnowledgeBaseDefinition> getKnowledgeBaseDefinitions()

setKnowledgeBaseDefinition

public void setKnowledgeBaseDefinition(KnowledgeBaseDefinition knowledgeBaseDefinition)

Specified by:

setKnowledgeBaseDefinition in class BaseAgentInvocationContext

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

getUserGroupKeys

public Collection<String> getUserGroupKeys()

setUserGroupKeys

public void setUserGroupKeys(Collection<String> userGroupKeys)

Specified by:

setUserGroupKeys 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

getMedia

public List<AgentInvocationContext.MediaItem> getMedia()

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

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