com.solidfire.element.api

Class KeyServerKmip

java.lang.Object

com.solidfire.element.api.KeyServerKmip

All Implemented Interfaces:

java.io.Serializable

public class KeyServerKmip
extends java.lang.Object
implements java.io.Serializable

KeyServerKmip A KMIP (Key Management Interoperability Protocol) Key Server describes a location for retrieving authentication keys for use with cluster features such as Encryption At Rest.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	KeyServerKmip.Builder

Field Summary

Fields

Modifier and Type	Field and Description
static long	serialVersionUID

Constructor Summary

Constructors

Constructor and Description
KeyServerKmip()
KeyServerKmip(Optional<java.lang.Long> keyProviderID, Optional<java.lang.Boolean> kmipAssignedProviderIsActive, java.lang.String kmipCaCertificate, java.lang.String kmipClientCertificate, java.lang.String[] kmipKeyServerHostnames, java.lang.Long keyServerID, java.lang.String kmipKeyServerName, java.lang.Long kmipKeyServerPort)

Method Summary

Modifier and Type	Method and Description
KeyServerKmip.Builder	asBuilder()
static KeyServerKmip.Builder	builder()
boolean	equals(java.lang.Object o)
Optional<java.lang.Long>	getKeyProviderID() If this KMIP Key Server is assigned to a provider, this field will contain the ID of the KMIP Key Provider it's assigned to.
java.lang.Long	getKeyServerID() The ID of the KMIP Key Server.
Optional<java.lang.Boolean>	getKmipAssignedProviderIsActive() If this KMIP Key Server is assigned to a provider (keyProviderID is not null), this field will indicate whether that provider is active (providing keys which are currently in use).
java.lang.String	getKmipCaCertificate() The public key certificate of the external key server's root CA.
java.lang.String	getKmipClientCertificate() A PEM format Base64 encoded PKCS#10 X.509 certificate used by the Solidfire KMIP client.
java.lang.String[]	getKmipKeyServerHostnames() The hostnames or IP addresses associated with this KMIP Key Server.
java.lang.String	getKmipKeyServerName() The name of the KMIP Key Server.
java.lang.Long	getKmipKeyServerPort() The port number associated with this KMIP Key Server (typically 5696).
int	hashCode()
void	setKeyProviderID(Optional<java.lang.Long> keyProviderID)
void	setKeyServerID(java.lang.Long keyServerID)
void	setKmipAssignedProviderIsActive(Optional<java.lang.Boolean> kmipAssignedProviderIsActive)
void	setKmipCaCertificate(java.lang.String kmipCaCertificate)
void	setKmipClientCertificate(java.lang.String kmipClientCertificate)
void	setKmipKeyServerHostnames(java.lang.String[] kmipKeyServerHostnames)
void	setKmipKeyServerName(java.lang.String kmipKeyServerName)
void	setKmipKeyServerPort(java.lang.Long kmipKeyServerPort)
java.util.Map<java.lang.String,java.lang.Object>	toMap()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

public static final long serialVersionUID

See Also:

Constant Field Values

Constructor Detail

KeyServerKmip

@Since(value="7.0")
public KeyServerKmip()

KeyServerKmip

@Since(value="7.0")
public KeyServerKmip(Optional<java.lang.Long> keyProviderID,
                                         Optional<java.lang.Boolean> kmipAssignedProviderIsActive,
                                         java.lang.String kmipCaCertificate,
                                         java.lang.String kmipClientCertificate,
                                         java.lang.String[] kmipKeyServerHostnames,
                                         java.lang.Long keyServerID,
                                         java.lang.String kmipKeyServerName,
                                         java.lang.Long kmipKeyServerPort)

Method Detail

getKeyProviderID

public Optional<java.lang.Long> getKeyProviderID()

If this KMIP Key Server is assigned to a provider, this field will contain the ID of the KMIP Key Provider it's assigned to. Otherwise it will be null.

setKeyProviderID

public void setKeyProviderID(Optional<java.lang.Long> keyProviderID)

getKmipAssignedProviderIsActive

public Optional<java.lang.Boolean> getKmipAssignedProviderIsActive()

If this KMIP Key Server is assigned to a provider (keyProviderID is not null), this field will indicate whether that provider is active (providing keys which are currently in use). Otherwise it will be null.

setKmipAssignedProviderIsActive

public void setKmipAssignedProviderIsActive(Optional<java.lang.Boolean> kmipAssignedProviderIsActive)

getKmipCaCertificate

public java.lang.String getKmipCaCertificate()

The public key certificate of the external key server's root CA. This will be used to verify the certificate presented by external key server in the TLS communication. For key server clusters where individual servers use different CAs, provide a concatenated string containing the root certificates of all the CAs.

setKmipCaCertificate

public void setKmipCaCertificate(java.lang.String kmipCaCertificate)

getKmipClientCertificate

public java.lang.String getKmipClientCertificate()

A PEM format Base64 encoded PKCS#10 X.509 certificate used by the Solidfire KMIP client.

setKmipClientCertificate

public void setKmipClientCertificate(java.lang.String kmipClientCertificate)

getKmipKeyServerHostnames

public java.lang.String[] getKmipKeyServerHostnames()

The hostnames or IP addresses associated with this KMIP Key Server.

setKmipKeyServerHostnames

public void setKmipKeyServerHostnames(java.lang.String[] kmipKeyServerHostnames)

getKeyServerID

public java.lang.Long getKeyServerID()

The ID of the KMIP Key Server. This is a unique value assigned by the cluster during CreateKeyServer which cannot be changedKmip.

setKeyServerID

public void setKeyServerID(java.lang.Long keyServerID)

getKmipKeyServerName

public java.lang.String getKmipKeyServerName()

The name of the KMIP Key Server. This name is only used for display purposes and does not need to be unique.

setKmipKeyServerName

public void setKmipKeyServerName(java.lang.String kmipKeyServerName)

getKmipKeyServerPort

public java.lang.Long getKmipKeyServerPort()

The port number associated with this KMIP Key Server (typically 5696).

setKmipKeyServerPort

public void setKmipKeyServerPort(java.lang.Long kmipKeyServerPort)

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toMap

public java.util.Map<java.lang.String,java.lang.Object> toMap()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

builder

public static KeyServerKmip.Builder builder()

asBuilder

public final KeyServerKmip.Builder asBuilder()