com.fortanix.sdkms.v1.model

Class KeyObject

java.lang.Object

com.fortanix.sdkms.v1.model.KeyObject

public class KeyObject
extends Object

KeyObject

Constructor Summary

Constructors

Constructor and Description
KeyObject()

Method Summary

Modifier and Type	Method and Description
KeyObject	acctId(String acctId)
KeyObject	addHistoryItem(HistoryItem historyItem)
KeyObject	addKeyOpsItem(KeyOperations keyOpsItem)
KeyObject	bls(BlsOptions bls)
KeyObject	compliantWithPolicies(Boolean compliantWithPolicies)
KeyObject	createdAt(String createdAt)
KeyObject	creator(CreatorType creator)
KeyObject	customMetadata(Map<String,String> customMetadata)
KeyObject	description(String description)
KeyObject	ellipticCurve(EllipticCurve ellipticCurve)
KeyObject	enabled(Boolean enabled)
boolean	equals(Object o)
String	getAcctId() Account ID of the account this security object belongs to.
BlsOptions	getBls() Get bls
Boolean	getCompliantWithPolicies() Whether this security object is compliant with cryptographic policies or not.
String	getCreatedAt() When this security object was created.
CreatorType	getCreator() Get creator
Map<String,String>	getCustomMetadata() User-defined metadata for this key.
String	getDescription() Description of the security object.
EllipticCurve	getEllipticCurve() Get ellipticCurve
Boolean	getEnabled() Whether this security object has cryptographic operations enabled.
String	getGroupId() Group ID of the security group that this security object belongs to.
List<HistoryItem>	getHistory() When a Key Undo Policy is in place, a list of (non-expired) history items is returned.
String	getKcv() KCV for the Security Object
List<KeyOperations>	getKeyOps() Array of key operations enabled for this security object.
Integer	getKeySize() For objects which are not elliptic curves, this is the size in bits (not bytes) of the object.
String	getKid() Key ID uniquely identifying this security object.
String	getLastusedAt() When this security object was last used.
String	getName() Name of the security object.
Boolean	getNeverExportable() True if this key's operations have never contained EXPORT.
ObjectType	getObjType() Get objType
ObjectOrigin	getOrigin() Get origin
byte[]	getPubKey() This field is returned only for asymmetric keys.
RsaOptions	getRsa() Get rsa
KeyObjectState	getState() Get state
String	getTransientKey() Transient key blob.
byte[]	getValue() This field is returned only for opaque and secret objects.
KeyObject	groupId(String groupId)
int	hashCode()
KeyObject	history(List<HistoryItem> history)
KeyObject	kcv(String kcv)
KeyObject	keyOps(List<KeyOperations> keyOps)
KeyObject	keySize(Integer keySize)
KeyObject	kid(String kid)
KeyObject	lastusedAt(String lastusedAt)
KeyObject	name(String name)
KeyObject	neverExportable(Boolean neverExportable)
KeyObject	objType(ObjectType objType)
KeyObject	origin(ObjectOrigin origin)
KeyObject	pubKey(byte[] pubKey)
KeyObject	putCustomMetadataItem(String key, String customMetadataItem)
KeyObject	rsa(RsaOptions rsa)
void	setAcctId(String acctId)
void	setBls(BlsOptions bls)
void	setCompliantWithPolicies(Boolean compliantWithPolicies)
void	setCreatedAt(String createdAt)
void	setCreator(CreatorType creator)
void	setCustomMetadata(Map<String,String> customMetadata)
void	setDescription(String description)
void	setEllipticCurve(EllipticCurve ellipticCurve)
void	setEnabled(Boolean enabled)
void	setGroupId(String groupId)
void	setHistory(List<HistoryItem> history)
void	setKcv(String kcv)
void	setKeyOps(List<KeyOperations> keyOps)
void	setKeySize(Integer keySize)
void	setKid(String kid)
void	setLastusedAt(String lastusedAt)
void	setName(String name)
void	setNeverExportable(Boolean neverExportable)
void	setObjType(ObjectType objType)
void	setOrigin(ObjectOrigin origin)
void	setPubKey(byte[] pubKey)
void	setRsa(RsaOptions rsa)
void	setState(KeyObjectState state)
void	setTransientKey(String transientKey)
void	setValue(byte[] value)
KeyObject	state(KeyObjectState state)
String	toString()
KeyObject	transientKey(String transientKey)
KeyObject	value(byte[] value)

Methods inherited from class java.lang.Object

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

Constructor Detail

KeyObject

public KeyObject()

Method Detail

name

public KeyObject name(String name)

getName

public String getName()

Name of the security object.

Returns:

name

setName

public void setName(String name)

description

public KeyObject description(String description)

getDescription

public String getDescription()

Description of the security object.

Returns:

description

setDescription

public void setDescription(String description)

keySize

public KeyObject keySize(Integer keySize)

getKeySize

public Integer getKeySize()

For objects which are not elliptic curves, this is the size in bits (not bytes) of the object. This field is not returned for elliptic curves.

Returns:

keySize

setKeySize

public void setKeySize(Integer keySize)

ellipticCurve

public KeyObject ellipticCurve(EllipticCurve ellipticCurve)

getEllipticCurve

public EllipticCurve getEllipticCurve()

Get ellipticCurve

Returns:

ellipticCurve

setEllipticCurve

public void setEllipticCurve(EllipticCurve ellipticCurve)

acctId

public KeyObject acctId(String acctId)

getAcctId

public String getAcctId()

Account ID of the account this security object belongs to.

Returns:

acctId

setAcctId

public void setAcctId(String acctId)

groupId

public KeyObject groupId(String groupId)

getGroupId

public String getGroupId()

Group ID of the security group that this security object belongs to.

Returns:

groupId

setGroupId

public void setGroupId(String groupId)

creator

public KeyObject creator(CreatorType creator)

getCreator

public CreatorType getCreator()

Get creator

Returns:

creator

setCreator

public void setCreator(CreatorType creator)

kid

public KeyObject kid(String kid)

getKid

public String getKid()

Key ID uniquely identifying this security object.

Returns:

kid

setKid

public void setKid(String kid)

objType

public KeyObject objType(ObjectType objType)

getObjType

public ObjectType getObjType()

Get objType

Returns:

objType

setObjType

public void setObjType(ObjectType objType)

keyOps

public KeyObject keyOps(List<KeyOperations> keyOps)

addKeyOpsItem

public KeyObject addKeyOpsItem(KeyOperations keyOpsItem)

getKeyOps

public List<KeyOperations> getKeyOps()

Array of key operations enabled for this security object.

Returns:

keyOps

setKeyOps

public void setKeyOps(List<KeyOperations> keyOps)

customMetadata

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

putCustomMetadataItem

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

origin

public KeyObject origin(ObjectOrigin origin)

getOrigin

public ObjectOrigin getOrigin()

Get origin

Returns:

origin

setOrigin

public void setOrigin(ObjectOrigin origin)

pubKey

public KeyObject pubKey(byte[] pubKey)

getPubKey

public byte[] getPubKey()

This field is returned only for asymmetric keys. It contains the public key.

Returns:

pubKey

setPubKey

public void setPubKey(byte[] pubKey)

value

public KeyObject value(byte[] value)

getValue

public byte[] getValue()

This field is returned only for opaque and secret objects. It contains the contents of the object.

Returns:

value

setValue

public void setValue(byte[] value)

enabled

public KeyObject enabled(Boolean enabled)

getEnabled

public Boolean getEnabled()

Whether this security object has cryptographic operations enabled.

Returns:

enabled

setEnabled

public void setEnabled(Boolean enabled)

compliantWithPolicies

public KeyObject compliantWithPolicies(Boolean compliantWithPolicies)

getCompliantWithPolicies

public Boolean getCompliantWithPolicies()

Whether this security object is compliant with cryptographic policies or not.

Returns:

compliantWithPolicies

setCompliantWithPolicies

public void setCompliantWithPolicies(Boolean compliantWithPolicies)

createdAt

public KeyObject createdAt(String createdAt)

getCreatedAt

public String getCreatedAt()

When this security object was created.

Returns:

createdAt

setCreatedAt

public void setCreatedAt(String createdAt)

lastusedAt

public KeyObject lastusedAt(String lastusedAt)

getLastusedAt

public String getLastusedAt()

When this security object was last used.

Returns:

lastusedAt

setLastusedAt

public void setLastusedAt(String lastusedAt)

transientKey

public KeyObject transientKey(String transientKey)

getTransientKey

public String getTransientKey()

Transient key blob.

Returns:

transientKey

setTransientKey

public void setTransientKey(String transientKey)

neverExportable

public KeyObject neverExportable(Boolean neverExportable)

getNeverExportable

public Boolean getNeverExportable()

True if this key's operations have never contained EXPORT.

Returns:

neverExportable

setNeverExportable

public void setNeverExportable(Boolean neverExportable)

rsa

public KeyObject rsa(RsaOptions rsa)

getRsa

public RsaOptions getRsa()

Get rsa

Returns:

rsa

setRsa

public void setRsa(RsaOptions rsa)

bls

public KeyObject bls(BlsOptions bls)

getBls

public BlsOptions getBls()

Get bls

Returns:

bls

setBls

public void setBls(BlsOptions bls)

kcv

public KeyObject kcv(String kcv)

getKcv

public String getKcv()

KCV for the Security Object

Returns:

kcv

setKcv

public void setKcv(String kcv)

state

public KeyObject state(KeyObjectState state)

getState

public KeyObjectState getState()

Get state

Returns:

state

setState

public void setState(KeyObjectState state)

history

public KeyObject history(List<HistoryItem> history)

addHistoryItem

public KeyObject addHistoryItem(HistoryItem historyItem)

getHistory

public List<HistoryItem> getHistory()

When a Key Undo Policy is in place, a list of (non-expired) history items is returned. Each history item represents a passed key state that can be reverted to.

Returns:

history

setHistory

public void setHistory(List<HistoryItem> history)

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