org.keycloak.vault

Class DefaultVaultCharSecret

java.lang.Object

org.keycloak.vault.DefaultVaultCharSecret

All Implemented Interfaces:

AutoCloseable, VaultCharSecret

public class DefaultVaultCharSecret
extends Object
implements VaultCharSecret

Default VaultCharSecret implementation based on CharBuffer.

Author:

Stefan Guilhen

Method Summary

Modifier and Type	Method and Description
void	close() Destroys the secret in memory by e.g.
static VaultCharSecret	forBuffer(Optional<CharBuffer> buffer)
Optional<CharBuffer>	get() Returns the secret enclosed in a CharBuffer.
Optional<char[]>	getAsArray() Returns the secret in its char[] form.

Methods inherited from class java.lang.Object

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

Method Detail

forBuffer

public static VaultCharSecret forBuffer(Optional<CharBuffer> buffer)

get

public Optional<CharBuffer> get()

Description copied from interface: VaultCharSecret

Returns the secret enclosed in a CharBuffer.

Specified by:

get in interface VaultCharSecret

Returns:

If the secret was successfully resolved by vault, returns an Optional containing the value returned by the vault as a CharBuffer (a valid value can be null), or an empty Optional

getAsArray

public Optional<char[]> getAsArray()

Description copied from interface: VaultCharSecret

Returns the secret in its char[] form.

Specified by:

getAsArray in interface VaultCharSecret

Returns:

If the secret was successfully resolved by vault, returns an Optional containing the value returned by the vault as a char[] (a valid value can be null), or an empty Optional.

close

public void close()

Description copied from interface: VaultCharSecret

Destroys the secret in memory by e.g. overwriting it with random garbage.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface VaultCharSecret