Package com.flowable.platform.service.agent

Class PlatformAgentService

java.lang.Object

com.flowable.platform.security.service.AbstractPlatformSecurityService

com.flowable.platform.service.agent.PlatformAgentService

All Implemented Interfaces:

PermissionServiceRegistryAware, Aware

@Transactional
public class PlatformAgentService
extends AbstractPlatformSecurityService

Field Summary

Fields

Modifier and Type	Field	Description
protected final ActionRuntimeService	actionRuntimeService
protected final AgentHistoryService	agentHistoryService
protected final AgentRepositoryService	agentRepositoryService
protected final AgentRuntimeService	agentRuntimeService
protected static final Map<String,org.flowable.common.engine.api.query.QueryProperty>	ALLOWED_SORT_PROPERTIES_EXCHANGE
protected final Supplier<org.flowable.common.engine.impl.interceptor.CommandExecutor>	commandExecutorSupplier
protected Integer	defaultListResponseSize
protected final tools.jackson.databind.ObjectMapper	objectMapper

Fields inherited from class com.flowable.platform.security.service.AbstractPlatformSecurityService

additionalAdminUsers, CASE_PREFIX, cmmnRepositoryService, cmmnRuntimeService, cmmnTaskService, defaultSecurityPolicyKey, defaultSecurityPolicyModel, EXTERNAL_WORKER_PREFIX, inspectEnabled, permissionServiceRegistry, platformSecurityInterceptor, policyRepositoryService, PROCESS_PREFIX, repositoryService, runtimeService, SECURITY_POLICY_MODEL, TASK_PREFIX, taskService

Constructor Summary

Constructors

Constructor	Description
PlatformAgentService(AgentRuntimeService agentRuntimeService, AgentHistoryService agentHistoryService, AgentRepositoryService agentRepositoryService, tools.jackson.databind.ObjectMapper objectMapper, ActionRuntimeService actionRuntimeService, Supplier<org.flowable.common.engine.impl.interceptor.CommandExecutor> commandExecutorSupplier)

Method Summary

Modifier and Type	Method	Description
protected AgentChatMessageResponse	convert(AgentInvocationExchangeChat exchange, AgentInvocationExchangePartChat part)
protected Stream<AgentChatMessageResponse>	convert(AgentInvocationExchangeChat exchange, Map<String,tools.jackson.databind.JsonNode> preParsedTechnicalContent, Map<String,ActionInstance> prefetchedActionInstances)
protected List<AgentChatMessageResponse>	convert(List<AgentInvocationExchangeChat> exchanges)
protected List<AgentChatMessageResponse>	convert(List<AgentInvocationExchangeChat> exchanges, Function<AgentChatMessageResponse,AgentChatMessageResponse> converter)
protected List<AgentChatMessageResponse>	findSuggestions(AgentInstance agentInstance, SecurityScope securityScope)
AgentChatInstanceResponse	getAgentChatInstanceResponse(String scopeId, String scopeType)
org.flowable.common.rest.api.DataResponse<AgentChatMessageResponse>	getAgentChatMessages(String scopeId, String scopeType, org.flowable.common.rest.api.PaginateRequest request)
protected AgentInstance	getAgentInstance(String scopeId, String scopeType)
AgentInstanceTimelineResponse	getAgentInstanceTimeline(String agentInstanceId)	Returns the timeline of a single agent instance (with its invocations, exchanges and parts), or null when the instance has no timeline.
List<AgentInstanceTimelineResponse>	getAgentTimeline(String scopeId, String scopeType)
protected void	processInsertedEntities(tools.jackson.databind.JsonNode technicalContentJsonNode, AgentChatMessageResponse agentInstanceExchangeResponse, String entityKey, String scopeType)
protected AgentDefinitionModel	resolveAgentDefinitionModel(String definitionId, Map<String,AgentDefinitionModel> modelCache)
protected void	resolveOperationNames(List<AgentInstanceTimelineResponse> timeline)	The timeline query only carries the operation key.
AgentChatMessageDetailResponse	sendAgentChatMessage(String scopeId, String scopeType, SendAgentChatMessageRequest request)

Methods inherited from class com.flowable.platform.security.service.AbstractPlatformSecurityService

addAdditionalPermissions, currentUserHasAdminRights, currentUserIsSuperAdmin, fetchCasePermissionMappings, fetchCasePermissionMappings, fetchCaseSecurityPolicyModel, fetchPermissions, fetchPermissionsForTask, fetchProcessPermissionMappings, fetchProcessPermissionMappings, fetchProcessSecurityPolicyModel, fetchSecurityPolicyModel, fetchSecurityPolicyModel, fetchSecurityPolicyModelForCaseInstance, fetchSecurityPolicyModelForProcessInstance, fetchSecurityPolicyModelForTask, fetchSecurityPolicyModelForTask, fetchTaskPermissionMappings, fetchTaskPermissionMappings, fetchTaskPermissionMappings, fetchTaskPermissionMappingsForCase, fetchTaskPermissionMappingsForProcess, fetchTaskSecurityPolicyModelForCase, fetchTaskSecurityPolicyModelForProcess, filterPermissionsForRole, getCmmnExtensionElementValue, getCurrentGroupKeys, getCurrentSecurityScope, getCurrentTenantId, getCurrentUserId, getDefaultSecurityPolicyModel, getExtensionElementValue, getSecurityPolicyModelByKey, groupOrUserMatches, groupOrUserMatches, hasAnyMatchingIdentityLink, hasAssigneeOrOwnerIdentityLink, hasPermissionForEntityLinks, hasPermissionForHistoricEntityLinks, setPermissionServiceRegistry, translatePermissionForScope

Methods inherited from class java.lang.Object

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

Field Details

ALLOWED_SORT_PROPERTIES_EXCHANGE

protected static final Map<String,org.flowable.common.engine.api.query.QueryProperty> ALLOWED_SORT_PROPERTIES_EXCHANGE

defaultListResponseSize

@Value("${flowable.platform.rest.default-list-response-size:100}")
protected Integer defaultListResponseSize

agentRuntimeService

protected final AgentRuntimeService agentRuntimeService

agentHistoryService

protected final AgentHistoryService agentHistoryService

agentRepositoryService

protected final AgentRepositoryService agentRepositoryService

objectMapper

protected final tools.jackson.databind.ObjectMapper objectMapper

actionRuntimeService

protected final ActionRuntimeService actionRuntimeService

commandExecutorSupplier

protected final Supplier<org.flowable.common.engine.impl.interceptor.CommandExecutor> commandExecutorSupplier

Constructor Details

PlatformAgentService

public PlatformAgentService(AgentRuntimeService agentRuntimeService,
 AgentHistoryService agentHistoryService,
 AgentRepositoryService agentRepositoryService,
 tools.jackson.databind.ObjectMapper objectMapper,
 ActionRuntimeService actionRuntimeService,
 Supplier<org.flowable.common.engine.impl.interceptor.CommandExecutor> commandExecutorSupplier)

Method Details

getAgentChatInstanceResponse

public AgentChatInstanceResponse getAgentChatInstanceResponse(String scopeId,
 String scopeType)

getAgentChatMessages

public org.flowable.common.rest.api.DataResponse<AgentChatMessageResponse> getAgentChatMessages(String scopeId,
 String scopeType,
 org.flowable.common.rest.api.PaginateRequest request)

sendAgentChatMessage

public AgentChatMessageDetailResponse sendAgentChatMessage(String scopeId,
 String scopeType,
 SendAgentChatMessageRequest request)

findSuggestions

protected List<AgentChatMessageResponse> findSuggestions(AgentInstance agentInstance,
 SecurityScope securityScope)

getAgentInstance

protected AgentInstance getAgentInstance(String scopeId,
 String scopeType)

convert

protected List<AgentChatMessageResponse> convert(List<AgentInvocationExchangeChat> exchanges)

convert

protected List<AgentChatMessageResponse> convert(List<AgentInvocationExchangeChat> exchanges,
 Function<AgentChatMessageResponse,AgentChatMessageResponse> converter)

convert

protected Stream<AgentChatMessageResponse> convert(AgentInvocationExchangeChat exchange,
 Map<String,tools.jackson.databind.JsonNode> preParsedTechnicalContent,
 Map<String,ActionInstance> prefetchedActionInstances)

convert

protected AgentChatMessageResponse convert(AgentInvocationExchangeChat exchange,
 AgentInvocationExchangePartChat part)

processInsertedEntities

protected void processInsertedEntities(tools.jackson.databind.JsonNode technicalContentJsonNode,
 AgentChatMessageResponse agentInstanceExchangeResponse,
 String entityKey,
 String scopeType)

getAgentTimeline

public List<AgentInstanceTimelineResponse> getAgentTimeline(String scopeId,
 String scopeType)

getAgentInstanceTimeline

public AgentInstanceTimelineResponse getAgentInstanceTimeline(String agentInstanceId)

Returns the timeline of a single agent instance (with its invocations, exchanges and parts), or null when the instance has no timeline. Authorization for the instance is expected to be performed by the caller.

resolveOperationNames

protected void resolveOperationNames(List<AgentInstanceTimelineResponse> timeline)

The timeline query only carries the operation key. The human-readable operation name lives in the agent definition model, so we resolve it here (caching the model per definition id). When the name cannot be resolved for any reason (definition gone, operation not found, etc.) we fall back to the operation key.

resolveAgentDefinitionModel

protected AgentDefinitionModel resolveAgentDefinitionModel(String definitionId,
 Map<String,AgentDefinitionModel> modelCache)