Package io.jenkins.plugins.aiagentjob

Class AiAgentTypeHandler

java.lang.Object

hudson.model.AbstractDescribableImpl<AiAgentTypeHandler>

io.jenkins.plugins.aiagentjob.AiAgentTypeHandler

All Implemented Interfaces:

ExtensionPoint, Describable<AiAgentTypeHandler>

Direct Known Subclasses:

ClaudeCodeAgentHandler, CodexAgentHandler, CursorAgentHandler, GeminiCliAgentHandler, OpenCodeAgentHandler

public abstract class AiAgentTypeHandler
extends AbstractDescribableImpl<AiAgentTypeHandler>
implements ExtensionPoint

Describable extension point for an AI agent implementation.

Implementations must define:

• getId() — stable identifier
• getDefaultApiKeyEnvVar() — env var for the API key
• buildDefaultCommand(io.jenkins.plugins.aiagentjob.AiAgentConfiguration, java.lang.String) — CLI command to launch the agent
• getLogFormat() — parser for the agent's JSONL output
• getStatsExtractor() — usage stats extractor for the agent's JSONL output

Implementations may optionally override prepareExecution(io.jenkins.plugins.aiagentjob.AiAgentConfiguration, hudson.FilePath, hudson.model.TaskListener) to contribute agent-specific environment setup/cleanup.

Nested Class Summary

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor	Description
AiAgentTypeHandler()

Method Summary

Modifier and Type	Method	Description
abstract List<String>	buildDefaultCommand(AiAgentConfiguration config, String prompt)
abstract String	getDefaultApiKeyEnvVar()
abstract String	getId()	Stable identifier for this agent implementation.
abstract AiAgentLogFormat	getLogFormat()	Returns the log format parser for this agent's JSONL output.
abstract AiAgentStatsExtractor	getStatsExtractor()	Returns the stats extractor for this agent's JSONL output.
AiAgentExecutionCustomization	prepareExecution(AiAgentConfiguration config, FilePath workspace, TaskListener listener)

Methods inherited from class java.lang.Object

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

Methods inherited from interface hudson.model.Describable

getDescriptor

Constructor Details

AiAgentTypeHandler

public AiAgentTypeHandler()

Method Details

getId

public abstract String getId()

Stable identifier for this agent implementation.

getDefaultApiKeyEnvVar

public abstract String getDefaultApiKeyEnvVar()

buildDefaultCommand

public abstract List<String> buildDefaultCommand(AiAgentConfiguration config,
 String prompt)

prepareExecution

public AiAgentExecutionCustomization prepareExecution(AiAgentConfiguration config,
 FilePath workspace,
 TaskListener listener)
                                               throws IOException,
InterruptedException

Throws:

IOException

InterruptedException

getLogFormat

public abstract AiAgentLogFormat getLogFormat()

Returns the log format parser for this agent's JSONL output.

The returned format's AiAgentLogFormat.classify(long, net.sf.json.JSONObject) method should return null for any JSON it does not recognise, so the parser can fall through to the shared format and generic fallback.

getStatsExtractor

public abstract AiAgentStatsExtractor getStatsExtractor()

Returns the stats extractor for this agent's JSONL output.

The returned extractor's AiAgentStatsExtractor.extract(net.sf.json.JSONObject, io.jenkins.plugins.aiagentjob.AgentUsageStats) method should return false for any JSON it does not recognise, so the shared extractor handles it as a fallback.