Package software.amazon.awssdk.services.paymentcryptographydata.model

Class EmvCommonAttributes

java.lang.Object

software.amazon.awssdk.services.paymentcryptographydata.model.EmvCommonAttributes

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<EmvCommonAttributes.Builder,EmvCommonAttributes>

@Generated("software.amazon.awssdk:codegen")
public final class EmvCommonAttributes
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<EmvCommonAttributes.Builder,EmvCommonAttributes>

Parameters to derive the confidentiality and integrity keys for an Emv common payment card.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	EmvCommonAttributes.Builder

Method Summary

Modifier and Type	Method	Description
String	applicationCryptogram()	The application cryptogram for the current transaction that is provided by the terminal during transaction processing.
static EmvCommonAttributes.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
MajorKeyDerivationMode	majorKeyDerivationMode()	The method to use when deriving the master key for the payment card.
String	majorKeyDerivationModeAsString()	The method to use when deriving the master key for the payment card.
EmvEncryptionMode	mode()	The block cipher method to use for encryption.
String	modeAsString()	The block cipher method to use for encryption.
String	panSequenceNumber()	A number that identifies and differentiates payment cards with the same Primary Account Number (PAN).
PinBlockLengthPosition	pinBlockLengthPosition()	Specifies if PIN block length should be added to front of the pin block.
String	pinBlockLengthPositionAsString()	Specifies if PIN block length should be added to front of the pin block.
PinBlockPaddingType	pinBlockPaddingType()	The padding to be added to the PIN block prior to encryption.
String	pinBlockPaddingTypeAsString()	The padding to be added to the PIN block prior to encryption.
String	primaryAccountNumber()	The Primary Account Number (PAN) of the cardholder.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends EmvCommonAttributes.Builder>	serializableBuilderClass()
EmvCommonAttributes.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

majorKeyDerivationMode

public final MajorKeyDerivationMode majorKeyDerivationMode()

The method to use when deriving the master key for the payment card.

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

Returns:

The method to use when deriving the master key for the payment card.

See Also:

MajorKeyDerivationMode

majorKeyDerivationModeAsString

public final String majorKeyDerivationModeAsString()

The method to use when deriving the master key for the payment card.

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

Returns:

The method to use when deriving the master key for the payment card.

See Also:

MajorKeyDerivationMode

primaryAccountNumber

public final String primaryAccountNumber()

The Primary Account Number (PAN) of the cardholder.

Returns:

The Primary Account Number (PAN) of the cardholder.

panSequenceNumber

public final String panSequenceNumber()

A number that identifies and differentiates payment cards with the same Primary Account Number (PAN). Typically 00 is used, if no value is provided by the terminal.

Returns:

A number that identifies and differentiates payment cards with the same Primary Account Number (PAN). Typically 00 is used, if no value is provided by the terminal.

applicationCryptogram

public final String applicationCryptogram()

The application cryptogram for the current transaction that is provided by the terminal during transaction processing.

Returns:

The application cryptogram for the current transaction that is provided by the terminal during transaction processing.

mode

public final EmvEncryptionMode mode()

The block cipher method to use for encryption.

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

Returns:

The block cipher method to use for encryption.

See Also:

EmvEncryptionMode

modeAsString

public final String modeAsString()

The block cipher method to use for encryption.

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

Returns:

The block cipher method to use for encryption.

See Also:

EmvEncryptionMode

pinBlockPaddingType

public final PinBlockPaddingType pinBlockPaddingType()

The padding to be added to the PIN block prior to encryption.

Padding type should be ISO_IEC_7816_4, if PinBlockLengthPosition is set to FRONT_OF_PIN_BLOCK. No padding is required, if PinBlockLengthPosition is set to NONE.

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

Returns:

The padding to be added to the PIN block prior to encryption.

Padding type should be ISO_IEC_7816_4, if PinBlockLengthPosition is set to FRONT_OF_PIN_BLOCK. No padding is required, if PinBlockLengthPosition is set to NONE.

See Also:

PinBlockPaddingType

pinBlockPaddingTypeAsString

public final String pinBlockPaddingTypeAsString()

The padding to be added to the PIN block prior to encryption.

Padding type should be ISO_IEC_7816_4, if PinBlockLengthPosition is set to FRONT_OF_PIN_BLOCK. No padding is required, if PinBlockLengthPosition is set to NONE.

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

Returns:

The padding to be added to the PIN block prior to encryption.

Padding type should be ISO_IEC_7816_4, if PinBlockLengthPosition is set to FRONT_OF_PIN_BLOCK. No padding is required, if PinBlockLengthPosition is set to NONE.

See Also:

PinBlockPaddingType

pinBlockLengthPosition

public final PinBlockLengthPosition pinBlockLengthPosition()

Specifies if PIN block length should be added to front of the pin block.

If value is set to FRONT_OF_PIN_BLOCK, then PIN block padding type should be ISO_IEC_7816_4.

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

Returns:

Specifies if PIN block length should be added to front of the pin block.

If value is set to FRONT_OF_PIN_BLOCK, then PIN block padding type should be ISO_IEC_7816_4.

See Also:

PinBlockLengthPosition

pinBlockLengthPositionAsString

public final String pinBlockLengthPositionAsString()

Specifies if PIN block length should be added to front of the pin block.

If value is set to FRONT_OF_PIN_BLOCK, then PIN block padding type should be ISO_IEC_7816_4.

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

Returns:

Specifies if PIN block length should be added to front of the pin block.

If value is set to FRONT_OF_PIN_BLOCK, then PIN block padding type should be ISO_IEC_7816_4.

See Also:

PinBlockLengthPosition

toBuilder

public EmvCommonAttributes.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<EmvCommonAttributes.Builder,EmvCommonAttributes>

builder

public static EmvCommonAttributes.Builder builder()

serializableBuilderClass

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

Specified by:

equalsBySdkFields in interface SdkPojo

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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo