software.amazon.awssdk.services.paymentcryptographydata.model

Class MacAlgorithmDukpt

java.lang.Object

software.amazon.awssdk.services.paymentcryptographydata.model.MacAlgorithmDukpt

All Implemented Interfaces:

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

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

Parameters required for DUKPT MAC generation and verification.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	MacAlgorithmDukpt.Builder

Method Summary

Modifier and Type	Method and Description
static MacAlgorithmDukpt.Builder	builder()
DukptDerivationType	dukptDerivationType() The key type derived using DUKPT from a Base Derivation Key (BDK) and Key Serial Number (KSN).
String	dukptDerivationTypeAsString() The key type derived using DUKPT from a Base Derivation Key (BDK) and Key Serial Number (KSN).
DukptKeyVariant	dukptKeyVariant() The type of use of DUKPT, which can be MAC generation, MAC verification, or both.
String	dukptKeyVariantAsString() The type of use of DUKPT, which can be MAC generation, MAC verification, or both.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	keySerialNumber() The unique identifier known as Key Serial Number (KSN) that comes from an encrypting device using DUKPT encryption method.
List<SdkField<?>>	sdkFields()
static Class<? extends MacAlgorithmDukpt.Builder>	serializableBuilderClass()
MacAlgorithmDukpt.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

dukptDerivationType

public final DukptDerivationType dukptDerivationType()

The key type derived 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, dukptDerivationType will return DukptDerivationType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from dukptDerivationTypeAsString().

Returns:

The key type derived 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:

DukptDerivationType

dukptDerivationTypeAsString

public final String dukptDerivationTypeAsString()

The key type derived 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, dukptDerivationType will return DukptDerivationType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from dukptDerivationTypeAsString().

Returns:

The key type derived 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:

DukptDerivationType

dukptKeyVariant

public final DukptKeyVariant dukptKeyVariant()

The type of use of DUKPT, which can be MAC generation, MAC verification, 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 MAC generation, MAC verification, or both.

See Also:

DukptKeyVariant

dukptKeyVariantAsString

public final String dukptKeyVariantAsString()

The type of use of DUKPT, which can be MAC generation, MAC verification, 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 MAC generation, MAC verification, or both.

See Also:

DukptKeyVariant

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.

toBuilder

public MacAlgorithmDukpt.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<MacAlgorithmDukpt.Builder,MacAlgorithmDukpt>

builder

public static MacAlgorithmDukpt.Builder builder()

serializableBuilderClass

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