Class OrasGenericArtifactConfig

java.lang.Object

io.jenkins.plugins.oras_artifacts.OrasGenericArtifactConfig

All Implemented Interfaces:

Describable<OrasGenericArtifactConfig>, Serializable

@Extension
public class OrasGenericArtifactConfig
extends Object
implements Describable<OrasGenericArtifactConfig>, Serializable

Global configuration of the ORAS registry used to store archived artifacts and stashes.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	OrasGenericArtifactConfig.DescriptorImpl

Constructor Summary

Constructors

Constructor	Description
OrasGenericArtifactConfig()
OrasGenericArtifactConfig(String registryUrl, String credentialsId, String prefix, boolean insecure)

Method Summary

Modifier and Type	Method	Description
RegistryClient	createClient()	Build a new RegistryClient from this configuration.
static OrasGenericArtifactConfig	get()
static com.cloudbees.plugins.credentials.common.StandardUsernamePasswordCredentials	getCredentials(String credentialsId)
String	getCredentialsId()
String	getPrefix()	Optional prefix (namespace) prepended to every repository name derived from a job full name.
String	getRegistryUrl()
boolean	isInsecure()
String	repositoryFor(String jobFullName)	Build the OCI repository name for the given Jenkins job full name, honoring the configured prefix.
io.jenkins.plugins.oras_artifacts.OrasConnection	resolve()	Resolve the credentials referenced by getCredentialsId() into a self-contained, serializable connection descriptor that can be sent to an agent over remoting (unlike this class, which relies on controller-only APIs such as CredentialsProvider).
void	setCredentialsId(String credentialsId)
void	setInsecure(boolean insecure)
void	setPrefix(String prefix)
void	setRegistryUrl(String registryUrl)

Methods inherited from class Object

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

Methods inherited from interface Describable

getDescriptor

Constructor Details

OrasGenericArtifactConfig

@DataBoundConstructor
public OrasGenericArtifactConfig()

OrasGenericArtifactConfig

public OrasGenericArtifactConfig(String registryUrl,
 String credentialsId,
 String prefix,
 boolean insecure)

Method Details

getRegistryUrl

public String getRegistryUrl()

setRegistryUrl

@DataBoundSetter
public void setRegistryUrl(String registryUrl)

getCredentialsId

public String getCredentialsId()

setCredentialsId

@DataBoundSetter
public void setCredentialsId(String credentialsId)

getPrefix

public String getPrefix()

Optional prefix (namespace) prepended to every repository name derived from a job full name.

setPrefix

@DataBoundSetter
public void setPrefix(String prefix)

isInsecure

public boolean isInsecure()

setInsecure

@DataBoundSetter
public void setInsecure(boolean insecure)

get

public static OrasGenericArtifactConfig get()

repositoryFor

public String repositoryFor(String jobFullName)

Build the OCI repository name for the given Jenkins job full name, honoring the configured prefix.

createClient

public RegistryClient createClient()

Build a new RegistryClient from this configuration. Must be called on the Jenkins controller since it looks up credentials from the CredentialsProvider store.

resolve

public io.jenkins.plugins.oras_artifacts.OrasConnection resolve()

Resolve the credentials referenced by getCredentialsId() into a self-contained, serializable connection descriptor that can be sent to an agent over remoting (unlike this class, which relies on controller-only APIs such as CredentialsProvider).

getCredentials

public static com.cloudbees.plugins.credentials.common.StandardUsernamePasswordCredentials getCredentials(String credentialsId)