com.solidfire.element.api

Class KeyProviderKmip

java.lang.Object

com.solidfire.element.api.KeyProviderKmip

All Implemented Interfaces:

java.io.Serializable

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

KeyProviderKmip A Key Provider describes both a mechanism and a location for retrieving authentication keys for use with cluster features such as Encryption At Rest. Some Key Providers may imply that there can only be one Key Provider of that type, while others may allow multiple Key Providers of the same type but retrieving authentication keys from different locations for different purposes. A KMIP (Key Management Interoperability Protocol) Key Provider can represent a single KMIP server, a logical cluster of KMIP servers which should be kept in sync, or an actual cluster which we treat as a single server. There can be multiple KMIP Key Providers but they must contain mutually-exclusive sets of servers. Key UUID's will only be considered as unique within a Key Provider so there could be collisions (and resulting errors) otherwise.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	KeyProviderKmip.Builder

Field Summary

Fields

Modifier and Type	Field and Description
static long	serialVersionUID

Constructor Summary

Constructors

Constructor and Description
KeyProviderKmip()
KeyProviderKmip(java.lang.String keyProviderName, java.lang.Long keyProviderID, java.lang.Boolean keyProviderIsActive, java.lang.Long[] keyServerIDs, java.lang.String kmipCapabilities)

Method Summary

Modifier and Type	Method and Description
KeyProviderKmip.Builder	asBuilder()
static KeyProviderKmip.Builder	builder()
boolean	equals(java.lang.Object o)
java.lang.Long	getKeyProviderID() The ID of the KMIP Key Provider.
java.lang.Boolean	getKeyProviderIsActive() True if the KMIP Key Provider is active.
java.lang.String	getKeyProviderName() The name of the KMIP Key Provider.
java.lang.Long[]	getKeyServerIDs() A list of keyServerIDs which are grouped together within this provider.
java.lang.String	getKmipCapabilities() The capabilities of this KMIP Key Provider including details about the underlying library, FIPS compliance, SSL provider, etc.
int	hashCode()
void	setKeyProviderID(java.lang.Long keyProviderID)
void	setKeyProviderIsActive(java.lang.Boolean keyProviderIsActive)
void	setKeyProviderName(java.lang.String keyProviderName)
void	setKeyServerIDs(java.lang.Long[] keyServerIDs)
void	setKmipCapabilities(java.lang.String kmipCapabilities)
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

KeyProviderKmip

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

KeyProviderKmip

@Since(value="7.0")
public KeyProviderKmip(java.lang.String keyProviderName,
                                           java.lang.Long keyProviderID,
                                           java.lang.Boolean keyProviderIsActive,
                                           java.lang.Long[] keyServerIDs,
                                           java.lang.String kmipCapabilities)

Method Detail

getKeyProviderName

public java.lang.String getKeyProviderName()

The name of the KMIP Key Provider.

setKeyProviderName

public void setKeyProviderName(java.lang.String keyProviderName)

getKeyProviderID

public java.lang.Long getKeyProviderID()

The ID of the KMIP Key Provider. This is a unique value assigned by the cluster during CreateKeyProviderKmip which cannot be changed.

setKeyProviderID

public void setKeyProviderID(java.lang.Long keyProviderID)

getKeyProviderIsActive

public java.lang.Boolean getKeyProviderIsActive()

True if the KMIP Key Provider is active. A provider is considered active if are still outstanding keys which were created but not yet deleted and therefore assumed to still be in use.

setKeyProviderIsActive

public void setKeyProviderIsActive(java.lang.Boolean keyProviderIsActive)

getKeyServerIDs

public java.lang.Long[] getKeyServerIDs()

A list of keyServerIDs which are grouped together within this provider. At least one server must be added via AddKeyServerToProviderKmip before this provider can become active. The last server cannot be removed via RemoveKeyServerFromProviderKmip or DeleteKeyServerKmip while this provider is active.

setKeyServerIDs

public void setKeyServerIDs(java.lang.Long[] keyServerIDs)

getKmipCapabilities

public java.lang.String getKmipCapabilities()

The capabilities of this KMIP Key Provider including details about the underlying library, FIPS compliance, SSL provider, etc.

setKmipCapabilities

public void setKmipCapabilities(java.lang.String kmipCapabilities)

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 KeyProviderKmip.Builder builder()

asBuilder

public final KeyProviderKmip.Builder asBuilder()