Package dev.galasa

Interface ICredentialsOpaque

All Superinterfaces:

ICredentials

All Known Implementing Classes:

CredentialsOpaque

public interface ICredentialsOpaque
extends ICredentials

Represents credentials of type Opaque in the Galasa Credentials Store.

An opaque secret holds a single, opaque blob of data whose internal structure is not interpreted by the framework. Typical uses include licence JAR files, DER-encoded certificates, or any other binary payload that a manager needs at runtime.

When stored in the Credentials Store the value is base64-encoded and held under a .data property key. The same base64-encoded value is surfaced in the opaqueData field of the GalasaSecretData REST response.

See Also:

• ICredentials

Method Summary

Modifier and Type	Method	Description
byte[]	getData()	Returns the raw bytes of the opaque credential.
String	getEncodedData()	Returns the opaque content as a base64-encoded string.

Methods inherited from interface dev.galasa.ICredentials

getDescription, getLastUpdatedByUser, getLastUpdatedTime, getMetadataProperties, setDescription, setLastUpdatedByUser, setLastUpdatedTime, toProperties

Method Details

getData

byte[] getData()

Returns the raw bytes of the opaque credential.

The returned array is decoded from the base64 value that was supplied when the secret was created (via --secret-file or --base64-secret).

Returns:

the opaque content as a byte array; never null

getEncodedData

String getEncodedData()

Returns the opaque content as a base64-encoded string.

This is the stored base64 value and is returned as-is in the opaqueData field of the GET /secrets/{name} REST response. Callers can base64-decode it once to obtain the original raw bytes.

Returns:

base64-encoded representation of the opaque data; never null