Package io.cui.tools.net.ssl

Class KeyMaterialHolder

java.lang.Object

io.cui.tools.net.ssl.KeyMaterialHolder

All Implemented Interfaces:

Serializable

public final class KeyMaterialHolder
extends Object
implements Serializable

Runtime representation of key-material. The actual key is provided as byte[]. An optional keyPassword is available as well.

Author:

Oliver Wolff

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	KeyMaterialHolder.KeyMaterialHolderBuilder

Method Summary

Modifier and Type	Method	Description
static KeyMaterialHolder.KeyMaterialHolderBuilder	builder()
static byte[]	deserializeKeyMaterial(String serializedKeyMaterial)
boolean	equals(Object o)
String	getDescription()	Optional: additional information transporting some context-information.
KeyAlgorithm	getKeyAlgorithm()
String	getKeyAlias()	Optional: An alias name for a given key.
KeyHolderType	getKeyHolderType()
@lombok.NonNull byte[]	getKeyMaterial()
String	getKeyPassword()	(Optional) password for the key, or in case of KeyHolderType.KEY_STORE for the store.
char[]	getKeyPasswordAsCharArray()
String	getName()	Optional: An arbitrary name for displaying the key in an ui or logging context.
int	hashCode()
static String	serializeKeyMaterial(byte[] keyMaterial)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

getKeyPasswordAsCharArray

public char[] getKeyPasswordAsCharArray()

Returns:

NPE-safe char-array representation of getKeyPassword(). If keyPassword is null or empty it returns an empty char[], never null

deserializeKeyMaterial

public static byte[] deserializeKeyMaterial(String serializedKeyMaterial)

Parameters:

serializedKeyMaterial - the Base64 encoded key material

Returns:

Raw i.e. original key material

Throws:

IllegalArgumentException - if serializedKeyMaterial is not Base64 encoded

serializeKeyMaterial

public static String serializeKeyMaterial(byte[] keyMaterial)

Parameters:

keyMaterial - Raw i.e. original key material

Returns:

Base64 encoded key material

builder

public static KeyMaterialHolder.KeyMaterialHolderBuilder builder()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

getKeyMaterial

@NonNull
public @lombok.NonNull byte[] getKeyMaterial()

getKeyPassword

public String getKeyPassword()

(Optional) password for the key, or in case of KeyHolderType.KEY_STORE for the store.

getName

public String getName()

Optional: An arbitrary name for displaying the key in an ui or logging context.

getDescription

public String getDescription()

Optional: additional information transporting some context-information.

getKeyAlias

public String getKeyAlias()

Optional: An alias name for a given key.

getKeyHolderType

public KeyHolderType getKeyHolderType()

getKeyAlgorithm

public KeyAlgorithm getKeyAlgorithm()