com.fortanix.sdkms.v1.model

Class AgreeKeyRequest

java.lang.Object

com.fortanix.sdkms.v1.model.AgreeKeyRequest

public class AgreeKeyRequest
extends Object

AgreeKeyRequest

Constructor Summary

Constructors

Constructor and Description
AgreeKeyRequest()

Method Summary

Modifier and Type	Method and Description
AgreeKeyRequest	_transient(Boolean _transient)
AgreeKeyRequest	addKeyOpsItem(KeyOperations keyOpsItem)
AgreeKeyRequest	customMetadata(Map<String,String> customMetadata)
AgreeKeyRequest	description(String description)
AgreeKeyRequest	enabled(Boolean enabled)
boolean	equals(Object o)
Map<String,String>	getCustomMetadata() User-defined metadata for this key.
String	getDescription() Description for the new key.
Boolean	getEnabled() Whether the derived key should have cryptographic operations enabled.
String	getGroupId() Group ID (not name) of the security group that this security object should belong to.
List<KeyOperations>	getKeyOps() Optional array of key operations to be enabled for this security object.
Integer	getKeySize() Key size of the derived key in bits (not bytes).
ObjectType	getKeyType() Get keyType
AgreeKeyMechanism	getMechanism() Get mechanism
String	getName() Name of the agreed-upon key.
SobjectDescriptor	getPrivateKey() Get privateKey
SobjectDescriptor	getPublicKey() Get publicKey
Boolean	getTransient() If this is true, DSM will derive a transient key.
AgreeKeyRequest	groupId(String groupId)
int	hashCode()
AgreeKeyRequest	keyOps(List<KeyOperations> keyOps)
AgreeKeyRequest	keySize(Integer keySize)
AgreeKeyRequest	keyType(ObjectType keyType)
AgreeKeyRequest	mechanism(AgreeKeyMechanism mechanism)
AgreeKeyRequest	name(String name)
AgreeKeyRequest	privateKey(SobjectDescriptor privateKey)
AgreeKeyRequest	publicKey(SobjectDescriptor publicKey)
AgreeKeyRequest	putCustomMetadataItem(String key, String customMetadataItem)
void	setCustomMetadata(Map<String,String> customMetadata)
void	setDescription(String description)
void	setEnabled(Boolean enabled)
void	setGroupId(String groupId)
void	setKeyOps(List<KeyOperations> keyOps)
void	setKeySize(Integer keySize)
void	setKeyType(ObjectType keyType)
void	setMechanism(AgreeKeyMechanism mechanism)
void	setName(String name)
void	setPrivateKey(SobjectDescriptor privateKey)
void	setPublicKey(SobjectDescriptor publicKey)
void	setTransient(Boolean _transient)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

AgreeKeyRequest

public AgreeKeyRequest()

Method Detail

privateKey

public AgreeKeyRequest privateKey(SobjectDescriptor privateKey)

getPrivateKey

public SobjectDescriptor getPrivateKey()

Get privateKey

Returns:

privateKey

setPrivateKey

public void setPrivateKey(SobjectDescriptor privateKey)

publicKey

public AgreeKeyRequest publicKey(SobjectDescriptor publicKey)

getPublicKey

public SobjectDescriptor getPublicKey()

Get publicKey

Returns:

publicKey

setPublicKey

public void setPublicKey(SobjectDescriptor publicKey)

name

public AgreeKeyRequest name(String name)

getName

public String getName()

Name of the agreed-upon key. Key names must be unique within an account. The name is ignored for transient keys and should be the empty string.

Returns:

name

setName

public void setName(String name)

groupId

public AgreeKeyRequest groupId(String groupId)

getGroupId

public String getGroupId()

Group ID (not name) of the security group that this security object should belong to. The user or application creating this security object must be a member of this group. If no group is specified, the default group for the user or application will be used.

Returns:

groupId

setGroupId

public void setGroupId(String groupId)

keySize

public AgreeKeyRequest keySize(Integer keySize)

getKeySize

public Integer getKeySize()

Key size of the derived key in bits (not bytes).

Returns:

keySize

setKeySize

public void setKeySize(Integer keySize)

keyType

public AgreeKeyRequest keyType(ObjectType keyType)

getKeyType

public ObjectType getKeyType()

Get keyType

Returns:

keyType

setKeyType

public void setKeyType(ObjectType keyType)

mechanism

public AgreeKeyRequest mechanism(AgreeKeyMechanism mechanism)

getMechanism

public AgreeKeyMechanism getMechanism()

Get mechanism

Returns:

mechanism

setMechanism

public void setMechanism(AgreeKeyMechanism mechanism)

enabled

public AgreeKeyRequest enabled(Boolean enabled)

getEnabled

public Boolean getEnabled()

Whether the derived key should have cryptographic operations enabled.

Returns:

enabled

setEnabled

public void setEnabled(Boolean enabled)

description

public AgreeKeyRequest description(String description)

getDescription

public String getDescription()

Description for the new key.

Returns:

description

setDescription

public void setDescription(String description)

keyOps

public AgreeKeyRequest keyOps(List<KeyOperations> keyOps)

addKeyOpsItem

public AgreeKeyRequest addKeyOpsItem(KeyOperations keyOpsItem)

getKeyOps

public List<KeyOperations> getKeyOps()

Optional array of key operations to be enabled for this security object. If this property is not provided, the DSM server will provide a default set of key operations. Note that if you provide an empty array, all key operations will be disabled.

Returns:

keyOps

setKeyOps

public void setKeyOps(List<KeyOperations> keyOps)

customMetadata

public AgreeKeyRequest customMetadata(Map<String,String> customMetadata)

putCustomMetadataItem

public AgreeKeyRequest putCustomMetadataItem(String key,
                                             String customMetadataItem)

getCustomMetadata

public Map<String,String> getCustomMetadata()

User-defined metadata for this key. Stored as key-value pairs.

Returns:

customMetadata

setCustomMetadata

public void setCustomMetadata(Map<String,String> customMetadata)

_transient

public AgreeKeyRequest _transient(Boolean _transient)

getTransient

public Boolean getTransient()

If this is true, DSM will derive a transient key.

Returns:

_transient

setTransient

public void setTransient(Boolean _transient)

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