Class KeyBlockHeaders

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

Optional metadata for export associated with the key material. This data is signed but transmitted in clear text.

See Also:

  • Method Details

    • keyModesOfUse

      public final KeyModesOfUse keyModesOfUse()
      Returns the value of the KeyModesOfUse property for this object.
      Returns:
      The value of the KeyModesOfUse property for this object.

    • keyExportability

      public final KeyExportability keyExportability()

      Specifies subsequent exportability of the key within the key block after it is received by the receiving party. It can be used to further restrict exportability of the key after export from Amazon Web Services Payment Cryptography.

      When set to EXPORTABLE, the key can be subsequently exported by the receiver under a KEK using TR-31 or TR-34 key block export only. When set to NON_EXPORTABLE, the key cannot be subsequently exported by the receiver. When set to SENSITIVE, the key can be exported by the receiver under a KEK using TR-31, TR-34, RSA wrap and unwrap cryptogram or using a symmetric cryptogram key export method. For further information refer to ANSI X9.143-2022.

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

      Returns:
      Specifies subsequent exportability of the key within the key block after it is received by the receiving party. It can be used to further restrict exportability of the key after export from Amazon Web Services Payment Cryptography.

      When set to EXPORTABLE, the key can be subsequently exported by the receiver under a KEK using TR-31 or TR-34 key block export only. When set to NON_EXPORTABLE, the key cannot be subsequently exported by the receiver. When set to SENSITIVE, the key can be exported by the receiver under a KEK using TR-31, TR-34, RSA wrap and unwrap cryptogram or using a symmetric cryptogram key export method. For further information refer to ANSI X9.143-2022.

      See Also:

    • keyExportabilityAsString

      public final String keyExportabilityAsString()

      Specifies subsequent exportability of the key within the key block after it is received by the receiving party. It can be used to further restrict exportability of the key after export from Amazon Web Services Payment Cryptography.

      When set to EXPORTABLE, the key can be subsequently exported by the receiver under a KEK using TR-31 or TR-34 key block export only. When set to NON_EXPORTABLE, the key cannot be subsequently exported by the receiver. When set to SENSITIVE, the key can be exported by the receiver under a KEK using TR-31, TR-34, RSA wrap and unwrap cryptogram or using a symmetric cryptogram key export method. For further information refer to ANSI X9.143-2022.

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

      Returns:
      Specifies subsequent exportability of the key within the key block after it is received by the receiving party. It can be used to further restrict exportability of the key after export from Amazon Web Services Payment Cryptography.

      When set to EXPORTABLE, the key can be subsequently exported by the receiver under a KEK using TR-31 or TR-34 key block export only. When set to NON_EXPORTABLE, the key cannot be subsequently exported by the receiver. When set to SENSITIVE, the key can be exported by the receiver under a KEK using TR-31, TR-34, RSA wrap and unwrap cryptogram or using a symmetric cryptogram key export method. For further information refer to ANSI X9.143-2022.

      See Also:

    • keyVersion

      public final String keyVersion()

      Parameter used to indicate the version of the key carried in the key block or indicate the value carried in the key block is a component of a key.

      Returns:
      Parameter used to indicate the version of the key carried in the key block or indicate the value carried in the key block is a component of a key.

    • hasOptionalBlocks

      public final boolean hasOptionalBlocks()
      For responses, this returns true if the service returned a value for the OptionalBlocks property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • optionalBlocks

      public final Map<String,String> optionalBlocks()

      Parameter used to indicate the type of optional data in key block headers. Refer to ANSI X9.143-2022 for information on allowed data type for optional blocks.

      Optional block character limit is 112 characters. For each optional block, 2 characters are reserved for optional block ID and 2 characters reserved for optional block length. More than one optional blocks can be included as long as the combined length does not increase 112 characters.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasOptionalBlocks() method.

      Returns:
      Parameter used to indicate the type of optional data in key block headers. Refer to ANSI X9.143-2022 for information on allowed data type for optional blocks.

      Optional block character limit is 112 characters. For each optional block, 2 characters are reserved for optional block ID and 2 characters reserved for optional block length. More than one optional blocks can be included as long as the combined length does not increase 112 characters.

    • toBuilder

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

    • builder

      public static KeyBlockHeaders.Builder builder()

    • serializableBuilderClass

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