com.fortanix.sdkms.v1.model

Class UnwrapKeyRequestEx

java.lang.Object

com.fortanix.sdkms.v1.model.UnwrapKeyRequestEx

public class UnwrapKeyRequestEx
extends Object

UnwrapKeyRequestEx

Constructor Summary

Constructors

Constructor and Description
UnwrapKeyRequestEx()

Method Summary

Modifier and Type	Method and Description
UnwrapKeyRequestEx	ad(byte[] ad)
UnwrapKeyRequestEx	addKeyOpsItem(KeyOperations keyOpsItem)
UnwrapKeyRequestEx	alg(ObjectType alg)
UnwrapKeyRequestEx	customMetadata(Map<String,String> customMetadata)
UnwrapKeyRequestEx	description(String description)
UnwrapKeyRequestEx	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.
SobjectDescriptor	getKey() Get key
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.
byte[]	getWrappedKey() A Security Object previously wrapped with another key.
UnwrapKeyRequestEx	groupId(String groupId)
int	hashCode()
UnwrapKeyRequestEx	iv(byte[] iv)
UnwrapKeyRequestEx	key(SobjectDescriptor key)
UnwrapKeyRequestEx	keyOps(List<KeyOperations> keyOps)
UnwrapKeyRequestEx	mode(CryptMode mode)
UnwrapKeyRequestEx	name(String name)
UnwrapKeyRequestEx	objType(ObjectType objType)
UnwrapKeyRequestEx	putCustomMetadataItem(String key, String customMetadataItem)
UnwrapKeyRequestEx	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	setKey(SobjectDescriptor key)
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	setWrappedKey(byte[] wrappedKey)
UnwrapKeyRequestEx	tag(byte[] tag)
String	toString()
UnwrapKeyRequestEx	wrappedKey(byte[] wrappedKey)

Methods inherited from class java.lang.Object

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

Constructor Detail

UnwrapKeyRequestEx

public UnwrapKeyRequestEx()

Method Detail

key

public UnwrapKeyRequestEx key(SobjectDescriptor key)

getKey

public SobjectDescriptor getKey()

Get key

Returns:

key

setKey

public void setKey(SobjectDescriptor key)

alg

public UnwrapKeyRequestEx alg(ObjectType alg)

getAlg

public ObjectType getAlg()

Get alg

Returns:

alg

setAlg

public void setAlg(ObjectType alg)

groupId

public UnwrapKeyRequestEx 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 UnwrapKeyRequestEx objType(ObjectType objType)

getObjType

public ObjectType getObjType()

Get objType

Returns:

objType

setObjType

public void setObjType(ObjectType objType)

wrappedKey

public UnwrapKeyRequestEx 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 UnwrapKeyRequestEx mode(CryptMode mode)

getMode

public CryptMode getMode()

Get mode

Returns:

mode

setMode

public void setMode(CryptMode mode)

iv

public UnwrapKeyRequestEx 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 UnwrapKeyRequestEx 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 UnwrapKeyRequestEx 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 UnwrapKeyRequestEx 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 UnwrapKeyRequestEx description(String description)

getDescription

public String getDescription()

Description of the Security object to unwrap.

Returns:

description

setDescription

public void setDescription(String description)

keyOps

public UnwrapKeyRequestEx keyOps(List<KeyOperations> keyOps)

addKeyOpsItem

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

putCustomMetadataItem

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

rsa

public UnwrapKeyRequestEx 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