Class EcdhDerivationAttributes

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

Parameters required to establish ECDH based key exchange.

See Also:

  • Method Details

    • certificateAuthorityPublicKeyIdentifier

      public final String certificateAuthorityPublicKeyIdentifier()

      The keyArn of the certificate that signed the client's PublicKeyCertificate.

      Returns:
      The keyArn of the certificate that signed the client's PublicKeyCertificate.

    • publicKeyCertificate

      public final String publicKeyCertificate()

      The client's public key certificate in PEM format (base64 encoded) to use for ECDH key derivation.

      Returns:
      The client's public key certificate in PEM format (base64 encoded) to use for ECDH key derivation.

    • keyAlgorithm

      public final SymmetricKeyAlgorithm keyAlgorithm()

      The key algorithm of the derived ECDH key.

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

      Returns:
      The key algorithm of the derived ECDH key.
      See Also:

    • keyAlgorithmAsString

      public final String keyAlgorithmAsString()

      The key algorithm of the derived ECDH key.

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

      Returns:
      The key algorithm of the derived ECDH key.
      See Also:

    • keyDerivationFunction

      public final KeyDerivationFunction keyDerivationFunction()

      The key derivation function to use for deriving a key using ECDH.

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

      Returns:
      The key derivation function to use for deriving a key using ECDH.
      See Also:

    • keyDerivationFunctionAsString

      public final String keyDerivationFunctionAsString()

      The key derivation function to use for deriving a key using ECDH.

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

      Returns:
      The key derivation function to use for deriving a key using ECDH.
      See Also:

    • keyDerivationHashAlgorithm

      public final KeyDerivationHashAlgorithm keyDerivationHashAlgorithm()

      The hash type to use for deriving a key using ECDH.

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

      Returns:
      The hash type to use for deriving a key using ECDH.
      See Also:

    • keyDerivationHashAlgorithmAsString

      public final String keyDerivationHashAlgorithmAsString()

      The hash type to use for deriving a key using ECDH.

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

      Returns:
      The hash type to use for deriving a key using ECDH.
      See Also:

    • sharedInformation

      public final String sharedInformation()

      A byte 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, and re-using shared information for multiple ECDH key derivations is not recommended.

      Returns:
      A byte 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, and re-using shared information for multiple ECDH key derivations is not recommended.

    • toBuilder

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

    • builder

      public static EcdhDerivationAttributes.Builder builder()

    • serializableBuilderClass

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