Package com.datapipe.jenkins.vault.credentials.common

Class AbstractVaultBaseStandardCredentials

java.lang.Object

com.cloudbees.plugins.credentials.BaseCredentials

com.cloudbees.plugins.credentials.impl.BaseStandardCredentials

com.datapipe.jenkins.vault.credentials.common.AbstractVaultBaseStandardCredentials

All Implemented Interfaces:

com.cloudbees.plugins.credentials.common.IdCredentials, com.cloudbees.plugins.credentials.common.StandardCredentials, com.cloudbees.plugins.credentials.Credentials, ExtensionPoint, Describable<com.cloudbees.plugins.credentials.Credentials>, Serializable

Direct Known Subclasses:

VaultCertificateCredentialsImpl, VaultFileCredentialImpl, VaultGCRLoginImpl, VaultSSHUserPrivateKeyImpl, VaultStringCredentialImpl, VaultUsernamePasswordCredentialImpl

public abstract class AbstractVaultBaseStandardCredentials
extends com.cloudbees.plugins.credentials.impl.BaseStandardCredentials

Base Vault credentials that contain a path, prefixPath, namespace, and engineVersion.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.cloudbees.plugins.credentials.impl.BaseStandardCredentials

com.cloudbees.plugins.credentials.impl.BaseStandardCredentials.BaseStandardCredentialsDescriptor

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Nested classes/interfaces inherited from interface com.cloudbees.plugins.credentials.common.IdCredentials

com.cloudbees.plugins.credentials.common.IdCredentials.Helpers

Nested classes/interfaces inherited from interface com.cloudbees.plugins.credentials.common.StandardCredentials

com.cloudbees.plugins.credentials.common.StandardCredentials.NameProvider

Method Summary

Modifier and Type	Method	Description
ItemGroup	getContext()
String	getDisplayName()	Get credential display name.
Integer	getEngineVersion()
String	getNamespace()
String	getPath()
String	getPrefixPath()
protected String	getVaultSecretKeyValue(String key)	Look up secret key value.
protected Map<String,String>	getVaultSecretValue()	Look up the secret key:value map.
void	setContext(ItemGroup context)
void	setEngineVersion(Integer engineVersion)
void	setNamespace(String namespace)
void	setPath(String path)
void	setPrefixPath(String prefixPath)

Methods inherited from class com.cloudbees.plugins.credentials.impl.BaseStandardCredentials

equals, getDescription, getId, hashCode

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

getDescriptor, getScope

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.cloudbees.plugins.credentials.Credentials

getDescriptor, getScope

Method Detail

getPrefixPath

@NonNull
public String getPrefixPath()

setPrefixPath

@DataBoundSetter
public void setPrefixPath(String prefixPath)

getPath

@NonNull
public String getPath()

setPath

@DataBoundSetter
public void setPath(String path)

getNamespace

@CheckForNull
public String getNamespace()

setNamespace

@DataBoundSetter
public void setNamespace(String namespace)

getEngineVersion

@CheckForNull
public Integer getEngineVersion()

setEngineVersion

@DataBoundSetter
public void setEngineVersion(Integer engineVersion)

setContext

public void setContext(@NonNull
                       ItemGroup context)

getContext

public ItemGroup getContext()

getVaultSecretKeyValue

@NonNull
protected String getVaultSecretKeyValue(String key)

Look up secret key value.

Parameters:

key - secret key name

Returns:

vault secret value

getVaultSecretValue

@NonNull
protected Map<String,String> getVaultSecretValue()

Look up the secret key:value map.

Returns:

vault secret value

getDisplayName

public String getDisplayName()

Get credential display name. Defaults to secret path.

Returns:

display name