com.fortanix.sdkms.v1.model

Class SobjectRequest

java.lang.Object

com.fortanix.sdkms.v1.model.SobjectRequest

public class SobjectRequest
extends Object

SobjectRequest

Constructor Summary

Constructors

Constructor and Description
SobjectRequest()

Method Summary

Modifier and Type	Method and Description
SobjectRequest	_transient(Boolean _transient)
SobjectRequest	activationDate(String activationDate)
SobjectRequest	addKeyOpsItem(KeyOperations keyOpsItem)
SobjectRequest	bls(BlsOptions bls)
SobjectRequest	customMetadata(Map<String,String> customMetadata)
SobjectRequest	deactivationDate(String deactivationDate)
SobjectRequest	description(String description)
SobjectRequest	deterministicSignatures(Boolean deterministicSignatures)
SobjectRequest	dsa(DsaOptions dsa)
SobjectRequest	ellipticCurve(EllipticCurve ellipticCurve)
SobjectRequest	enabled(Boolean enabled)
boolean	equals(Object o)
SobjectRequest	fpe(FpeOptions fpe)
String	getActivationDate() When this object will be activated.
BlsOptions	getBls() Get bls
Map<String,String>	getCustomMetadata() User-defined metadata for this key.
String	getDeactivationDate() When this object will be deactivated.
String	getDescription() Description of the security object to create or import.
Boolean	getDeterministicSignatures() Get deterministicSignatures
DsaOptions	getDsa() Get dsa
EllipticCurve	getEllipticCurve() Get ellipticCurve
Boolean	getEnabled() Whether the new security object should be enabled.
FpeOptions	getFpe() Get fpe
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() Size in bits (not bytes) of the security object to create or import.
String	getName() Name of the security object to create or import.
ObjectType	getObjType() Get objType
Integer	getPubExponent() For RSA keys only.
RotationPolicy	getRotationPolicy() Get rotationPolicy
RsaOptions	getRsa() Get rsa
KeyObjectState	getState() Get state
Boolean	getTransient() If this is true, DSM will create a transient key.
byte[]	getValue() When importing a security object, this field contains the binary contents to import.
SobjectRequest	groupId(String groupId)
int	hashCode()
SobjectRequest	keyOps(List<KeyOperations> keyOps)
SobjectRequest	keySize(Integer keySize)
SobjectRequest	name(String name)
SobjectRequest	objType(ObjectType objType)
SobjectRequest	pubExponent(Integer pubExponent)
SobjectRequest	putCustomMetadataItem(String key, String customMetadataItem)
SobjectRequest	rotationPolicy(RotationPolicy rotationPolicy)
SobjectRequest	rsa(RsaOptions rsa)
void	setActivationDate(String activationDate)
void	setBls(BlsOptions bls)
void	setCustomMetadata(Map<String,String> customMetadata)
void	setDeactivationDate(String deactivationDate)
void	setDescription(String description)
void	setDeterministicSignatures(Boolean deterministicSignatures)
void	setDsa(DsaOptions dsa)
void	setEllipticCurve(EllipticCurve ellipticCurve)
void	setEnabled(Boolean enabled)
void	setFpe(FpeOptions fpe)
void	setGroupId(String groupId)
void	setKeyOps(List<KeyOperations> keyOps)
void	setKeySize(Integer keySize)
void	setName(String name)
void	setObjType(ObjectType objType)
void	setPubExponent(Integer pubExponent)
void	setRotationPolicy(RotationPolicy rotationPolicy)
void	setRsa(RsaOptions rsa)
void	setState(KeyObjectState state)
void	setTransient(Boolean _transient)
void	setValue(byte[] value)
SobjectRequest	state(KeyObjectState state)
String	toString()
SobjectRequest	value(byte[] value)

Methods inherited from class java.lang.Object

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

Constructor Detail

SobjectRequest

public SobjectRequest()

Method Detail

name

public SobjectRequest name(String name)

getName

public String getName()

Name of the security object to create or import. Security object names must be unique within an account.

Returns:

name

setName

public void setName(String name)

description

public SobjectRequest description(String description)

getDescription

public String getDescription()

Description of the security object to create or import.

Returns:

description

setDescription

public void setDescription(String description)

keySize

public SobjectRequest keySize(Integer keySize)

getKeySize

public Integer getKeySize()

Size in bits (not bytes) of the security object to create or import. Required for symmetric keys. For DSA keys, it represents the size of `p`; allowed values are 2048 or 3072. Deprecated for RSA keys, specify it in `RsaOptions` instead.

Returns:

keySize

setKeySize

public void setKeySize(Integer keySize)

pubExponent

public SobjectRequest pubExponent(Integer pubExponent)

getPubExponent

public Integer getPubExponent()

For RSA keys only. Deprecated. Specify in `RsaOptions` instead. Public exponent to use when generating an RSA key.

Returns:

pubExponent

setPubExponent

public void setPubExponent(Integer pubExponent)

ellipticCurve

public SobjectRequest ellipticCurve(EllipticCurve ellipticCurve)

getEllipticCurve

public EllipticCurve getEllipticCurve()

Get ellipticCurve

Returns:

ellipticCurve

setEllipticCurve

public void setEllipticCurve(EllipticCurve ellipticCurve)

rsa

public SobjectRequest rsa(RsaOptions rsa)

getRsa

public RsaOptions getRsa()

Get rsa

Returns:

rsa

setRsa

public void setRsa(RsaOptions rsa)

dsa

public SobjectRequest dsa(DsaOptions dsa)

getDsa

public DsaOptions getDsa()

Get dsa

Returns:

dsa

setDsa

public void setDsa(DsaOptions dsa)

fpe

public SobjectRequest fpe(FpeOptions fpe)

getFpe

public FpeOptions getFpe()

Get fpe

Returns:

fpe

setFpe

public void setFpe(FpeOptions fpe)

groupId

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

rotationPolicy

public SobjectRequest rotationPolicy(RotationPolicy rotationPolicy)

getRotationPolicy

public RotationPolicy getRotationPolicy()

Get rotationPolicy

Returns:

rotationPolicy

setRotationPolicy

public void setRotationPolicy(RotationPolicy rotationPolicy)

objType

public SobjectRequest objType(ObjectType objType)

getObjType

public ObjectType getObjType()

Get objType

Returns:

objType

setObjType

public void setObjType(ObjectType objType)

keyOps

public SobjectRequest keyOps(List<KeyOperations> keyOps)

addKeyOpsItem

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

putCustomMetadataItem

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

value

public SobjectRequest value(byte[] value)

getValue

public byte[] getValue()

When importing a security object, this field contains the binary contents to import. When creating a security object, this field is unused. The value of an OPAQUE or CERTIFICATE object is always returned. For other objects, the value is returned only with `/crypto/v1/keys/export` API (if the object is exportable).

Returns:

value

setValue

public void setValue(byte[] value)

enabled

public SobjectRequest 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 SobjectRequest _transient(Boolean _transient)

getTransient

public Boolean getTransient()

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

Returns:

_transient

setTransient

public void setTransient(Boolean _transient)

deterministicSignatures

public SobjectRequest deterministicSignatures(Boolean deterministicSignatures)

getDeterministicSignatures

public Boolean getDeterministicSignatures()

Get deterministicSignatures

Returns:

deterministicSignatures

setDeterministicSignatures

public void setDeterministicSignatures(Boolean deterministicSignatures)

state

public SobjectRequest state(KeyObjectState state)

getState

public KeyObjectState getState()

Get state

Returns:

state

setState

public void setState(KeyObjectState state)

activationDate

public SobjectRequest activationDate(String activationDate)

getActivationDate

public String getActivationDate()

When this object will be activated.

Returns:

activationDate

setActivationDate

public void setActivationDate(String activationDate)

bls

public SobjectRequest bls(BlsOptions bls)

getBls

public BlsOptions getBls()

Get bls

Returns:

bls

setBls

public void setBls(BlsOptions bls)

deactivationDate

public SobjectRequest deactivationDate(String deactivationDate)

getDeactivationDate

public String getDeactivationDate()

When this object will be deactivated.

Returns:

deactivationDate

setDeactivationDate

public void setDeactivationDate(String deactivationDate)

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