Package org.jenkinsci.plugins.azurekeyvaultplugin.credentials

Class AzureKeyVaultSecretContext

java.lang.Object

org.jenkinsci.plugins.azurekeyvaultplugin.credentials.AzureKeyVaultSecretContext

public final class AzureKeyVaultSecretContext
extends Object

A Key Vault secret being adapted to a credential by an AzureKeyVaultCredentialsAdapter.

The common tags (jenkinsID, description, scope) have already been resolved.

Constructor Summary

Constructors

Constructor	Description
AzureKeyVaultSecretContext(com.cloudbees.plugins.credentials.CredentialsScope scope, String id, String description, String secretName, Map<String,String> tags, Supplier<Secret> secret, Function<String,Supplier<Secret>> secretLookup)

Method Summary

Modifier and Type	Method	Description
String	getDescription()
String	getId()
com.cloudbees.plugins.credentials.CredentialsScope	getScope()
Supplier<Secret>	getSecret()
Supplier<Secret>	getSecret(String secretName)
String	getSecretName()
String	getTag(String name)

Methods inherited from class java.lang.Object

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

Constructor Details

AzureKeyVaultSecretContext

public AzureKeyVaultSecretContext(@NonNull
 com.cloudbees.plugins.credentials.CredentialsScope scope,
 @NonNull
 String id,
 @NonNull
 String description,
 @NonNull
 String secretName,
 @NonNull
 Map<String,String> tags,
 @NonNull
 Supplier<Secret> secret,
 @NonNull
 Function<String,Supplier<Secret>> secretLookup)

Method Details

getScope

@NonNull
public com.cloudbees.plugins.credentials.CredentialsScope getScope()

getId

@NonNull
public String getId()

Returns:

the Jenkins credential ID, from the jenkinsID tag or else the secret name

getDescription

@NonNull
public String getDescription()

getSecretName

@NonNull
public String getSecretName()

Returns:

the name of the secret in the vault

getTag

@CheckForNull
public String getTag(@NonNull
 String name)

getSecret

@NonNull
public Supplier<Secret> getSecret()

Returns:

a supplier that reads this secret's value from the vault on every Supplier.get()

getSecret

@NonNull
public Supplier<Secret> getSecret(@NonNull
 String secretName)

Parameters:

secretName - the name of another secret in the same vault, e.g. from a passphrase-id tag

Returns:

a supplier that reads that secret's value from the vault on every Supplier.get()