Package org.jenkinsci.plugin.gitea.servers

Class GiteaServer

java.lang.Object

hudson.model.AbstractDescribableImpl<GiteaServer>

org.jenkinsci.plugin.gitea.servers.GiteaServer

All Implemented Interfaces:

Describable<GiteaServer>

public class GiteaServer
extends AbstractDescribableImpl<GiteaServer>

Represents a Gitea Server instance.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GiteaServer.DescriptorImpl	Our descriptor.

Constructor Summary

Constructors

Constructor	Description
GiteaServer(String displayName, String serverUrl, boolean manageHooks, String credentialsId)	Deprecated. Use GiteaServer(String, String, boolean, String, String)
GiteaServer(String displayName, String serverUrl, boolean manageHooks, String credentialsId, String aliasUrl)	Constructor

Method Summary

Modifier and Type	Method	Description
com.cloudbees.plugins.credentials.common.StandardCredentials	credentials()	Looks up the StandardCredentials to use for auto-management of hooks.
String	getAliasUrl()	Returns the getServerUrl() that the Gitea server believes it has when publishing webhook events or null if this is a normal environment and Gitea is accessed through one true URL and has been configured with that URL.
final String	getCredentialsId()	Returns the IdCredentials.getId() of the credentials to use for auto-management of hooks.
GiteaServer.DescriptorImpl	getDescriptor()
String	getDisplayName()
String	getServerUrl()
final boolean	isManageHooks()	Returns true if and only if Jenkins is supposed to auto-manage hooks for this end-point.

Methods inherited from class java.lang.Object

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

Constructor Details

GiteaServer

@Deprecated
@Restricted(org.kohsuke.accmod.restrictions.DoNotUse.class)
public GiteaServer(@CheckForNull
 String displayName,
 @NonNull
 String serverUrl,
 boolean manageHooks,
 @CheckForNull
 String credentialsId)

Deprecated.

Use GiteaServer(String, String, boolean, String, String)

Constructor

Parameters:

displayName - Optional name to use to describe the end-point.

serverUrl - The URL of this Gitea Server

manageHooks - true if and only if Jenkins is supposed to auto-manage hooks for this end-point.

credentialsId - The IdCredentials.getId() of the credentials to use for auto-management of hooks.

GiteaServer

@DataBoundConstructor
public GiteaServer(@CheckForNull
 String displayName,
 @NonNull
 String serverUrl,
 boolean manageHooks,
 @CheckForNull
 String credentialsId,
 @CheckForNull
 String aliasUrl)

Constructor

Parameters:

displayName - Optional name to use to describe the end-point.

serverUrl - The URL of this Gitea Server

manageHooks - true if and only if Jenkins is supposed to auto-manage hooks for this end-point.

credentialsId - The IdCredentials.getId() of the credentials to use for auto-management of hooks.

aliasUrl - The URL this Gitea Server thinks it is at.

Since:

1.0.5

Method Details

getDisplayName

@CheckForNull
public String getDisplayName()

getServerUrl

@NonNull
public String getServerUrl()

isManageHooks

public final boolean isManageHooks()

Returns true if and only if Jenkins is supposed to auto-manage hooks for this end-point.

Returns:

true if and only if Jenkins is supposed to auto-manage hooks for this end-point.

getCredentialsId

@CheckForNull
public final String getCredentialsId()

Returns the IdCredentials.getId() of the credentials to use for auto-management of hooks.

Returns:

the IdCredentials.getId() of the credentials to use for auto-management of hooks.

getAliasUrl

@CheckForNull
public String getAliasUrl()

Returns the getServerUrl() that the Gitea server believes it has when publishing webhook events or null if this is a normal environment and Gitea is accessed through one true URL and has been configured with that URL.

Returns:

the getServerUrl() that the Gitea server believes it has when publishing webhook events or null

Since:

1.0.5

credentials

@CheckForNull
public com.cloudbees.plugins.credentials.common.StandardCredentials credentials()

Looks up the StandardCredentials to use for auto-management of hooks.

Returns:

the credentials or null.

getDescriptor

public GiteaServer.DescriptorImpl getDescriptor()