Class DiffieHellmanDerivationData

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

The shared information used when deriving a key using ECDH.

See Also:

  • Method Details

    • sharedInformation

      public final String sharedInformation()

      A string containing information that binds the ECDH derived key to the two parties involved or to the context of the key.

      It may include details like identities of the two parties deriving the key, context of the operation, session IDs, and optionally a nonce. It must not contain zero bytes. It is not recommended to reuse shared information for multiple ECDH key derivations, as it could result in derived key material being the same across different derivations.

      Returns:
      A string containing information that binds the ECDH derived key to the two parties involved or to the context of the key.

      It may include details like identities of the two parties deriving the key, context of the operation, session IDs, and optionally a nonce. It must not contain zero bytes. It is not recommended to reuse shared information for multiple ECDH key derivations, as it could result in derived key material being the same across different derivations.

    • toBuilder

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

    • builder

      public static DiffieHellmanDerivationData.Builder builder()

    • serializableBuilderClass

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

    • fromSharedInformation

      public static DiffieHellmanDerivationData fromSharedInformation(String sharedInformation)
      Create an instance of this class with sharedInformation() initialized to the given value.

      A string containing information that binds the ECDH derived key to the two parties involved or to the context of the key.

      It may include details like identities of the two parties deriving the key, context of the operation, session IDs, and optionally a nonce. It must not contain zero bytes. It is not recommended to reuse shared information for multiple ECDH key derivations, as it could result in derived key material being the same across different derivations.

      Parameters:
      sharedInformation - A string containing information that binds the ECDH derived key to the two parties involved or to the context of the key.

      It may include details like identities of the two parties deriving the key, context of the operation, session IDs, and optionally a nonce. It must not contain zero bytes. It is not recommended to reuse shared information for multiple ECDH key derivations, as it could result in derived key material being the same across different derivations.

    • type

      public DiffieHellmanDerivationData.Type type()
      Retrieve an enum value representing which member of this object is populated. When this class is returned in a service response, this will be DiffieHellmanDerivationData.Type.UNKNOWN_TO_SDK_VERSION if the service returned a member that is only known to a newer SDK version. When this class is created directly in your code, this will be DiffieHellmanDerivationData.Type.UNKNOWN_TO_SDK_VERSION if zero members are set, and null if more than one member is set.

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