google-adk-kotlin-core/com.google.adk.kt.interop/BaseFuturePlugin

BaseFuturePlugin

abstract class BaseFuturePlugin(pluginName: String) : Plugin

Java-friendly base for implementing a Plugin -- the cross-cutting interception point. The engine's Plugin has 12 suspend callbacks plus close(), every one with a default body. This base final-overrides all 12 and re-exposes each as a CompletableFuture-returning hook whose result is the outcome; each default hook completes with the value that leaves execution unchanged. Return the future promptly and do any blocking work inside it, not before returning it.

Each hook mirrors its engine callback's shape: those whose callback returns a CallbackChoice resolve to one too (build it with Choices -- Choices.proceed to continue, Choices.breakWith to short-circuit), and the rest resolve to a replacement value. To leave execution unchanged, resolve to the original value, exactly as the default hooks do.

Constructors

BaseFuturePlugin

constructor(pluginName: String)

Properties

name

open override val name: String

The unique name of the plugin.

Functions

afterAgent

suspend override fun afterAgent(context: CallbackContext): CallbackChoice<Unit, Content>

Callback executed after a specific agent finishes its processing.

afterModel

suspend override fun afterModel(context: CallbackContext, response: LlmResponse): LlmResponse

Callback executed after an LLM response is received.

afterRun

suspend override fun afterRun(invocationContext: InvocationContext)

Callback executed after the ADK runner completes its execution.

afterTool

suspend override fun afterTool(context: ToolContext, tool: BaseTool, args: Map<String, Any?>, result: Map<String, Any?>): Map<String, Any?>

Callback executed after a tool finishes its execution.

beforeAgent

suspend override fun beforeAgent(context: CallbackContext): CallbackChoice<EventActions, Content>

Callback executed before a specific agent starts processing.

beforeModel

suspend override fun beforeModel(context: CallbackContext, request: LlmRequest): CallbackChoice<LlmRequest, LlmResponse>

Callback executed before an LLM request is sent.

beforeRun

suspend override fun beforeRun(invocationContext: InvocationContext): CallbackChoice<Unit, Content>

Callback executed before the ADK runner starts the main execution loop.

beforeTool

suspend override fun beforeTool(context: ToolContext, tool: BaseTool, args: Map<String, Any?>): CallbackChoice<Map<String, Any?>, Map<String, Any?>>

Callback executed before a tool is invoked.

open override fun close()

Method executed when the runner is closed.

onEvent

suspend override fun onEvent(invocationContext: InvocationContext, event: Event): Event

Callback executed when an event is yielded by an agent during execution.

onModelError

suspend override fun onModelError(context: CallbackContext, request: LlmRequest, error: Throwable): CallbackChoice<Unit, LlmResponse>

Callback executed when an error occurs during an LLM interaction.

onToolError

suspend override fun onToolError(context: ToolContext, tool: BaseTool, args: Map<String, Any?>, error: Throwable): CallbackChoice<Unit, Map<String, Any?>>

Callback executed when an error occurs during a tool invocation.

onUserMessage

suspend override fun onUserMessage(invocationContext: InvocationContext, userMessage: Content): Content

Callback executed when a user message is received before an invocation starts.