Class WrappedKey

java.lang.Object
software.amazon.awssdk.services.paymentcryptography.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 for generating a WrappedKeyBlock for key exchange.

See Also:

  • Method Details

    • wrappingKeyArn

      public final String wrappingKeyArn()

      The KeyARN of the wrapped key.

      Returns:
      The KeyARN of the wrapped key.

    • wrappedKeyMaterialFormat

      public final WrappedKeyMaterialFormat wrappedKeyMaterialFormat()

      The key block format of a wrapped key.

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

      Returns:
      The key block format of a wrapped key.
      See Also:

    • wrappedKeyMaterialFormatAsString

      public final String wrappedKeyMaterialFormatAsString()

      The key block format of a wrapped key.

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

      Returns:
      The key block format of a wrapped key.
      See Also:

    • keyMaterial

      public final String keyMaterial()

      Parameter information for generating a wrapped key using TR-31 or TR-34 skey exchange method.

      Returns:
      Parameter information for generating a wrapped key using TR-31 or TR-34 skey exchange method.

    • keyCheckValue

      public final String keyCheckValue()

      The key check value (KCV) is used to check if all parties holding a given key have the same key or to detect that a key has changed.

      Returns:
      The key check value (KCV) is used to check if all parties holding a given key have the same key or to detect that a key has changed.

    • 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:

    • 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:

    • toBuilder

      public WrappedKey.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<WrappedKey.Builder,WrappedKey>
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.