Class OrasSCM

java.lang.Object

hudson.scm.SCM

io.jenkins.plugins.scmoras.OrasSCM

All Implemented Interfaces:

ExtensionPoint, Describable<SCM>

public class OrasSCM
extends SCM

SCM implementation that checks out the content of a repository packaged as an OCI artifact of type application/vnd.jenkins.repo.manifest.v1+json and pulled with ORAS.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	OrasSCM.DescriptorImpl

Nested classes/interfaces inherited from interface ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields

Modifier and Type	Field	Description
static final land.oras.ArtifactType	ARTIFACT_TYPE_REPO

Fields inherited from class SCM

PERMISSIONS, TAG

Constructor Summary

Constructors

Constructor	Description
OrasSCM(String containerRef)

Method Summary

Modifier and Type	Method	Description
SCMRevisionState	calcRevisionsFromBuild(Run<?,?> build, FilePath workspace, Launcher launcher, TaskListener listener)
void	checkout(Run<?,?> build, Launcher launcher, FilePath workspace, TaskListener listener, File changelogFile, SCMRevisionState baseline)
PollingResult	compareRemoteRevisionWith(Job<?,?> project, Launcher launcher, FilePath workspace, TaskListener listener, SCMRevisionState baseline)
ChangeLogParser	createChangeLogParser()
String	getContainerRef()
static com.cloudbees.plugins.credentials.common.StandardUsernamePasswordCredentials	getCredentials(Item item, String credentialsId)
String	getCredentialsId()
String	getKey()
boolean	isInsecure()
boolean	requiresWorkspaceForPolling()
void	setCredentialsId(String credentialsId)
void	setInsecure(boolean insecure)

Methods inherited from class SCM

_calcRevisionsFromBuild, _for, _for, all, buildEnvironment, buildEnvVars, calcRevisionsFromBuild, checkout, compareRemoteRevisionWith, createEmptyChangeLog, createEmptyChangeLog, getApi, getBrowser, getDescriptor, getEffectiveBrowser, getModuleRoot, getModuleRoot, getModuleRoots, getModuleRoots, getType, guessBrowser, nullify, poll, pollChanges, postCheckout, postCheckout, processWorkspaceBeforeDeletion, processWorkspaceBeforeDeletion, supportsPolling

Methods inherited from class Object

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

Field Details

ARTIFACT_TYPE_REPO

public static final land.oras.ArtifactType ARTIFACT_TYPE_REPO

Constructor Details

OrasSCM

@DataBoundConstructor
public OrasSCM(String containerRef)

Method Details

getContainerRef

public String getContainerRef()

getCredentialsId

public String getCredentialsId()

setCredentialsId

@DataBoundSetter
public void setCredentialsId(String credentialsId)

isInsecure

public boolean isInsecure()

setInsecure

@DataBoundSetter
public void setInsecure(boolean insecure)

checkout

public void checkout(@NonNull
 Run<?,?> build,
 @NonNull
 Launcher launcher,
 @NonNull
 FilePath workspace,
 @NonNull
 TaskListener listener,
 @CheckForNull
 File changelogFile,
 @CheckForNull
 SCMRevisionState baseline)
              throws IOException,
InterruptedException

Overrides:

checkout in class SCM

Throws:

IOException

InterruptedException

calcRevisionsFromBuild

public SCMRevisionState calcRevisionsFromBuild(@NonNull
 Run<?,?> build,
 @Nullable
 FilePath workspace,
 @Nullable
 Launcher launcher,
 @NonNull
 TaskListener listener)

Overrides:

calcRevisionsFromBuild in class SCM

compareRemoteRevisionWith

public PollingResult compareRemoteRevisionWith(@NonNull
 Job<?,?> project,
 @Nullable
 Launcher launcher,
 @Nullable
 FilePath workspace,
 @NonNull
 TaskListener listener,
 @NonNull
 SCMRevisionState baseline)
                                        throws IOException,
InterruptedException

Overrides:

compareRemoteRevisionWith in class SCM

Throws:

IOException

InterruptedException

requiresWorkspaceForPolling

public boolean requiresWorkspaceForPolling()

Overrides:

requiresWorkspaceForPolling in class SCM

createChangeLogParser

public ChangeLogParser createChangeLogParser()

Specified by:

createChangeLogParser in class SCM

getKey

public String getKey()

Overrides:

getKey in class SCM

getCredentials

@Nullable
public static com.cloudbees.plugins.credentials.common.StandardUsernamePasswordCredentials getCredentials(Item item,
 String credentialsId)