Package io.jenkins.plugins.aiagentjob.codex

Class CodexAgentHandler

java.lang.Object

hudson.model.AbstractDescribableImpl<AiAgentTypeHandler>

io.jenkins.plugins.aiagentjob.AiAgentTypeHandler

io.jenkins.plugins.aiagentjob.codex.CodexAgentHandler

All Implemented Interfaces:

ExtensionPoint, Describable<AiAgentTypeHandler>

public final class CodexAgentHandler
extends AiAgentTypeHandler

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	CodexAgentHandler.DescriptorImpl

Nested classes/interfaces inherited from class io.jenkins.plugins.aiagentjob.AiAgentTypeHandler

AiAgentTypeHandler.AcpExecutionSpec, AiAgentTypeHandler.ModelSelection

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor	Description
CodexAgentHandler()

Method Summary

Modifier and Type	Method	Description
List<String>	buildDefaultCommand(AiAgentConfiguration config, String prompt)
String	getAdditionalExecArgs()
String	getAdditionalGlobalArgs()
String	getCustomConfigToml()
String	getDefaultApiKeyEnvVar()	Default API-key environment variable, or empty when the agent uses node-level auth.
String	getId()	Stable identifier for this agent implementation.
AiAgentLogFormat	getLogFormat()	Returns the log format parser for this agent's JSONL output.
AiAgentStatsExtractor	getStatsExtractor()	Returns the stats extractor for this agent's JSONL output.
protected Set<String>	getSupportedReasoningEfforts()	Reasoning efforts recognized when appended to a model identifier.
boolean	isCustomConfigEnabled()
AiAgentExecutionCustomization	prepareExecution(AiAgentConfiguration config, FilePath workspace, TaskListener listener)
void	setAdditionalExecArgs(String additionalExecArgs)
void	setAdditionalGlobalArgs(String additionalGlobalArgs)
void	setCustomConfigEnabled(boolean customConfigEnabled)
void	setCustomConfigToml(String customConfigToml)
void	validateExecution(AiAgentConfiguration config)	Rejects unsupported execution settings before any process or temporary file is created.

Methods inherited from class io.jenkins.plugins.aiagentjob.AiAgentTypeHandler

buildAcpExecution, resolveExitCode, resolveModelSelection, supportsManualApprovals

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

CodexAgentHandler

@DataBoundConstructor
public CodexAgentHandler()

Method Details

getId

public String getId()

Description copied from class: AiAgentTypeHandler

Stable identifier for this agent implementation.

Specified by:

getId in class AiAgentTypeHandler

getDefaultApiKeyEnvVar

public String getDefaultApiKeyEnvVar()

Description copied from class: AiAgentTypeHandler

Default API-key environment variable, or empty when the agent uses node-level auth.

Specified by:

getDefaultApiKeyEnvVar in class AiAgentTypeHandler

getSupportedReasoningEfforts

protected Set<String> getSupportedReasoningEfforts()

Description copied from class: AiAgentTypeHandler

Reasoning efforts recognized when appended to a model identifier.

Overrides:

getSupportedReasoningEfforts in class AiAgentTypeHandler

validateExecution

public void validateExecution(AiAgentConfiguration config)

Description copied from class: AiAgentTypeHandler

Rejects unsupported execution settings before any process or temporary file is created.

Overrides:

validateExecution in class AiAgentTypeHandler

buildDefaultCommand

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

Specified by:

buildDefaultCommand in class AiAgentTypeHandler

prepareExecution

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

Overrides:

prepareExecution in class AiAgentTypeHandler

Throws:

IOException

InterruptedException

isCustomConfigEnabled

public boolean isCustomConfigEnabled()

setCustomConfigEnabled

@DataBoundSetter
public void setCustomConfigEnabled(boolean customConfigEnabled)

getCustomConfigToml

public String getCustomConfigToml()

setCustomConfigToml

@DataBoundSetter
public void setCustomConfigToml(String customConfigToml)

getAdditionalGlobalArgs

public String getAdditionalGlobalArgs()

setAdditionalGlobalArgs

@DataBoundSetter
public void setAdditionalGlobalArgs(String additionalGlobalArgs)

getAdditionalExecArgs

public String getAdditionalExecArgs()

setAdditionalExecArgs

@DataBoundSetter
public void setAdditionalExecArgs(String additionalExecArgs)

getLogFormat

public AiAgentLogFormat getLogFormat()

Description copied from class: AiAgentTypeHandler

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.

Specified by:

getLogFormat in class AiAgentTypeHandler

getStatsExtractor

public AiAgentStatsExtractor getStatsExtractor()

Description copied from class: AiAgentTypeHandler

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.

Specified by:

getStatsExtractor in class AiAgentTypeHandler