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.
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final classExpose the store.static classstatic classDrops cached credentials when a folder is reconfigured, moved or deleted, so a stale vault isn't used.Nested classes/interfaces inherited from class hudson.model.Descriptor
Descriptor.FormException, Descriptor.PropertyType, Descriptor.SelfNested 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, VIEWFields inherited from class hudson.model.Descriptor
clazz -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionget()<C extends com.cloudbees.plugins.credentials.common.IdCredentials>
CgetCredentialByIdInItem(String id, Class<C> type, Item item, org.springframework.security.core.Authentication authentication, List<com.cloudbees.plugins.credentials.domains.DomainRequirement> domainRequirements) <C extends com.cloudbees.plugins.credentials.common.IdCredentials>
CgetCredentialByIdInItemGroup(String id, Class<C> type, ItemGroup<?> itemGroup, org.springframework.security.core.Authentication authentication, List<com.cloudbees.plugins.credentials.domains.DomainRequirement> domainRequirements) <C extends com.cloudbees.plugins.credentials.Credentials>
List<C> getCredentialsInItem(Class<C> type, Item item, org.springframework.security.core.Authentication authentication, List<com.cloudbees.plugins.credentials.domains.DomainRequirement> domainRequirements) <C extends com.cloudbees.plugins.credentials.Credentials>
List<C> getCredentialsInItemGroup(Class<C> type, ItemGroup itemGroup, org.springframework.security.core.Authentication authentication, List<com.cloudbees.plugins.credentials.domains.DomainRequirement> domainRequirements) com.cloudbees.plugins.credentials.CredentialsStoregetStore(ModelObject object) voidvoidrefreshCredentials(String folderFullName) Drops the cached credentials of a folder and everything beneath it.Methods inherited from class org.jenkinsci.plugins.azurekeyvaultplugin.provider.BaseAzureKeyVaultCredentialsProvider
credentialsLoader, getIconClassName, isAzureKeyVaultProvider, isLookupSupported, newCacheBuilderMethods inherited from class com.cloudbees.plugins.credentials.CredentialsProvider
_isApplicable, all, allCredentialsDescriptors, enabled, enabled, findCredentialById, findCredentialById, findCredentialById, findCredentialByIdInItem, findCredentialByIdInItemGroup, getCredentialIds, getCredentialIds, getCredentialIdsInItem, getCredentialIdsInItemGroup, getCredentials, getCredentials, getCredentials, getCredentials, getCredentialsDescriptors, 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, trackAllMethods 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
-
Constructor Details
-
FolderAzureCredentialsProvider
public FolderAzureCredentialsProvider()
-
-
Method Details
-
get
-
refreshCredentials
public void refreshCredentials() -
refreshCredentials
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:
getCredentialsInItemGroupin classcom.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:
getCredentialsInItemin classcom.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:
getCredentialByIdInItemGroupin classcom.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:
getCredentialByIdInItemin classcom.cloudbees.plugins.credentials.CredentialsProvider
-
getStore
- Overrides:
getStorein classcom.cloudbees.plugins.credentials.CredentialsProvider
-