com.amazonaws.services.paymentcryptographydata.model

Class WrappedKey

java.lang.Object

com.amazonaws.services.paymentcryptographydata.model.WrappedKey

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class WrappedKey
extends Object
implements Serializable, Cloneable, StructuredPojo

Parameter information of a WrappedKeyBlock for encryption key exchange.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
WrappedKey()

Method Summary

Modifier and Type	Method and Description
WrappedKey	clone()
boolean	equals(Object obj)
String	getKeyCheckValueAlgorithm() The algorithm that Amazon Web Services Payment Cryptography uses to calculate the key check value (KCV).
WrappedKeyMaterial	getWrappedKeyMaterial() Parameter information of a WrappedKeyBlock for encryption key exchange.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setKeyCheckValueAlgorithm(String keyCheckValueAlgorithm) The algorithm that Amazon Web Services Payment Cryptography uses to calculate the key check value (KCV).
void	setWrappedKeyMaterial(WrappedKeyMaterial wrappedKeyMaterial) Parameter information of a WrappedKeyBlock for encryption key exchange.
String	toString() Returns a string representation of this object.
WrappedKey	withKeyCheckValueAlgorithm(KeyCheckValueAlgorithm keyCheckValueAlgorithm) The algorithm that Amazon Web Services Payment Cryptography uses to calculate the key check value (KCV).
WrappedKey	withKeyCheckValueAlgorithm(String keyCheckValueAlgorithm) The algorithm that Amazon Web Services Payment Cryptography uses to calculate the key check value (KCV).
WrappedKey	withWrappedKeyMaterial(WrappedKeyMaterial wrappedKeyMaterial) Parameter information of a WrappedKeyBlock for encryption key exchange.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

WrappedKey

public WrappedKey()

Method Detail

setWrappedKeyMaterial

public void setWrappedKeyMaterial(WrappedKeyMaterial wrappedKeyMaterial)

Parameter information of a WrappedKeyBlock for encryption key exchange.

Parameters:

wrappedKeyMaterial - Parameter information of a WrappedKeyBlock for encryption key exchange.

getWrappedKeyMaterial

public WrappedKeyMaterial getWrappedKeyMaterial()

Parameter information of a WrappedKeyBlock for encryption key exchange.

Returns:

Parameter information of a WrappedKeyBlock for encryption key exchange.

withWrappedKeyMaterial

public WrappedKey withWrappedKeyMaterial(WrappedKeyMaterial wrappedKeyMaterial)

Parameter information of a WrappedKeyBlock for encryption key exchange.

Parameters:

wrappedKeyMaterial - Parameter information of a WrappedKeyBlock for encryption key exchange.

Returns:

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

setKeyCheckValueAlgorithm

public void setKeyCheckValueAlgorithm(String keyCheckValueAlgorithm)

The algorithm that Amazon Web Services Payment Cryptography uses to calculate the key check value (KCV). It is used to validate the key integrity.

For TDES keys, the KCV is computed by encrypting 8 bytes, each with value of zero, with the key to be checked and retaining the 3 highest order bytes of the encrypted result. For AES keys, the KCV is computed using a CMAC algorithm where the input data is 16 bytes of zero and retaining the 3 highest order bytes of the encrypted result.

Parameters:

keyCheckValueAlgorithm - The algorithm that Amazon Web Services Payment Cryptography uses to calculate the key check value (KCV). It is used to validate the key integrity.

For TDES keys, the KCV is computed by encrypting 8 bytes, each with value of zero, with the key to be checked and retaining the 3 highest order bytes of the encrypted result. For AES keys, the KCV is computed using a CMAC algorithm where the input data is 16 bytes of zero and retaining the 3 highest order bytes of the encrypted result.

See Also:

KeyCheckValueAlgorithm

getKeyCheckValueAlgorithm

public String getKeyCheckValueAlgorithm()

The algorithm that Amazon Web Services Payment Cryptography uses to calculate the key check value (KCV). It is used to validate the key integrity.

For TDES keys, the KCV is computed by encrypting 8 bytes, each with value of zero, with the key to be checked and retaining the 3 highest order bytes of the encrypted result. For AES keys, the KCV is computed using a CMAC algorithm where the input data is 16 bytes of zero and retaining the 3 highest order bytes of the encrypted result.

Returns:

The algorithm that Amazon Web Services Payment Cryptography uses to calculate the key check value (KCV). It is used to validate the key integrity.

For TDES keys, the KCV is computed by encrypting 8 bytes, each with value of zero, with the key to be checked and retaining the 3 highest order bytes of the encrypted result. For AES keys, the KCV is computed using a CMAC algorithm where the input data is 16 bytes of zero and retaining the 3 highest order bytes of the encrypted result.

See Also:

KeyCheckValueAlgorithm

withKeyCheckValueAlgorithm

public WrappedKey withKeyCheckValueAlgorithm(String keyCheckValueAlgorithm)

The algorithm that Amazon Web Services Payment Cryptography uses to calculate the key check value (KCV). It is used to validate the key integrity.

For TDES keys, the KCV is computed by encrypting 8 bytes, each with value of zero, with the key to be checked and retaining the 3 highest order bytes of the encrypted result. For AES keys, the KCV is computed using a CMAC algorithm where the input data is 16 bytes of zero and retaining the 3 highest order bytes of the encrypted result.

Parameters:

keyCheckValueAlgorithm - The algorithm that Amazon Web Services Payment Cryptography uses to calculate the key check value (KCV). It is used to validate the key integrity.

For TDES keys, the KCV is computed by encrypting 8 bytes, each with value of zero, with the key to be checked and retaining the 3 highest order bytes of the encrypted result. For AES keys, the KCV is computed using a CMAC algorithm where the input data is 16 bytes of zero and retaining the 3 highest order bytes of the encrypted result.

Returns:

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

See Also:

KeyCheckValueAlgorithm

withKeyCheckValueAlgorithm

public WrappedKey withKeyCheckValueAlgorithm(KeyCheckValueAlgorithm keyCheckValueAlgorithm)

The algorithm that Amazon Web Services Payment Cryptography uses to calculate the key check value (KCV). It is used to validate the key integrity.

For TDES keys, the KCV is computed by encrypting 8 bytes, each with value of zero, with the key to be checked and retaining the 3 highest order bytes of the encrypted result. For AES keys, the KCV is computed using a CMAC algorithm where the input data is 16 bytes of zero and retaining the 3 highest order bytes of the encrypted result.

Parameters:

keyCheckValueAlgorithm - The algorithm that Amazon Web Services Payment Cryptography uses to calculate the key check value (KCV). It is used to validate the key integrity.

For TDES keys, the KCV is computed by encrypting 8 bytes, each with value of zero, with the key to be checked and retaining the 3 highest order bytes of the encrypted result. For AES keys, the KCV is computed using a CMAC algorithm where the input data is 16 bytes of zero and retaining the 3 highest order bytes of the encrypted result.

Returns:

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

See Also:

KeyCheckValueAlgorithm

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public WrappedKey clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.