io.alauda.jenkins.plugins.credentials

类 SecretUtils

java.lang.Object

io.alauda.jenkins.plugins.credentials.SecretUtils

public abstract class SecretUtils
extends Object

Collection of utilities for working with V1Secrets. Note: API may be subject to change.

字段概要

字段

限定符和类型	字段和说明
static String	JENKINS_IO_CREDENTIALS_TYPE_LABEL

构造器概要

构造器

构造器和说明
SecretUtils()

方法概要

限定符和类型	方法和说明
static byte[]	base64Decode(String s) Convert a String representation of the base64 encoded bytes back to a byte[].
static String	base64DecodeToString(String s) Convert a String representation of the base64 encoded bytes of a UTF-8 String back to a String.
static String	getCredentialDescription(io.kubernetes.client.models.V1ObjectMeta meta)
static String	getCredentialDescription(io.kubernetes.client.models.V1Secret s) Obtain the credential description from a given Secret.
static String	getCredentialId(io.kubernetes.client.models.V1ObjectMeta meta)
static String	getCredentialId(io.kubernetes.client.models.V1Secret s) Obtain the credential ID from a given Secret.
static String	getKeyName(io.kubernetes.client.models.V1Secret s, String key) Get the mapping for the specified key name.
static String	getNonNullSecretData(io.kubernetes.client.models.V1Secret s, String key, String exceptionMessage) Get the data for the specified key (or the mapped key if key is mapped), or throw a CredentialsConversionException if the data for the given key was not present..
static Optional<String>	getOptionalSecretData(io.kubernetes.client.models.V1Secret s, String key, String exceptionMessage) Get optional data for the specified key (or the mapped key if key is mapped)
static <T> T	requireNonNull(T obj, String exceptionMessage) Checks that obj is not null.
static <T> T	requireNonNull(T obj, String exceptionMessage, String mapped) Checks that obj is not null.

从类继承的方法 java.lang.Object

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

字段详细资料

JENKINS_IO_CREDENTIALS_TYPE_LABEL

public static final String JENKINS_IO_CREDENTIALS_TYPE_LABEL

另请参阅:

常量字段值

构造器详细资料

SecretUtils

public SecretUtils()

方法详细资料

base64DecodeToString

@CheckForNull
 @Restricted(value=org.kohsuke.accmod.restrictions.NoExternalUse.class)
public static String base64DecodeToString(String s)

Convert a String representation of the base64 encoded bytes of a UTF-8 String back to a String.

参数:

s - the base64 encoded String representation of the bytes.

返回:

the String or null if the string could not be converted.

base64Decode

@CheckForNull
 @Restricted(value=org.kohsuke.accmod.restrictions.NoExternalUse.class)
public static byte[] base64Decode(String s)

Convert a String representation of the base64 encoded bytes back to a byte[].

参数:

s - the base64 encoded representation of the bytes.

返回:

the byte[] or null if the string could not be converted.

getCredentialId

public static String getCredentialId(io.kubernetes.client.models.V1Secret s)

Obtain the credential ID from a given Secret.

参数:

s - the secret whose id we want to obtain.

返回:

the credential ID for a given secret.

getCredentialId

public static String getCredentialId(io.kubernetes.client.models.V1ObjectMeta meta)

getCredentialDescription

@CheckForNull
public static String getCredentialDescription(io.kubernetes.client.models.V1Secret s)

Obtain the credential description from a given Secret.

参数:

s - the secret whose description we want to obtain.

返回:

the credential description for a given secret.

getCredentialDescription

public static String getCredentialDescription(io.kubernetes.client.models.V1ObjectMeta meta)

requireNonNull

public static <T> T requireNonNull(@Nullable
                                   T obj,
                                   String exceptionMessage)
                            throws CredentialsConversionException

Checks that obj is not null.

类型参数:

T - the type of the obj.

参数:

obj - the Object to check for null.

exceptionMessage - detail message to be used in the event that a CredentialsConversionException is thrown.

返回:

obj if not null.

抛出:

CredentialsConversionException - iff obj is null.

requireNonNull

public static <T> T requireNonNull(@Nullable
                                   T obj,
                                   String exceptionMessage,
                                   @Nullable
                                   String mapped)
                            throws CredentialsConversionException

Checks that obj is not null.

类型参数:

T - the type of the obj.

参数:

obj - the Object to check for null.

exceptionMessage - detail message to be used in the event that a CredentialsConversionException is thrown.

mapped - an optional mapping (adds a "mapped to " + mapped to the exception message if this is non null.

返回:

obj if not null.

抛出:

CredentialsConversionException - iff obj is null.

getNonNullSecretData

public static String getNonNullSecretData(io.kubernetes.client.models.V1Secret s,
                                          String key,
                                          String exceptionMessage)
                                   throws CredentialsConversionException

Get the data for the specified key (or the mapped key if key is mapped), or throw a CredentialsConversionException if the data for the given key was not present..

参数:

s - the Secret

key - the key to get the data for (which may be mapped to another key).

exceptionMessage - the detailMessage of the exception if the data for the key (or mapped key) was not present.

返回:

The data for the given key.

抛出:

CredentialsConversionException - if the data was not present.

getOptionalSecretData

public static Optional<String> getOptionalSecretData(io.kubernetes.client.models.V1Secret s,
                                                     String key,
                                                     String exceptionMessage)
                                              throws CredentialsConversionException

Get optional data for the specified key (or the mapped key if key is mapped)

参数:

s - the Secret

key - the key to get the data for (which may be mapped to another key).

exceptionMessage - the detailMessage of the exception if the data for the key (or mapped key) was not present.

返回:

Optional data for specified key

抛出:

CredentialsConversionException - if the data was not present.

getKeyName

public static String getKeyName(io.kubernetes.client.models.V1Secret s,
                                String key)

Get the mapping for the specified key name. Secrets can override the defaults used by the plugin by specifying an attribute of the type jenkins.io/credentials-keybinding-name containing the custom name - for example jenkins.io/credentials-keybinding-foo=wibble.

参数:

s - the secret to inspect for a custom name.

key - the name of the key we are looking for.

返回:

the custom mapping for the key or key (identical object) if there is no custom mapping.