Package com.oracle.bmc.keymanagement.model

Class SignDataDetails

java.lang.Object

com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

com.oracle.bmc.keymanagement.model.SignDataDetails

@Generated(value="OracleSDKGenerator",
           comments="API Version: release")
public final class SignDataDetails
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

The details of the message that you want to sign.
Note: Objects should always be created or deserialized using the SignDataDetails.Builder. This model distinguishes fields that are null because they are unset from fields that are explicitly set to null. This is done in the setter methods of the SignDataDetails.Builder, which maintain a set of all explicitly set fields called SignDataDetails.Builder.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take the explicitly set fields into account. The constructor, on the other hand, does not take the explicitly set fields into account (since the constructor cannot distinguish explicit null from unset null).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SignDataDetails.Builder
static class	SignDataDetails.MessageType	Denotes whether the value of the message parameter is a raw message or a message digest.
static class	SignDataDetails.SigningAlgorithm	The algorithm to use to sign the message or message digest.

Field Summary

Fields inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME

Constructor Summary

Constructors

Constructor	Description
SignDataDetails(String message, String keyId, String keyVersionId, SignDataDetails.MessageType messageType, SignDataDetails.SigningAlgorithm signingAlgorithm, Map<String,String> loggingContext)	Deprecated.

Method Summary

Modifier and Type	Method	Description
static SignDataDetails.Builder	builder()	Create a new builder.
boolean	equals(Object o)
String	getKeyId()	The OCID of the key used to sign the message.
String	getKeyVersionId()	The OCID of the key version used to sign the message.
Map<String,String>	getLoggingContext()	Information that can be used to provide context for audit logging.
String	getMessage()	The base64-encoded binary data object denoting the message or message digest to sign.
SignDataDetails.MessageType	getMessageType()	Denotes whether the value of the message parameter is a raw message or a message digest.
SignDataDetails.SigningAlgorithm	getSigningAlgorithm()	The algorithm to use to sign the message or message digest.
int	hashCode()
SignDataDetails.Builder	toBuilder()
String	toString()
String	toString(boolean includeByteArrayContents)	Return a string representation of the object.

Methods inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

markPropertyAsExplicitlySet, wasPropertyExplicitlySet

Methods inherited from class java.lang.Object

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

Constructor Detail

SignDataDetails

@Deprecated
@ConstructorProperties({"message","keyId","keyVersionId","messageType","signingAlgorithm","loggingContext"})
public SignDataDetails(String message,
                       String keyId,
                       String keyVersionId,
                       SignDataDetails.MessageType messageType,
                       SignDataDetails.SigningAlgorithm signingAlgorithm,
                       Map<String,String> loggingContext)

Deprecated.

Method Detail

builder

public static SignDataDetails.Builder builder()

Create a new builder.

toBuilder

public SignDataDetails.Builder toBuilder()

getMessage

public String getMessage()

The base64-encoded binary data object denoting the message or message digest to sign.

You can have a message up to 4096 bytes in size. To sign a larger message, provide the message digest.

Returns:

the value

getKeyId

public String getKeyId()

The OCID of the key used to sign the message.

Returns:

the value

getKeyVersionId

public String getKeyVersionId()

The OCID of the key version used to sign the message.

Returns:

the value

getMessageType

public SignDataDetails.MessageType getMessageType()

Denotes whether the value of the message parameter is a raw message or a message digest.

The default value, RAW, indicates a message. To indicate a message digest, use DIGEST.

Returns:

the value

getSigningAlgorithm

public SignDataDetails.SigningAlgorithm getSigningAlgorithm()

The algorithm to use to sign the message or message digest.

For RSA keys, supported signature schemes include PKCS #1 and RSASSA-PSS, along with different hashing algorithms. For ECDSA keys, ECDSA is the supported signature scheme with different hashing algorithms. When you pass a message digest for signing, ensure that you specify the same hashing algorithm as used when creating the message digest.

Returns:

the value

getLoggingContext

public Map<String,String> getLoggingContext()

Information that can be used to provide context for audit logging.

It is a map that contains any additional data that you provide to include with audit logs, if audit logging is enabled.

Returns:

the value

toString

public String toString()

Overrides:

toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

toString

public String toString(boolean includeByteArrayContents)

Return a string representation of the object.

Parameters:

includeByteArrayContents - true to include the full contents of byte arrays

Returns:

string representation

equals

public boolean equals(Object o)

Overrides:

equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

hashCode

public int hashCode()

Overrides:

hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel