Package io.jenkins.plugins.webhookexternalstore

Class WebhookCredentialsProvider

java.lang.Object

hudson.model.Descriptor<com.cloudbees.plugins.credentials.CredentialsProvider>

com.cloudbees.plugins.credentials.CredentialsProvider

io.jenkins.plugins.webhookexternalstore.WebhookCredentialsProvider

All Implemented Interfaces:

ExtensionPoint, Describable<com.cloudbees.plugins.credentials.CredentialsProvider>, Saveable, Loadable, OnMaster, IconSpec

@Extension
public class WebhookCredentialsProvider
extends com.cloudbees.plugins.credentials.CredentialsProvider

CredentialsProvider that provides credentials received via webhooks.

This provider manages credentials that are created/updated through webhook calls and makes them available throughout Jenkins.

Nested Class Summary

Nested classes/interfaces inherited from class hudson.model.Descriptor

Descriptor.FormException, Descriptor.PropertyType, Descriptor.Self

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields inherited from class com.cloudbees.plugins.credentials.CredentialsProvider

CREATE, DELETE, GROUP, MANAGE_DOMAINS, NONE, UPDATE, USE_ITEM, USE_OWN, VIEW

Fields inherited from class hudson.model.Descriptor

clazz

Fields inherited from interface hudson.model.Saveable

NOOP

Constructor Summary

Constructors

Constructor	Description
WebhookCredentialsProvider()

Method Summary

Modifier and Type	Method	Description
void	addOrUpdateCredential(WebhookPayload payload)	Add or update a credential from a webhook payload.
List<com.cloudbees.plugins.credentials.common.IdCredentials>	getAllWebhookCredentials()	Get all webhook credentials.
<C extends com.cloudbees.plugins.credentials.Credentials> @NonNull List<C>	getCredentialsInItemGroup(@NonNull Class<C> type, @Nullable ItemGroup itemGroup, @Nullable org.springframework.security.core.Authentication authentication, @NonNull List<com.cloudbees.plugins.credentials.domains.DomainRequirement> domainRequirements)
String	getIconClassName()
static WebhookCredentialsProvider	getInstance()	Get the singleton instance of this provider.
com.cloudbees.plugins.credentials.CredentialsStore	getStore(ModelObject object)

Methods inherited from class com.cloudbees.plugins.credentials.CredentialsProvider

_isApplicable, all, allCredentialsDescriptors, enabled, enabled, findCredentialById, findCredentialById, findCredentialById, findCredentialByIdInItem, findCredentialByIdInItemGroup, getCredentialByIdInItem, getCredentialByIdInItemGroup, getCredentialIds, getCredentialIds, getCredentialIdsInItem, getCredentialIdsInItemGroup, getCredentials, getCredentials, getCredentials, getCredentials, getCredentialsDescriptors, getCredentialsInItem, getDescriptor, getDisplayName, getFingerprintOf, getOrCreateFingerprintOf, getScopes, hasCredentialsDescriptors, hasStores, isApplicable, isApplicable, isEnabled, isEnabled, listCredentials, listCredentials, listCredentialsInItem, listCredentialsInItemGroup, lookupCredentials, lookupCredentials, lookupCredentials, lookupCredentials, lookupCredentials, lookupCredentials, lookupCredentials, lookupCredentials, lookupCredentials, lookupCredentials, lookupCredentialsInItem, lookupCredentialsInItem, lookupCredentialsInItemGroup, lookupCredentialsInItemGroup, lookupScopes, lookupStores, saveAll, snapshot, snapshot, track, track, track, trackAll, trackAll, trackAll, trackAll, trackAll, trackAll

Methods inherited from class hudson.model.Descriptor

addHelpFileRedirect, bindJSON, bindJSON, calcAutoCompleteSettings, calcFillSettings, configure, configure, configure, doHelp, doHelp, find, find, findByDescribableClassName, findById, getCategory, getCheckMethod, getCheckUrl, getConfigFile, getConfigPage, getCurrentDescriptorByNameUrl, getDescriptorFullUrl, getDescriptorUrl, getGlobalConfigPage, getGlobalPropertyType, getHelpFile, getHelpFile, getHelpFile, getId, getJsonSafeClassName, getKlass, getPlugin, getPossibleViewNames, getPropertyType, getPropertyType, getPropertyTypeOrDie, getRequiredGlobalConfigPagePermission, getStaticHelpUrl, getStaticHelpUrl, getT, getViewPage, isInstance, isSubTypeOf, load, newInstance, newInstance, newInstance, newInstancesFromHeteroList, newInstancesFromHeteroList, newInstancesFromHeteroList, newInstancesFromHeteroList, save, self, toArray, toList, toMap

Methods inherited from class java.lang.Object

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

Constructor Details

WebhookCredentialsProvider

public WebhookCredentialsProvider()

Method Details

getStore

public com.cloudbees.plugins.credentials.CredentialsStore getStore(ModelObject object)

Overrides:

getStore in class com.cloudbees.plugins.credentials.CredentialsProvider

getCredentialsInItemGroup

public <C extends com.cloudbees.plugins.credentials.Credentials>
@NonNull List<C> getCredentialsInItemGroup(@NonNull Class<C> type,
 @Nullable ItemGroup itemGroup,
 @Nullable org.springframework.security.core.Authentication authentication,
 @NonNull List<com.cloudbees.plugins.credentials.domains.DomainRequirement> domainRequirements)

Overrides:

getCredentialsInItemGroup in class com.cloudbees.plugins.credentials.CredentialsProvider

addOrUpdateCredential

public void addOrUpdateCredential(WebhookPayload payload)
                           throws CredentialsConvertionException

Add or update a credential from a webhook payload.

Parameters:

payload - the webhook payload

Throws:

CredentialsConvertionException - if the payload cannot be converted to a credential

getAllWebhookCredentials

public List<com.cloudbees.plugins.credentials.common.IdCredentials> getAllWebhookCredentials()

Get all webhook credentials.

Returns:

a list of all webhook sourced credentials

getInstance

public static WebhookCredentialsProvider getInstance()

Get the singleton instance of this provider.

Returns:

the webhook credentials provider instance

getIconClassName

public String getIconClassName()

Specified by:

getIconClassName in interface IconSpec

Overrides:

getIconClassName in class com.cloudbees.plugins.credentials.CredentialsProvider