Uses of Class
org.forgerock.secrets.SecretBuilder

Packages that use SecretBuilder

Package	Description
org.forgerock.json.jose.jwk	Classes and interfaces for creating and manipulating JWKs.
org.forgerock.secrets	Provides a unified API for accessing secrets of various kinds.
org.forgerock.secrets.gcpkms	A secret store implementation that can retrieve keys from a Google Cloud Platform Key Management Service.
org.forgerock.secrets.keys	Contains cryptographic key related API objects.
org.forgerock.secrets.propertyresolver	Provides a SecretStore implementation that loads secrets from a Common Configuration PropertyResolver and then decodes it with a SecretPropertyFormat.
org.forgerock.secrets.vault	Secrets backend that reads secrets from a remote Hashicorp Vault server.

Uses of SecretBuilder in org.forgerock.json.jose.jwk

Methods in org.forgerock.json.jose.jwk that return SecretBuilder

Modifier and Type	Method	Description
SecretBuilder	JWK.toSecretBuilder()	Get a SecretBuilder capable of building a Secret subclass object from this JWK.

Uses of SecretBuilder in org.forgerock.secrets

Methods in org.forgerock.secrets that return SecretBuilder

Modifier and Type	Method	Description
SecretBuilder	SecretBuilder.allowedAlgorithms(Collection<String> allowedAlgorithms)	Sets the cryptographic algorithms that can be used with this key.
SecretBuilder	SecretBuilder.allowedAlgorithms(Predicate<String> allowedAlgorithmsTest)	Sets the cryptographic algorithms that can be used with this key.
SecretBuilder	SecretBuilder.certificate(Certificate certificate)	Sets the certificate associated with this secret.
SecretBuilder	SecretBuilder.certificateChain(Certificate... chain)	Sets the certificate chain associated with this secret.
SecretBuilder	SecretBuilder.certificateChain(List<? extends Certificate> chain)	Sets the certificate chain associated with this secret.
SecretBuilder	SecretBuilder.clock(Clock clock)	Set the source of time for the default (relative) secret expiry time.
SecretBuilder	SecretBuilder.combine(SecretBuilder that)	Returns a fresh SecretBuilder that combines the data from this secret builder and the argument.
SecretBuilder	SecretBuilder.expiresAt(Instant expiry)	Sets the secret to expire at the given time.
SecretBuilder	SecretBuilder.expiresIn(long deadline, TemporalUnit unit, Clock clock)	Sets the secret to expire in deadline units from now.
SecretBuilder	SecretBuilder.keyUsages(Set<KeyUsage> keyUsages)	Sets the allowed key usages for this key.
SecretBuilder	SecretBuilder.password(char[] password)	Sets the raw data of this secret object to the UTF-8 bytes of the given password.
SecretBuilder	SecretBuilder.provider(Provider provider)	Sets the provider associated with this secret.
SecretBuilder	SecretBuilder.publicKey(PublicKey key)	Sets the public key associated with this secret.
SecretBuilder	SecretBuilder.rawData(byte[] rawData)	Sets the raw data of the secret object.
SecretBuilder	SecretBuilder.secretKey(Key key)	Sets the secret key for this object.
SecretBuilder	SecretBuilder.stableId(String id)	Sets the stable id of this secret.

Methods in org.forgerock.secrets that return types with arguments of type SecretBuilder

Modifier and Type	Method	Description
Promise<SecretBuilder,NoSuchSecretException>	SecretDecoder.decodeToPromise(byte[] data)	Decodes the raw data retrieved from a backend into a SecretBuilder for further processing.

Methods in org.forgerock.secrets with parameters of type SecretBuilder

Modifier and Type	Method	Description
SecretBuilder	SecretBuilder.combine(SecretBuilder that)	Returns a fresh SecretBuilder that combines the data from this secret builder and the argument.

Constructors in org.forgerock.secrets with parameters of type SecretBuilder

Modifier	Constructor	Description
	GenericSecret(SecretBuilder builder)	Constructs a generic secret with the given stable identifier and secret data.
protected	Secret(SecretBuilder builder)	Constructs the secret using the given builder.

Uses of SecretBuilder in org.forgerock.secrets.gcpkms

Methods in org.forgerock.secrets.gcpkms that return SecretBuilder

Modifier and Type	Method	Description
SecretBuilder	GoogleKmsEncryptedPropertyFormat.decode(String propertyValue)

Methods in org.forgerock.secrets.gcpkms that return types with arguments of type SecretBuilder

Modifier and Type	Method	Description
Promise<SecretBuilder,NoSuchSecretException>	GoogleKmsEncryptedPropertyFormat.decodeToPromise(String propertyValue)

Uses of SecretBuilder in org.forgerock.secrets.keys

Methods in org.forgerock.secrets.keys that return SecretBuilder

Modifier and Type	Method	Description
SecretBuilder	CryptoKey.toBuilder()	Converts the key back into a SecretBuilder, pre-initialized with the fields of this CryptoKey object.

Constructors in org.forgerock.secrets.keys with parameters of type SecretBuilder

Modifier	Constructor	Description
	CertificateVerificationKey(SecretBuilder builder)	Initialises the key with the given secret data.
	DataDecryptionKey(SecretBuilder builder)	Initialises the key with the given secret data.
	DataEncryptionKey(SecretBuilder builder)	Initialises the key with the given secret data.
	KeyAgreementKey(SecretBuilder builder)	Initialises the key with the given secret data.
	KeyDecryptionKey(SecretBuilder builder)	Initialises the key with the given secret data.
	KeyEncryptionKey(SecretBuilder builder)	Initialises the key with the given secret data.
	SigningKey(SecretBuilder builder)	Initialises the key with the given secret data.
	VerificationKey(SecretBuilder builder)	Initialises the key with the given secret data.

Uses of SecretBuilder in org.forgerock.secrets.propertyresolver

Methods in org.forgerock.secrets.propertyresolver that return SecretBuilder

Modifier and Type	Method	Description
SecretBuilder	JwkPropertyFormat.decode(String propertyValue)
SecretBuilder	PemPropertyFormat.decode(String propertyValue)
SecretBuilder	PropertyFormatBase64.decode(String propertyValue)
SecretBuilder	SecretKeyPropertyFormat.decode(String propertyValue)
SecretBuilder	SecretPropertyFormat.decode(String propertyValue)	Decodes the input property value, setting relevant properties on a SecretBuilder object.

Methods in org.forgerock.secrets.propertyresolver that return types with arguments of type SecretBuilder

Modifier and Type	Method	Description
Promise<SecretBuilder,NoSuchSecretException>	PemPropertyFormat.decodeToPromise(String propertyValue)
default Promise<SecretBuilder,NoSuchSecretException>	SecretPropertyFormat.decodeToPromise(byte[] data)	Decodes the data as a UTF-8 string and then calls SecretPropertyFormat.decodeToPromise(String) to decode the string value.
default Promise<SecretBuilder,NoSuchSecretException>	SecretPropertyFormat.decodeToPromise(String propertyValue)	Decodes the input property value, setting relevant properties on a SecretBuilder object.

Constructor parameters in org.forgerock.secrets.propertyresolver with type arguments of type SecretBuilder

Modifier	Constructor	Description
	PemPropertyFormat(Supplier<SecretBuilder> secretBuilderSupplier)	Initializes the property format without any support for decrypting private key files.
	PemPropertyFormat(SecretsProvider secretsProvider, Purpose<GenericSecret> decryptionPasswordPurpose, Supplier<SecretBuilder> secretBuilderSupplier)	Initializes the property format with the given secrets provider and purpose for decrypting password-encrypted PEM files.

Uses of SecretBuilder in org.forgerock.secrets.vault

Methods in org.forgerock.secrets.vault that return types with arguments of type SecretBuilder

Modifier and Type	Method	Description
Promise<SecretBuilder,NoSuchSecretException>	VaultKeyValueSecretStore.SecretFieldDecoder.apply(SecretBuilder secretBuilder, JsonValue jsonValue)	Decodes a JSON value into one or more fields on a SecretBuilder.

Methods in org.forgerock.secrets.vault with parameters of type SecretBuilder

Modifier and Type	Method	Description
Promise<SecretBuilder,NoSuchSecretException>	VaultKeyValueSecretStore.SecretFieldDecoder.apply(SecretBuilder secretBuilder, JsonValue jsonValue)	Decodes a JSON value into one or more fields on a SecretBuilder.