Package io.jenkins.plugins.checks.gitea

Class GiteaChecksContext

java.lang.Object

io.jenkins.plugins.checks.gitea.GiteaChecksContext

public abstract class GiteaChecksContext
extends Object

Base class for a context that publishes Gitea checks.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	GiteaChecksContext(Job<?,?> job, String url, SCMFacade scmFacade)

Method Summary

Modifier and Type	Method	Description
com.cloudbees.plugins.credentials.common.StandardCredentials	getCredentials()	Returns the credentials to access the remote Gitea repository.
protected abstract String	getCredentialsId()
protected com.cloudbees.plugins.credentials.common.StandardCredentials	getGiteaAppCredentials(String credentialsId)
abstract String	getGiteaServerUrl()	Returns the source repository's server URL of the run.
abstract String	getHeadSha()	Returns the commit sha of the run.
protected Job<?,?>	getJob()
abstract String	getRepo()	Returns the source repository's name of the run.
abstract String	getRepoOwner()	Returns the source repository's owner name of the run, e.g.
abstract String	getRepository()	Returns the source repository's full name of the run.
protected abstract Optional<Run<?,?>>	getRun()
protected SCMFacade	getScmFacade()
String	getURL()	Returns the URL of the run's summary page, e.g.
protected boolean	hasCredentialsId()
protected boolean	hasGiteaAppCredentials()
protected boolean	hasValidCredentials(edu.hm.hafner.util.FilteredLog logger)
abstract boolean	isValid(edu.hm.hafner.util.FilteredLog logger)	Returns whether the context is valid (with all properties functional) to use.

Methods inherited from class java.lang.Object

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

Constructor Details

GiteaChecksContext

protected GiteaChecksContext(Job<?,?> job,
 String url,
 SCMFacade scmFacade)

Method Details

getHeadSha

public abstract String getHeadSha()

Returns the commit sha of the run.

Returns:

the commit sha of the run

getRepoOwner

public abstract String getRepoOwner()

Returns the source repository's owner name of the run, e.g. jenkins-ci

Returns:

the source repository's owner name

getRepo

public abstract String getRepo()

Returns the source repository's name of the run. The name consists of the repository's name, e.g. jenkins

Returns:

the source repository's name

getGiteaServerUrl

public abstract String getGiteaServerUrl()

Returns the source repository's server URL of the run.

Returns:

the source repository's server URL

getRepository

public abstract String getRepository()

Returns the source repository's full name of the run. The full name consists of the owner's name and the repository's name, e.g. jenkins-ci/jenkins

Returns:

the source repository's full name

isValid

public abstract boolean isValid(edu.hm.hafner.util.FilteredLog logger)

Returns whether the context is valid (with all properties functional) to use.

Parameters:

logger - the filtered logger

Returns:

whether the context is valid to use

getCredentialsId

@CheckForNull
protected abstract String getCredentialsId()

getCredentials

public com.cloudbees.plugins.credentials.common.StandardCredentials getCredentials()

Returns the credentials to access the remote Gitea repository.

Returns:

the credentials

getURL

public String getURL()

Returns the URL of the run's summary page, e.g. https://ci.jenkins.io/job/Core/job/jenkins/job/master/2000/.

Returns:

the URL of the summary page

getJob

protected Job<?,?> getJob()

getScmFacade

protected SCMFacade getScmFacade()

getGiteaAppCredentials

protected com.cloudbees.plugins.credentials.common.StandardCredentials getGiteaAppCredentials(String credentialsId)

hasGiteaAppCredentials

protected boolean hasGiteaAppCredentials()

hasCredentialsId

protected boolean hasCredentialsId()

hasValidCredentials

protected boolean hasValidCredentials(edu.hm.hafner.util.FilteredLog logger)

getRun

protected abstract Optional<Run<?,?>> getRun()