Package software.amazon.awssdk.services.paymentcryptographydata.model

Class WrappedKey

java.lang.Object

software.amazon.awssdk.services.paymentcryptographydata.model.WrappedKey

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<WrappedKey.Builder,WrappedKey>

@Generated("software.amazon.awssdk:codegen")
public final class WrappedKey
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<WrappedKey.Builder,WrappedKey>

Parameter information of a WrappedKeyBlock for encryption key exchange.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	WrappedKey.Builder

Method Summary

Modifier and Type	Method	Description
static WrappedKey.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
KeyCheckValueAlgorithm	keyCheckValueAlgorithm()	The algorithm that Amazon Web Services Payment Cryptography uses to calculate the key check value (KCV).
String	keyCheckValueAlgorithmAsString()	The algorithm that Amazon Web Services Payment Cryptography uses to calculate the key check value (KCV).
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends WrappedKey.Builder>	serializableBuilderClass()
WrappedKey.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
WrappedKeyMaterial	wrappedKeyMaterial()	Parameter information of a WrappedKeyBlock for encryption key exchange.

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

wrappedKeyMaterial

public final WrappedKeyMaterial wrappedKeyMaterial()

Parameter information of a WrappedKeyBlock for encryption key exchange.

Returns:

Parameter information of a WrappedKeyBlock for encryption key exchange.

keyCheckValueAlgorithm

public final 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.

If the service returns an enum value that is not available in the current SDK version, keyCheckValueAlgorithm will return KeyCheckValueAlgorithm.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from keyCheckValueAlgorithmAsString().

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

keyCheckValueAlgorithmAsString

public final String keyCheckValueAlgorithmAsString()

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.

If the service returns an enum value that is not available in the current SDK version, keyCheckValueAlgorithm will return KeyCheckValueAlgorithm.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from keyCheckValueAlgorithmAsString().

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

toBuilder

public WrappedKey.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<WrappedKey.Builder,WrappedKey>

builder

public static WrappedKey.Builder builder()

serializableBuilderClass

public static Class<? extends WrappedKey.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo