Package org.jenkinsci.plugins.github.config

Class HookSecretConfig

java.lang.Object

hudson.model.AbstractDescribableImpl<HookSecretConfig>

org.jenkinsci.plugins.github.config.HookSecretConfig

All Implemented Interfaces:

Describable<HookSecretConfig>

public class HookSecretConfig
extends AbstractDescribableImpl<HookSecretConfig>

Manages storing/retrieval of the shared secret for the hook.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	HookSecretConfig.DescriptorImpl

Constructor Summary

Constructors

Constructor	Description
HookSecretConfig(String credentialsId)	Legacy constructor for backwards compatibility.
HookSecretConfig(String credentialsId, String signatureAlgorithm)

Method Summary

Modifier and Type	Method	Description
String	getCredentialsId()
Secret	getHookSecret()	Gets the currently used secret being used for payload verification.
SignatureAlgorithm	getSignatureAlgorithm()	Gets the signature algorithm to use for webhook validation.
String	getSignatureAlgorithmName()	Gets the signature algorithm name for UI binding.
void	setCredentialsId(String credentialsId)	Deprecated. rather treat this field as final and use GitHubPluginConfig.setHookSecretConfigs(java.util.List<org.jenkinsci.plugins.github.config.HookSecretConfig>)

Methods inherited from class hudson.model.AbstractDescribableImpl

getDescriptor

Methods inherited from class java.lang.Object

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

Constructor Details

HookSecretConfig

@DataBoundConstructor
public HookSecretConfig(String credentialsId,
 String signatureAlgorithm)

HookSecretConfig

public HookSecretConfig(String credentialsId)

Legacy constructor for backwards compatibility.

Method Details

getHookSecret

@Nullable
public Secret getHookSecret()

Gets the currently used secret being used for payload verification.

Returns:

Current secret, null if not set.

getCredentialsId

public String getCredentialsId()

getSignatureAlgorithm

public SignatureAlgorithm getSignatureAlgorithm()

Gets the signature algorithm to use for webhook validation.

Returns:

the configured signature algorithm, defaults to SHA-256

Since:

1.45.0

getSignatureAlgorithmName

public String getSignatureAlgorithmName()

Gets the signature algorithm name for UI binding.

Returns:

the algorithm name as string (e.g., "SHA256", "SHA1")

Since:

1.45.0

setCredentialsId

@Deprecated
public void setCredentialsId(String credentialsId)

Deprecated.

rather treat this field as final and use GitHubPluginConfig.setHookSecretConfigs(java.util.List<org.jenkinsci.plugins.github.config.HookSecretConfig>)

Parameters:

credentialsId - a new ID