Package com.datapipe.jenkins.vault.credentials

Class VaultAppRoleCredential

java.lang.Object

com.cloudbees.plugins.credentials.BaseCredentials

com.cloudbees.plugins.credentials.impl.BaseStandardCredentials

com.datapipe.jenkins.vault.credentials.AbstractVaultTokenCredential

com.datapipe.jenkins.vault.credentials.AbstractVaultTokenCredentialWithExpiration

com.datapipe.jenkins.vault.credentials.AbstractAuthenticatingVaultTokenCredential

com.datapipe.jenkins.vault.credentials.VaultAppRoleCredential

All Implemented Interfaces:

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

public class VaultAppRoleCredential
extends AbstractAuthenticatingVaultTokenCredential

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VaultAppRoleCredential.DescriptorImpl

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

Nested classes/interfaces inherited from interface com.datapipe.jenkins.vault.credentials.VaultCredential

VaultCredential.NameProvider

Field Summary

Fields inherited from class com.datapipe.jenkins.vault.credentials.AbstractVaultTokenCredentialWithExpiration

LOGGER

Constructor Summary

Constructors

Constructor	Description
VaultAppRoleCredential(com.cloudbees.plugins.credentials.CredentialsScope scope, String id, String description, String roleId, Secret secretId, String path)

Method Summary

Modifier and Type	Method	Description
String	getPath()
String	getRoleId()
Secret	getSecretId()
String	getToken(com.bettercloud.vault.api.Auth auth)	Authenticate with vault using this credential and return the token.
protected Object	readResolve()

Methods inherited from class com.datapipe.jenkins.vault.credentials.AbstractAuthenticatingVaultTokenCredential

getNamespace, getToken, getVaultAuth, setNamespace

Methods inherited from class com.datapipe.jenkins.vault.credentials.AbstractVaultTokenCredentialWithExpiration

authorizeWithVault, getChildToken, getUsePolicies, getVault, setUsePolicies

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

Methods inherited from interface com.cloudbees.plugins.credentials.common.IdCredentials

getId

Methods inherited from interface com.cloudbees.plugins.credentials.common.StandardCredentials

getDescription

Constructor Detail

VaultAppRoleCredential

@DataBoundConstructor
public VaultAppRoleCredential(@CheckForNull
                              com.cloudbees.plugins.credentials.CredentialsScope scope,
                              @CheckForNull
                              String id,
                              @CheckForNull
                              String description,
                              @NonNull
                              String roleId,
                              @NonNull
                              Secret secretId,
                              String path)

Method Detail

getRoleId

@NonNull
public String getRoleId()

getSecretId

@NonNull
public Secret getSecretId()

getPath

public String getPath()

getToken

public String getToken(com.bettercloud.vault.api.Auth auth)

Description copied from class: AbstractAuthenticatingVaultTokenCredential

Authenticate with vault using this credential and return the token. The auth client will be configured with this credentials namespace.

Specified by:

getToken in class AbstractAuthenticatingVaultTokenCredential

Parameters:

auth - vault auth client

Returns:

authentication token

readResolve

protected Object readResolve()