com.solidfire.element.api

Class ModifyKeyServerKmipRequest

java.lang.Object

com.solidfire.element.api.ModifyKeyServerKmipRequest

All Implemented Interfaces:

java.io.Serializable

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

ModifyKeyServerKmipRequest Modifies a KMIP (Key Management Interoperability Protocol) Key Server to the specified attributes. The only required parameter is the keyServerID. A request which contains only the keyServerID will be a no-op and no error will be returned. Any other parameters which are specified will replace the existing values on the KMIP Key Server with the specified keyServerID. Because this server might be part of an active provider this will result in contacting the server to verify it's functional. Multiple hostnames or IP addresses must only be provided to the kmipKeyServerHostnames parameter if the key servers are in a clustered configuration.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ModifyKeyServerKmipRequest.Builder

Field Summary

Fields

Modifier and Type	Field and Description
static long	serialVersionUID

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
ModifyKeyServerKmipRequest.Builder	asBuilder()
static ModifyKeyServerKmipRequest.Builder	builder()
boolean	equals(java.lang.Object o)
java.lang.Long	getKeyServerID() The ID of the KMIP Key Server to modify.
Optional<java.lang.String>	getKmipCaCertificate() The public key certificate of the external key server's root CA.
Optional<java.lang.String>	getKmipClientCertificate() A PEM format Base64 encoded PKCS#10 X.509 certificate used by the Solidfire KMIP client.
Optional<java.lang.String[]>	getKmipKeyServerHostnames() Array of the hostnames or IP addresses associated with this KMIP Key Server.
Optional<java.lang.String>	getKmipKeyServerName() The name of the KMIP Key Server.
Optional<java.lang.Long>	getKmipKeyServerPort() The port number associated with this KMIP Key Server (typically 5696).
int	hashCode()
void	setKeyServerID(java.lang.Long keyServerID)
void	setKmipCaCertificate(Optional<java.lang.String> kmipCaCertificate)
void	setKmipClientCertificate(Optional<java.lang.String> kmipClientCertificate)
void	setKmipKeyServerHostnames(Optional<java.lang.String[]> kmipKeyServerHostnames)
void	setKmipKeyServerName(Optional<java.lang.String> kmipKeyServerName)
void	setKmipKeyServerPort(Optional<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

ModifyKeyServerKmipRequest

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

ModifyKeyServerKmipRequest

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

Method Detail

getKmipCaCertificate

public Optional<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(Optional<java.lang.String> kmipCaCertificate)

getKmipClientCertificate

public Optional<java.lang.String> getKmipClientCertificate()

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

setKmipClientCertificate

public void setKmipClientCertificate(Optional<java.lang.String> kmipClientCertificate)

getKmipKeyServerHostnames

public Optional<java.lang.String[]> getKmipKeyServerHostnames()

Array of the hostnames or IP addresses associated with this KMIP Key Server. Multiple hostnames or IP addresses must only be provided if the key servers are in a clustered configuration.

setKmipKeyServerHostnames

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

getKeyServerID

public java.lang.Long getKeyServerID()

The ID of the KMIP Key Server to modify.

setKeyServerID

public void setKeyServerID(java.lang.Long keyServerID)

getKmipKeyServerName

public Optional<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(Optional<java.lang.String> kmipKeyServerName)

getKmipKeyServerPort

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

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

setKmipKeyServerPort

public void setKmipKeyServerPort(Optional<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 ModifyKeyServerKmipRequest.Builder builder()

asBuilder

public final ModifyKeyServerKmipRequest.Builder asBuilder()