Class FolderAzureCredentialsProvider

java.lang.Object
hudson.model.Descriptor<com.cloudbees.plugins.credentials.CredentialsProvider>
com.cloudbees.plugins.credentials.CredentialsProvider
org.jenkinsci.plugins.azurekeyvaultplugin.provider.BaseAzureKeyVaultCredentialsProvider
org.jenkinsci.plugins.azurekeyvaultplugin.provider.folder.FolderAzureCredentialsProvider
All Implemented Interfaces:
ExtensionPoint, Describable<com.cloudbees.plugins.credentials.CredentialsProvider>, Saveable, Loadable, OnMaster, IconSpec

@OptionalExtension(requirePlugins="cloudbees-folder", ordinal=1.0) public class FolderAzureCredentialsProvider extends BaseAzureKeyVaultCredentialsProvider
Serves credentials from a Key Vault configured on a folder to the items in that folder and its sub-folders.

Lookups walk from the requesting context up through its parent folders. When the same credential ID is defined in more than one folder the nearest folder wins, matching the folder credentials provider in cloudbees-folder. Secrets tagged with the SYSTEM scope are ignored, as there is no Jenkins-internal context inside a folder for them to be used in.

The provider is ordered before AzureCredentialsProvider, so a folder's vault also wins over the global vault when both define the same ID.

  • Constructor Details

    • FolderAzureCredentialsProvider

      public FolderAzureCredentialsProvider()
  • Method Details

    • get

      public static FolderAzureCredentialsProvider get()
    • refreshCredentials

      public void refreshCredentials()
    • refreshCredentials

      public void refreshCredentials(@NonNull String folderFullName)
      Drops the cached credentials of a folder and everything beneath it.
    • getCredentialsInItemGroup

      @NonNull public <C extends com.cloudbees.plugins.credentials.Credentials> 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
    • getCredentialsInItem

      @NonNull public <C extends com.cloudbees.plugins.credentials.Credentials> List<C> getCredentialsInItem(@NonNull Class<C> type, @NonNull Item item, @Nullable org.springframework.security.core.Authentication authentication, @NonNull List<com.cloudbees.plugins.credentials.domains.DomainRequirement> domainRequirements)
      Overrides:
      getCredentialsInItem in class com.cloudbees.plugins.credentials.CredentialsProvider
    • getCredentialByIdInItemGroup

      @CheckForNull public <C extends com.cloudbees.plugins.credentials.common.IdCredentials> C getCredentialByIdInItemGroup(@NonNull String id, @NonNull Class<C> type, @NonNull ItemGroup<?> itemGroup, @Nullable org.springframework.security.core.Authentication authentication, @NonNull List<com.cloudbees.plugins.credentials.domains.DomainRequirement> domainRequirements)
      Overrides:
      getCredentialByIdInItemGroup in class com.cloudbees.plugins.credentials.CredentialsProvider
    • getCredentialByIdInItem

      @CheckForNull public <C extends com.cloudbees.plugins.credentials.common.IdCredentials> C getCredentialByIdInItem(@NonNull String id, @NonNull Class<C> type, @NonNull Item item, @Nullable org.springframework.security.core.Authentication authentication, @NonNull List<com.cloudbees.plugins.credentials.domains.DomainRequirement> domainRequirements)
      Overrides:
      getCredentialByIdInItem in class com.cloudbees.plugins.credentials.CredentialsProvider
    • getStore

      public com.cloudbees.plugins.credentials.CredentialsStore getStore(ModelObject object)
      Overrides:
      getStore in class com.cloudbees.plugins.credentials.CredentialsProvider