Class DukptEncryptionAttributes

java.lang.Object
software.amazon.awssdk.services.paymentcryptographydata.model.DukptEncryptionAttributes
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<DukptEncryptionAttributes.Builder,DukptEncryptionAttributes>
@Generated("software.amazon.awssdk:codegen") public final class DukptEncryptionAttributes extends Object implements SdkPojo, Serializable, ToCopyableBuilder<DukptEncryptionAttributes.Builder,DukptEncryptionAttributes>

Parameters that are required to encrypt plaintext data using DUKPT.

See Also:

  • Method Details

    • keySerialNumber

      public final String keySerialNumber()

      The unique identifier known as Key Serial Number (KSN) that comes from an encrypting device using DUKPT encryption method. The KSN is derived from the encrypting device unique identifier and an internal transaction counter.

      Returns:
      The unique identifier known as Key Serial Number (KSN) that comes from an encrypting device using DUKPT encryption method. The KSN is derived from the encrypting device unique identifier and an internal transaction counter.

    • mode

      public final DukptEncryptionMode mode()

      The block cipher method to use for encryption.

      The default is CBC.

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

      Returns:
      The block cipher method to use for encryption.

      The default is CBC.

      See Also:

    • modeAsString

      public final String modeAsString()

      The block cipher method to use for encryption.

      The default is CBC.

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

      Returns:
      The block cipher method to use for encryption.

      The default is CBC.

      See Also:

    • dukptKeyDerivationType

      public final DukptDerivationType dukptKeyDerivationType()

      The key type encrypted using DUKPT from a Base Derivation Key (BDK) and Key Serial Number (KSN). This must be less than or equal to the strength of the BDK. For example, you can't use AES_128 as a derivation type for a BDK of AES_128 or TDES_2KEY

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

      Returns:
      The key type encrypted using DUKPT from a Base Derivation Key (BDK) and Key Serial Number (KSN). This must be less than or equal to the strength of the BDK. For example, you can't use AES_128 as a derivation type for a BDK of AES_128 or TDES_2KEY
      See Also:

    • dukptKeyDerivationTypeAsString

      public final String dukptKeyDerivationTypeAsString()

      The key type encrypted using DUKPT from a Base Derivation Key (BDK) and Key Serial Number (KSN). This must be less than or equal to the strength of the BDK. For example, you can't use AES_128 as a derivation type for a BDK of AES_128 or TDES_2KEY

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

      Returns:
      The key type encrypted using DUKPT from a Base Derivation Key (BDK) and Key Serial Number (KSN). This must be less than or equal to the strength of the BDK. For example, you can't use AES_128 as a derivation type for a BDK of AES_128 or TDES_2KEY
      See Also:

    • dukptKeyVariant

      public final DukptKeyVariant dukptKeyVariant()

      The type of use of DUKPT, which can be incoming data decryption, outgoing data encryption, or both.

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

      Returns:
      The type of use of DUKPT, which can be incoming data decryption, outgoing data encryption, or both.
      See Also:

    • dukptKeyVariantAsString

      public final String dukptKeyVariantAsString()

      The type of use of DUKPT, which can be incoming data decryption, outgoing data encryption, or both.

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

      Returns:
      The type of use of DUKPT, which can be incoming data decryption, outgoing data encryption, or both.
      See Also:

    • initializationVector

      public final String initializationVector()

      An input used to provide the intial state. If no value is provided, Amazon Web Services Payment Cryptography defaults it to zero.

      Returns:
      An input used to provide the intial state. If no value is provided, Amazon Web Services Payment Cryptography defaults it to zero.

    • toBuilder

      public DukptEncryptionAttributes.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<DukptEncryptionAttributes.Builder,DukptEncryptionAttributes>
      Returns:
      a builder for type T

    • builder

      public static DukptEncryptionAttributes.Builder builder()

    • serializableBuilderClass

      public static Class<? extends DukptEncryptionAttributes.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.