Class BaseModelProcessor

java.lang.Object

com.flowable.agent.engine.impl.model.BaseModelProcessor

Direct Known Subclasses:

BaseAgentModelProcessor, BaseRemoteEmbedderKnowledgeBaseModelProcessor, OpenAiVectorStoreApiKeyKnowledgeBaseProcessor

public abstract class BaseModelProcessor
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	BaseModelProcessor.ApiKeyHeader

Field Summary

Fields

Modifier and Type	Field	Description
protected final AgentEngineConfiguration	engineConfiguration
protected final String	modelType

Constructor Summary

Constructors

Constructor	Description
BaseModelProcessor(AgentEngineConfiguration engineConfiguration, String modelType)

Method Summary

Modifier and Type	Method	Description
protected FlowableAuthenticationApiKey	determineFlowableApplicationApiKey(AgentDefinitionModel.Credentials apiKey, String modelKey, String aiVendor)
protected FlowableAuthenticationApiKey	determineFlowableApplicationApiKey(BaseAgentModelSettings modelSettings, String modelKey, String aiVendor)	Preferred resolution path.
protected abstract BaseModelProcessor.ApiKeyHeader	getApiKeyHeader(String apiKeyType, String modelKey)
protected ConfigurationService	getConfigurationService()
protected abstract FlowableAuthenticationApiKey	getFallbackAuthenticationApiKey(String aiVendor, String modelKey)
protected PlatformEngineConfigurationApi	getPlatformEngineConfiguration()
protected PlatformManagementService	getPlatformManagementService()
protected FlowableAuthenticationApiKey	resolveCredentialsAsApiKey(AgentDefinitionModel.Credentials credentials, String modelKey, String aiVendor, String headerName, String headerPrefix)	Resolve a AgentDefinitionModel.Credentials into a FlowableAuthenticationApiKey with an explicit header name and value prefix supplied by the AgentAuthentication subtype (i.e. the auth object dictates the header — not the per-vendor default).
protected FlowableAuthenticationApiKey	resolveExpressionApiKey(String modelKey, String value, String aiVendor)
protected FlowableAuthenticationApiKey	resolveOauth2ClientApiKey(String modelKey, String aiVendor, String oauth2RegistrationKey)
protected FlowableAuthenticationApiKey	resolveSecretApiKey(String modelKey, String secretName, String vendorName)

Methods inherited from class Object

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

Field Details

engineConfiguration

protected final AgentEngineConfiguration engineConfiguration

modelType

protected final String modelType

Constructor Details

BaseModelProcessor

public BaseModelProcessor(AgentEngineConfiguration engineConfiguration,
 String modelType)

Method Details

determineFlowableApplicationApiKey

protected FlowableAuthenticationApiKey determineFlowableApplicationApiKey(AgentDefinitionModel.Credentials apiKey,
 String modelKey,
 String aiVendor)

determineFlowableApplicationApiKey

protected FlowableAuthenticationApiKey determineFlowableApplicationApiKey(BaseAgentModelSettings modelSettings,
 String modelKey,
 String aiVendor)

Preferred resolution path. If the model has an AgentAuthentication, build the header from it. If the legacy apiKey is present, fall back to the legacy apiKey + getApiKeyHeader chain. If neither is configured, the model intentionally has no authentication (e.g. a locally hosted OpenAI-compatible LLM with no auth) and null is returned; consumers must treat a null authentication provider as "do not add an auth header".

resolveCredentialsAsApiKey

protected FlowableAuthenticationApiKey resolveCredentialsAsApiKey(AgentDefinitionModel.Credentials credentials,
 String modelKey,
 String aiVendor,
 String headerName,
 String headerPrefix)

Resolve a AgentDefinitionModel.Credentials into a FlowableAuthenticationApiKey with an explicit header name and value prefix supplied by the AgentAuthentication subtype (i.e. the auth object dictates the header — not the per-vendor default).

getApiKeyHeader

protected abstract BaseModelProcessor.ApiKeyHeader getApiKeyHeader(String apiKeyType,
 String modelKey)

resolveSecretApiKey

protected FlowableAuthenticationApiKey resolveSecretApiKey(String modelKey,
 String secretName,
 String vendorName)

resolveOauth2ClientApiKey

protected FlowableAuthenticationApiKey resolveOauth2ClientApiKey(String modelKey,
 String aiVendor,
 String oauth2RegistrationKey)

resolveExpressionApiKey

protected FlowableAuthenticationApiKey resolveExpressionApiKey(String modelKey,
 String value,
 String aiVendor)

getFallbackAuthenticationApiKey

protected abstract FlowableAuthenticationApiKey getFallbackAuthenticationApiKey(String aiVendor,
 String modelKey)

getConfigurationService

protected ConfigurationService getConfigurationService()

getPlatformManagementService

protected PlatformManagementService getPlatformManagementService()

getPlatformEngineConfiguration

protected PlatformEngineConfigurationApi getPlatformEngineConfiguration()