com.fortanix.sdkms.v1.model

Class UnwrapKeyRequest

java.lang.Object

com.fortanix.sdkms.v1.model.UnwrapKeyRequest

public class UnwrapKeyRequest
extends Object

UnwrapKeyRequest

Constructor Summary

Constructors

Constructor and Description
UnwrapKeyRequest()

Method Summary

Modifier and Type	Method and Description
UnwrapKeyRequest	_transient(Boolean _transient)
UnwrapKeyRequest	ad(byte[] ad)
UnwrapKeyRequest	addKeyOpsItem(KeyOperations keyOpsItem)
UnwrapKeyRequest	alg(ObjectType alg)
UnwrapKeyRequest	customMetadata(Map<String,String> customMetadata)
UnwrapKeyRequest	description(String description)
UnwrapKeyRequest	enabled(Boolean enabled)
boolean	equals(Object o)
byte[]	getAd() The authenticated data used with this ciphertext and authentication tag.
ObjectType	getAlg() Get alg
Map<String,String>	getCustomMetadata() User-defined metadata for this key.
String	getDescription() Description of the Security object to unwrap.
Boolean	getEnabled() Whether the new security object should be enabled.
String	getGroupId() Group ID (not name) of the security group that this security object should belong to.
byte[]	getIv() The initialization value used to encrypt this ciphertext.
List<KeyOperations>	getKeyOps() Optional array of key operations to be enabled for this security object.
CryptMode	getMode() Get mode
String	getName() Name of the security object to unwrap.
ObjectType	getObjType() Get objType
RsaOptions	getRsa() Get rsa
byte[]	getTag() The authentication tag used with this ciphertext and authenticated data.
Boolean	getTransient() If this is true, DSM will unwrap a transient key.
byte[]	getWrappedKey() A Security Object previously wrapped with another key.
UnwrapKeyRequest	groupId(String groupId)
int	hashCode()
UnwrapKeyRequest	iv(byte[] iv)
UnwrapKeyRequest	keyOps(List<KeyOperations> keyOps)
UnwrapKeyRequest	mode(CryptMode mode)
UnwrapKeyRequest	name(String name)
UnwrapKeyRequest	objType(ObjectType objType)
UnwrapKeyRequest	putCustomMetadataItem(String key, String customMetadataItem)
UnwrapKeyRequest	rsa(RsaOptions rsa)
void	setAd(byte[] ad)
void	setAlg(ObjectType alg)
void	setCustomMetadata(Map<String,String> customMetadata)
void	setDescription(String description)
void	setEnabled(Boolean enabled)
void	setGroupId(String groupId)
void	setIv(byte[] iv)
void	setKeyOps(List<KeyOperations> keyOps)
void	setMode(CryptMode mode)
void	setName(String name)
void	setObjType(ObjectType objType)
void	setRsa(RsaOptions rsa)
void	setTag(byte[] tag)
void	setTransient(Boolean _transient)
void	setWrappedKey(byte[] wrappedKey)
UnwrapKeyRequest	tag(byte[] tag)
String	toString()
UnwrapKeyRequest	wrappedKey(byte[] wrappedKey)

Methods inherited from class java.lang.Object

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

Constructor Detail

UnwrapKeyRequest

public UnwrapKeyRequest()

Method Detail

alg

public UnwrapKeyRequest alg(ObjectType alg)

getAlg

public ObjectType getAlg()

Get alg

Returns:

alg

setAlg

public void setAlg(ObjectType alg)

groupId

public UnwrapKeyRequest 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)

objType

public UnwrapKeyRequest objType(ObjectType objType)

getObjType

public ObjectType getObjType()

Get objType

Returns:

objType

setObjType

public void setObjType(ObjectType objType)

wrappedKey

public UnwrapKeyRequest wrappedKey(byte[] wrappedKey)

getWrappedKey

public byte[] getWrappedKey()

A Security Object previously wrapped with another key.

Returns:

wrappedKey

setWrappedKey

public void setWrappedKey(byte[] wrappedKey)

mode

public UnwrapKeyRequest mode(CryptMode mode)

getMode

public CryptMode getMode()

Get mode

Returns:

mode

setMode

public void setMode(CryptMode mode)

iv

public UnwrapKeyRequest iv(byte[] iv)

getIv

public byte[] getIv()

The initialization value used to encrypt this ciphertext. This field is required for symmetric ciphers, and ignored for asymmetric ciphers.

Returns:

iv

setIv

public void setIv(byte[] iv)

ad

public UnwrapKeyRequest ad(byte[] ad)

getAd

public byte[] getAd()

The authenticated data used with this ciphertext and authentication tag. This field is required for symmetric ciphers using cipher mode GCM or CCM, and must not be specified for all other ciphers.

Returns:

ad

setAd

public void setAd(byte[] ad)

tag

public UnwrapKeyRequest tag(byte[] tag)

getTag

public byte[] getTag()

The authentication tag used with this ciphertext and authenticated data. This field is required for symmetric ciphers using cipher mode GCM or CCM, and must not be specified for all other ciphers.

Returns:

tag

setTag

public void setTag(byte[] tag)

name

public UnwrapKeyRequest name(String name)

getName

public String getName()

Name of the security object to unwrap. Security object names must be unique within an account.

Returns:

name

setName

public void setName(String name)

description

public UnwrapKeyRequest description(String description)

getDescription

public String getDescription()

Description of the Security object to unwrap.

Returns:

description

setDescription

public void setDescription(String description)

keyOps

public UnwrapKeyRequest keyOps(List<KeyOperations> keyOps)

addKeyOpsItem

public UnwrapKeyRequest 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 UnwrapKeyRequest customMetadata(Map<String,String> customMetadata)

putCustomMetadataItem

public UnwrapKeyRequest 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)

enabled

public UnwrapKeyRequest enabled(Boolean enabled)

getEnabled

public Boolean getEnabled()

Whether the new security object should be enabled. Disabled security objects may not perform cryptographic operations.

Returns:

enabled

setEnabled

public void setEnabled(Boolean enabled)

_transient

public UnwrapKeyRequest _transient(Boolean _transient)

getTransient

public Boolean getTransient()

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

Returns:

_transient

setTransient

public void setTransient(Boolean _transient)

rsa

public UnwrapKeyRequest rsa(RsaOptions rsa)

getRsa

public RsaOptions getRsa()

Get rsa

Returns:

rsa

setRsa

public void setRsa(RsaOptions rsa)

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