Package io.jenkins.plugins.explain_error.provider

Class CustomOktaAIProvider

java.lang.Object

hudson.model.AbstractDescribableImpl<BaseAIProvider>

io.jenkins.plugins.explain_error.provider.BaseAIProvider

io.jenkins.plugins.explain_error.provider.CustomOktaAIProvider

All Implemented Interfaces:

ExtensionPoint, Describable<BaseAIProvider>

public class CustomOktaAIProvider
extends BaseAIProvider

Generic provider for OpenAI-style chat completion APIs secured by Okta OAuth client credentials.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CustomOktaAIProvider.DescriptorImpl

Nested classes/interfaces inherited from class io.jenkins.plugins.explain_error.provider.BaseAIProvider

BaseAIProvider.Assistant, BaseAIProvider.BaseProviderDescriptor

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_ACCESS_TOKEN_HEADER
static final String	DEFAULT_ACCESS_TOKEN_PREFIX
static final String	DEFAULT_MODEL
static final int	DEFAULT_TIMEOUT_SECONDS

Fields inherited from class io.jenkins.plugins.explain_error.provider.BaseAIProvider

model, SYSTEM_PROMPT, url, USER_PROMPT_TEMPLATE

Constructor Summary

Constructors

Constructor	Description
CustomOktaAIProvider(String url, String tokenUrl, String model, String clientId, Secret clientSecret)

Method Summary

Modifier and Type	Method	Description
BaseAIProvider.Assistant	createAssistant(Item item, org.springframework.security.core.Authentication authentication, Double temperature)	The single assistant factory providers implement.
FixAssistant	createFixAssistant(Item item, org.springframework.security.core.Authentication authentication)	The single fix-assistant factory providers implement; the no-arg createFixAssistant() is final and delegates here.
String	getAccessTokenHeader()
String	getAccessTokenPrefix()
String	getApiVersion()
Secret	getAppKey()
String	getClientId()
Secret	getClientSecret()
String	getScope()
Integer	getTimeoutSeconds()
String	getTokenUrl()
String	getUserId()
boolean	isNotValid(TaskListener listener)
void	setAccessTokenHeader(String accessTokenHeader)
void	setAccessTokenPrefix(String accessTokenPrefix)
void	setApiVersion(String apiVersion)
void	setAppKey(Secret appKey)
void	setScope(String scope)
void	setTimeoutSeconds(Integer timeoutSeconds)
void	setUserId(String userId)

Methods inherited from class io.jenkins.plugins.explain_error.provider.BaseAIProvider

analyzeError, buildSystemPrompt, buildUserPrompt, createAssistant, createAssistant, createAssistant, createFixAssistant, explainError, explainError, explainError, explainError, explainError, getDescriptor, getEffectiveEndpointForDiagnostics, getModel, getProviderName, getProxyAuthorizationHeader, getUrl, isNotValid, newJenkinsHttpClientBuilder, newLangChainHttpClientBuilder

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_MODEL

public static final String DEFAULT_MODEL

See Also:

• Constant Field Values

DEFAULT_ACCESS_TOKEN_HEADER

public static final String DEFAULT_ACCESS_TOKEN_HEADER

See Also:

• Constant Field Values

DEFAULT_ACCESS_TOKEN_PREFIX

public static final String DEFAULT_ACCESS_TOKEN_PREFIX

See Also:

• Constant Field Values

DEFAULT_TIMEOUT_SECONDS

public static final int DEFAULT_TIMEOUT_SECONDS

See Also:

• Constant Field Values

Constructor Details

CustomOktaAIProvider

@DataBoundConstructor
public CustomOktaAIProvider(String url,
 String tokenUrl,
 String model,
 String clientId,
 Secret clientSecret)

Method Details

getTokenUrl

public String getTokenUrl()

getApiVersion

public String getApiVersion()

setApiVersion

@DataBoundSetter
public void setApiVersion(String apiVersion)

getClientId

public String getClientId()

getClientSecret

public Secret getClientSecret()

getScope

public String getScope()

setScope

@DataBoundSetter
public void setScope(String scope)

getAccessTokenHeader

public String getAccessTokenHeader()

setAccessTokenHeader

@DataBoundSetter
public void setAccessTokenHeader(String accessTokenHeader)

getAccessTokenPrefix

public String getAccessTokenPrefix()

setAccessTokenPrefix

@DataBoundSetter
public void setAccessTokenPrefix(String accessTokenPrefix)

getAppKey

public Secret getAppKey()

setAppKey

@DataBoundSetter
public void setAppKey(Secret appKey)

getUserId

public String getUserId()

setUserId

@DataBoundSetter
public void setUserId(String userId)

getTimeoutSeconds

public Integer getTimeoutSeconds()

setTimeoutSeconds

@DataBoundSetter
public void setTimeoutSeconds(Integer timeoutSeconds)

createAssistant

public BaseAIProvider.Assistant createAssistant(@CheckForNull
 Item item,
 @CheckForNull
 org.springframework.security.core.Authentication authentication,
 @CheckForNull
 Double temperature)

Description copied from class: BaseAIProvider

The single assistant factory providers implement. It receives the full request context — credentials scope and temperature — so that a provider cannot accidentally drop a parameter by overriding the wrong overload (the narrower createAssistant variants are final and delegate here). Providers without item-scoped credentials simply ignore item/authentication.

Specified by:

createAssistant in class BaseAIProvider

Parameters:

item - the item defining the credentials scope, or null

authentication - the authentication for credentials lookup, or null

temperature - the temperature to use, or null for the provider default

Returns:

the assistant

createFixAssistant

public FixAssistant createFixAssistant(@CheckForNull
 Item item,
 @CheckForNull
 org.springframework.security.core.Authentication authentication)

Description copied from class: BaseAIProvider

The single fix-assistant factory providers implement; the no-arg createFixAssistant() is final and delegates here.

Specified by:

createFixAssistant in class BaseAIProvider

Parameters:

item - the item defining the credentials scope, or null

authentication - the authentication for credentials lookup, or null

Returns:

the fix assistant

isNotValid

public boolean isNotValid(@CheckForNull
 TaskListener listener)

Specified by:

isNotValid in class BaseAIProvider