com.amazonaws.services.kms.model

Class VerifyResult

java.lang.Object

com.amazonaws.services.kms.model.VerifyResult

All Implemented Interfaces:

java.io.Serializable

public class VerifyResult
extends java.lang.Object
implements java.io.Serializable

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
VerifyResult()

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.lang.String	getKeyId() The Amazon Resource Name (key ARN) of the asymmetric CMK that was used to verify the signature.
java.lang.Boolean	getSignatureValid() A Boolean value that indicates whether the signature was verified.
java.lang.String	getSigningAlgorithm() The signing algorithm that was used to verify the signature.
int	hashCode()
java.lang.Boolean	isSignatureValid() A Boolean value that indicates whether the signature was verified.
void	setKeyId(java.lang.String keyId) The Amazon Resource Name (key ARN) of the asymmetric CMK that was used to verify the signature.
void	setSignatureValid(java.lang.Boolean signatureValid) A Boolean value that indicates whether the signature was verified.
void	setSigningAlgorithm(SigningAlgorithmSpec signingAlgorithm) The signing algorithm that was used to verify the signature.
void	setSigningAlgorithm(java.lang.String signingAlgorithm) The signing algorithm that was used to verify the signature.
java.lang.String	toString() Returns a string representation of this object; useful for testing and debugging.
VerifyResult	withKeyId(java.lang.String keyId) The Amazon Resource Name (key ARN) of the asymmetric CMK that was used to verify the signature.
VerifyResult	withSignatureValid(java.lang.Boolean signatureValid) A Boolean value that indicates whether the signature was verified.
VerifyResult	withSigningAlgorithm(SigningAlgorithmSpec signingAlgorithm) The signing algorithm that was used to verify the signature.
VerifyResult	withSigningAlgorithm(java.lang.String signingAlgorithm) The signing algorithm that was used to verify the signature.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

VerifyResult

public VerifyResult()

Method Detail

getKeyId

public java.lang.String getKeyId()

The Amazon Resource Name (key ARN) of the asymmetric CMK that was used to verify the signature.

Constraints:
Length: 1 - 2048

Returns:

The Amazon Resource Name (key ARN) of the asymmetric CMK that was used to verify the signature.

setKeyId

public void setKeyId(java.lang.String keyId)

The Amazon Resource Name (key ARN) of the asymmetric CMK that was used to verify the signature.

Constraints:
Length: 1 - 2048

Parameters:

keyId -

The Amazon Resource Name (key ARN) of the asymmetric CMK that was used to verify the signature.

withKeyId

public VerifyResult withKeyId(java.lang.String keyId)

The Amazon Resource Name (key ARN) of the asymmetric CMK that was used to verify the signature.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 2048

Parameters:

keyId -

The Amazon Resource Name (key ARN) of the asymmetric CMK that was used to verify the signature.

Returns:

A reference to this updated object so that method calls can be chained together.

isSignatureValid

public java.lang.Boolean isSignatureValid()

A Boolean value that indicates whether the signature was verified. A value of True indicates that the Signature was produced by signing the Message with the specified KeyID and SigningAlgorithm. If the signature is not verified, the Verify operation fails with a KMSInvalidSignatureException exception.

Returns:

A Boolean value that indicates whether the signature was verified. A value of True indicates that the Signature was produced by signing the Message with the specified KeyID and SigningAlgorithm. If the signature is not verified, the Verify operation fails with a KMSInvalidSignatureException exception.

getSignatureValid

public java.lang.Boolean getSignatureValid()

A Boolean value that indicates whether the signature was verified. A value of True indicates that the Signature was produced by signing the Message with the specified KeyID and SigningAlgorithm. If the signature is not verified, the Verify operation fails with a KMSInvalidSignatureException exception.

Returns:

A Boolean value that indicates whether the signature was verified. A value of True indicates that the Signature was produced by signing the Message with the specified KeyID and SigningAlgorithm. If the signature is not verified, the Verify operation fails with a KMSInvalidSignatureException exception.

setSignatureValid

public void setSignatureValid(java.lang.Boolean signatureValid)

A Boolean value that indicates whether the signature was verified. A value of True indicates that the Signature was produced by signing the Message with the specified KeyID and SigningAlgorithm. If the signature is not verified, the Verify operation fails with a KMSInvalidSignatureException exception.

Parameters:

signatureValid -

A Boolean value that indicates whether the signature was verified. A value of True indicates that the Signature was produced by signing the Message with the specified KeyID and SigningAlgorithm. If the signature is not verified, the Verify operation fails with a KMSInvalidSignatureException exception.

withSignatureValid

public VerifyResult withSignatureValid(java.lang.Boolean signatureValid)

A Boolean value that indicates whether the signature was verified. A value of True indicates that the Signature was produced by signing the Message with the specified KeyID and SigningAlgorithm. If the signature is not verified, the Verify operation fails with a KMSInvalidSignatureException exception.

Returns a reference to this object so that method calls can be chained together.

Parameters:

signatureValid -

A Boolean value that indicates whether the signature was verified. A value of True indicates that the Signature was produced by signing the Message with the specified KeyID and SigningAlgorithm. If the signature is not verified, the Verify operation fails with a KMSInvalidSignatureException exception.

Returns:

A reference to this updated object so that method calls can be chained together.

getSigningAlgorithm

public java.lang.String getSigningAlgorithm()

The signing algorithm that was used to verify the signature.

Constraints:
Allowed Values: RSASSA_PSS_SHA_256, RSASSA_PSS_SHA_384, RSASSA_PSS_SHA_512, RSASSA_PKCS1_V1_5_SHA_256, RSASSA_PKCS1_V1_5_SHA_384, RSASSA_PKCS1_V1_5_SHA_512, ECDSA_SHA_256, ECDSA_SHA_384, ECDSA_SHA_512

Returns:

The signing algorithm that was used to verify the signature.

See Also:

SigningAlgorithmSpec

setSigningAlgorithm

public void setSigningAlgorithm(java.lang.String signingAlgorithm)

The signing algorithm that was used to verify the signature.

Constraints:
Allowed Values: RSASSA_PSS_SHA_256, RSASSA_PSS_SHA_384, RSASSA_PSS_SHA_512, RSASSA_PKCS1_V1_5_SHA_256, RSASSA_PKCS1_V1_5_SHA_384, RSASSA_PKCS1_V1_5_SHA_512, ECDSA_SHA_256, ECDSA_SHA_384, ECDSA_SHA_512

Parameters:

signingAlgorithm -

The signing algorithm that was used to verify the signature.

See Also:

SigningAlgorithmSpec

withSigningAlgorithm

public VerifyResult withSigningAlgorithm(java.lang.String signingAlgorithm)

The signing algorithm that was used to verify the signature.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Allowed Values: RSASSA_PSS_SHA_256, RSASSA_PSS_SHA_384, RSASSA_PSS_SHA_512, RSASSA_PKCS1_V1_5_SHA_256, RSASSA_PKCS1_V1_5_SHA_384, RSASSA_PKCS1_V1_5_SHA_512, ECDSA_SHA_256, ECDSA_SHA_384, ECDSA_SHA_512

Parameters:

signingAlgorithm -

The signing algorithm that was used to verify the signature.

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

SigningAlgorithmSpec

setSigningAlgorithm

public void setSigningAlgorithm(SigningAlgorithmSpec signingAlgorithm)

The signing algorithm that was used to verify the signature.

Constraints:
Allowed Values: RSASSA_PSS_SHA_256, RSASSA_PSS_SHA_384, RSASSA_PSS_SHA_512, RSASSA_PKCS1_V1_5_SHA_256, RSASSA_PKCS1_V1_5_SHA_384, RSASSA_PKCS1_V1_5_SHA_512, ECDSA_SHA_256, ECDSA_SHA_384, ECDSA_SHA_512

Parameters:

signingAlgorithm -

The signing algorithm that was used to verify the signature.

See Also:

SigningAlgorithmSpec

withSigningAlgorithm

public VerifyResult withSigningAlgorithm(SigningAlgorithmSpec signingAlgorithm)

The signing algorithm that was used to verify the signature.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Allowed Values: RSASSA_PSS_SHA_256, RSASSA_PSS_SHA_384, RSASSA_PSS_SHA_512, RSASSA_PKCS1_V1_5_SHA_256, RSASSA_PKCS1_V1_5_SHA_384, RSASSA_PKCS1_V1_5_SHA_512, ECDSA_SHA_256, ECDSA_SHA_384, ECDSA_SHA_512

Parameters:

signingAlgorithm -

The signing algorithm that was used to verify the signature.

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

SigningAlgorithmSpec

toString

public java.lang.String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object