Extension Points defined in Credentials Plugin

Credentials

jenkinsdoc:credentials:com.cloudbees.plugins.credentials.Credentials]

A generic type of credentials. In general please extend from jenkinsdoc:BaseCredentials] rather than implement this interface. The interface is provided:

  1. To allow for orthogonal traits to be built up in interfaces that extend credentials, e.g. username/password vs username/ssh-key vs email/password - a single credentials impl could provide all four fields and different credentials consumers might request the different flavours
  2. In order to facility cases where it is just not possible to change the base class when retrofitting support for credentials into an existing plugin.

Implementations:

CredentialsProvider

jenkinsdoc:credentials:com.cloudbees.plugins.credentials.CredentialsProvider]

An extension point for providing jenkinsdoc:Credentials] .

Implementations:

CredentialsProviderFilter

jenkinsdoc:credentials:com.cloudbees.plugins.credentials.CredentialsProviderFilter]

A filter of jenkinsdoc:CredentialsProvider] instances used by jenkinsdoc:CredentialsProviderManager] to determine which providers are active.

Implementations:

CredentialsProviderTypeRestriction

jenkinsdoc:credentials:com.cloudbees.plugins.credentials.CredentialsProviderTypeRestriction]

A filter of jenkinsdoc:CredentialsDescriptor] types scoped to specific jenkinsdoc:CredentialsProvider] instances used by jenkinsdoc:CredentialsProviderManager] to determine which types are applicable to each provider.

Implementations:

CredentialsSelectHelper.ContextResolver

jenkinsdoc:credentials:com.cloudbees.plugins.credentials.CredentialsSelectHelper.ContextResolver]

An extension point to allow plugging in additional resolution of jenkinsdoc:ModelObject] instances.

Implementations:

CredentialsSnapshotTaker

jenkinsdoc:credentials:com.cloudbees.plugins.credentials.CredentialsSnapshotTaker]

Some credential types can store some of the credential details in a file outside of Jenkins. Taking a snapshot of the credential ensures that all the details are captured within the credential. For example jenkinsdoc:com.cloudbees.plugins.credentials.impl.CertificateCredentialsImpl] can use different keystores implementations to hold the certificate. Calling jenkinsdoc:=snapshot(Credentials)] resolve the actual source into a source like jenkinsdoc:com.cloudbees.plugins.credentials.impl.CertificateCredentialsImpl.UploadedKeyStoreSource] which is self contained.

Implementations:

CredentialsTypeFilter

jenkinsdoc:credentials:com.cloudbees.plugins.credentials.CredentialsTypeFilter]

A filter of jenkinsdoc:CredentialsDescriptor] types used by jenkinsdoc:CredentialsProviderManager] to determine which types are active.

Implementations:

CredentialsUseListener

jenkinsdoc:credentials:com.cloudbees.plugins.credentials.CredentialsUseListener]

A Listener to track jenkinsdoc:Credentials] usage.

Implementations:

DomainRequirement

jenkinsdoc:credentials:com.cloudbees.plugins.credentials.domains.DomainRequirement]

Base class for all requirements that can be fulfilled by jenkinsdoc:Domain] s.

Implementations:

DomainSpecification

jenkinsdoc:credentials:com.cloudbees.plugins.credentials.domains.DomainSpecification]

Base class for a specification against which jenkinsdoc:DomainRequirement] s can be tested.

Implementations: