DukptEncryptionAttributes (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.paymentcryptographydata.model.DukptEncryptionAttributes

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class DukptEncryptionAttributes
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Parameters that are required to encrypt plaintext data using DUKPT.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

DukptEncryptionAttributes()

Constructors
Constructor and Description
`DukptEncryptionAttributes()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DukptEncryptionAttributes`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getDukptKeyDerivationType()` The key type encrypted using DUKPT from a Base Derivation Key (BDK) and Key Serial Number (KSN).
`String`	`getDukptKeyVariant()` The type of use of DUKPT, which can be incoming data decryption, outgoing data encryption, or both.
`String`	`getInitializationVector()` An input to cryptographic primitive used to provide the intial state.
`String`	`getKeySerialNumber()` The unique identifier known as Key Serial Number (KSN) that comes from an encrypting device using DUKPT encryption method.
`String`	`getMode()` The block cipher mode of operation.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setDukptKeyDerivationType(String dukptKeyDerivationType)` The key type encrypted using DUKPT from a Base Derivation Key (BDK) and Key Serial Number (KSN).
`void`	`setDukptKeyVariant(String dukptKeyVariant)` The type of use of DUKPT, which can be incoming data decryption, outgoing data encryption, or both.
`void`	`setInitializationVector(String initializationVector)` An input to cryptographic primitive used to provide the intial state.
`void`	`setKeySerialNumber(String keySerialNumber)` The unique identifier known as Key Serial Number (KSN) that comes from an encrypting device using DUKPT encryption method.
`void`	`setMode(String mode)` The block cipher mode of operation.
`String`	`toString()` Returns a string representation of this object.
`DukptEncryptionAttributes`	`withDukptKeyDerivationType(DukptDerivationType dukptKeyDerivationType)` The key type encrypted using DUKPT from a Base Derivation Key (BDK) and Key Serial Number (KSN).
`DukptEncryptionAttributes`	`withDukptKeyDerivationType(String dukptKeyDerivationType)` The key type encrypted using DUKPT from a Base Derivation Key (BDK) and Key Serial Number (KSN).
`DukptEncryptionAttributes`	`withDukptKeyVariant(DukptKeyVariant dukptKeyVariant)` The type of use of DUKPT, which can be incoming data decryption, outgoing data encryption, or both.
`DukptEncryptionAttributes`	`withDukptKeyVariant(String dukptKeyVariant)` The type of use of DUKPT, which can be incoming data decryption, outgoing data encryption, or both.
`DukptEncryptionAttributes`	`withInitializationVector(String initializationVector)` An input to cryptographic primitive used to provide the intial state.
`DukptEncryptionAttributes`	`withKeySerialNumber(String keySerialNumber)` The unique identifier known as Key Serial Number (KSN) that comes from an encrypting device using DUKPT encryption method.
`DukptEncryptionAttributes`	`withMode(DukptEncryptionMode mode)` The block cipher mode of operation.
`DukptEncryptionAttributes`	`withMode(String mode)` The block cipher mode of operation.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - DukptEncryptionAttributes
```
public DukptEncryptionAttributes()
```
- Method Detail
  - setDukptKeyDerivationType
```
public void setDukptKeyDerivationType(String dukptKeyDerivationType)
```
    The key type encrypted 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
    
    Parameters:
    
    dukptKeyDerivationType - The key type encrypted 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
  - getDukptKeyDerivationType
```
public String getDukptKeyDerivationType()
```
    The key type encrypted 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
    
    Returns:
    
    The key type encrypted 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
  - withDukptKeyDerivationType
```
public DukptEncryptionAttributes withDukptKeyDerivationType(String dukptKeyDerivationType)
```
    The key type encrypted 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
    
    Parameters:
    
    dukptKeyDerivationType - The key type encrypted 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
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    DukptDerivationType
  - withDukptKeyDerivationType
```
public DukptEncryptionAttributes withDukptKeyDerivationType(DukptDerivationType dukptKeyDerivationType)
```
    The key type encrypted 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
    
    Parameters:
    
    dukptKeyDerivationType - The key type encrypted 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
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    DukptDerivationType
  - setDukptKeyVariant
```
public void setDukptKeyVariant(String dukptKeyVariant)
```
    The type of use of DUKPT, which can be incoming data decryption, outgoing data encryption, or both.
    
    Parameters:
    
    dukptKeyVariant - The type of use of DUKPT, which can be incoming data decryption, outgoing data encryption, or both.
    
    See Also:
    
    DukptKeyVariant
  - getDukptKeyVariant
```
public String getDukptKeyVariant()
```
    The type of use of DUKPT, which can be incoming data decryption, outgoing data encryption, or both.
    
    Returns:
    
    The type of use of DUKPT, which can be incoming data decryption, outgoing data encryption, or both.
    
    See Also:
    
    DukptKeyVariant
  - withDukptKeyVariant
```
public DukptEncryptionAttributes withDukptKeyVariant(String dukptKeyVariant)
```
    The type of use of DUKPT, which can be incoming data decryption, outgoing data encryption, or both.
    
    Parameters:
    
    dukptKeyVariant - The type of use of DUKPT, which can be incoming data decryption, outgoing data encryption, or both.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    DukptKeyVariant
  - withDukptKeyVariant
```
public DukptEncryptionAttributes withDukptKeyVariant(DukptKeyVariant dukptKeyVariant)
```
    The type of use of DUKPT, which can be incoming data decryption, outgoing data encryption, or both.
    
    Parameters:
    
    dukptKeyVariant - The type of use of DUKPT, which can be incoming data decryption, outgoing data encryption, or both.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    DukptKeyVariant
  - setInitializationVector
```
public void setInitializationVector(String initializationVector)
```
    An input to cryptographic primitive used to provide the intial state. Typically the InitializationVector must have a random or psuedo-random value, but sometimes it only needs to be unpredictable or unique. If you don't provide a value, Amazon Web Services Payment Cryptography generates a random value.
    
    Parameters:
    
    initializationVector - An input to cryptographic primitive used to provide the intial state. Typically the InitializationVector must have a random or psuedo-random value, but sometimes it only needs to be unpredictable or unique. If you don't provide a value, Amazon Web Services Payment Cryptography generates a random value.
  - getInitializationVector
```
public String getInitializationVector()
```
    An input to cryptographic primitive used to provide the intial state. Typically the InitializationVector must have a random or psuedo-random value, but sometimes it only needs to be unpredictable or unique. If you don't provide a value, Amazon Web Services Payment Cryptography generates a random value.
    
    Returns:
    
    An input to cryptographic primitive used to provide the intial state. Typically the InitializationVector must have a random or psuedo-random value, but sometimes it only needs to be unpredictable or unique. If you don't provide a value, Amazon Web Services Payment Cryptography generates a random value.
  - withInitializationVector
```
public DukptEncryptionAttributes withInitializationVector(String initializationVector)
```
    An input to cryptographic primitive used to provide the intial state. Typically the InitializationVector must have a random or psuedo-random value, but sometimes it only needs to be unpredictable or unique. If you don't provide a value, Amazon Web Services Payment Cryptography generates a random value.
    
    Parameters:
    
    initializationVector - An input to cryptographic primitive used to provide the intial state. Typically the InitializationVector must have a random or psuedo-random value, but sometimes it only needs to be unpredictable or unique. If you don't provide a value, Amazon Web Services Payment Cryptography generates a random value.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setKeySerialNumber
```
public void setKeySerialNumber(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.
    
    Parameters:
    
    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.
  - getKeySerialNumber
```
public String getKeySerialNumber()
```
    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.
  - withKeySerialNumber
```
public DukptEncryptionAttributes withKeySerialNumber(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setMode
```
public void setMode(String mode)
```
    The block cipher mode of operation. Block ciphers are designed to encrypt a block of data of fixed size, for example, 128 bits. The size of the input block is usually same as the size of the encrypted output block, while the key length can be different. A mode of operation describes how to repeatedly apply a cipher's single-block operation to securely transform amounts of data larger than a block.
    
    The default is CBC.
    
    Parameters:
    
    mode - The block cipher mode of operation. Block ciphers are designed to encrypt a block of data of fixed size, for example, 128 bits. The size of the input block is usually same as the size of the encrypted output block, while the key length can be different. A mode of operation describes how to repeatedly apply a cipher's single-block operation to securely transform amounts of data larger than a block.
    
    The default is CBC.
    
    See Also:
    
    DukptEncryptionMode
  - getMode
```
public String getMode()
```
    The block cipher mode of operation. Block ciphers are designed to encrypt a block of data of fixed size, for example, 128 bits. The size of the input block is usually same as the size of the encrypted output block, while the key length can be different. A mode of operation describes how to repeatedly apply a cipher's single-block operation to securely transform amounts of data larger than a block.
    
    The default is CBC.
    
    Returns:
    
    The block cipher mode of operation. Block ciphers are designed to encrypt a block of data of fixed size, for example, 128 bits. The size of the input block is usually same as the size of the encrypted output block, while the key length can be different. A mode of operation describes how to repeatedly apply a cipher's single-block operation to securely transform amounts of data larger than a block.
    
    The default is CBC.
    
    See Also:
    
    DukptEncryptionMode
  - withMode
```
public DukptEncryptionAttributes withMode(String mode)
```
    The block cipher mode of operation. Block ciphers are designed to encrypt a block of data of fixed size, for example, 128 bits. The size of the input block is usually same as the size of the encrypted output block, while the key length can be different. A mode of operation describes how to repeatedly apply a cipher's single-block operation to securely transform amounts of data larger than a block.
    
    The default is CBC.
    
    Parameters:
    
    mode - The block cipher mode of operation. Block ciphers are designed to encrypt a block of data of fixed size, for example, 128 bits. The size of the input block is usually same as the size of the encrypted output block, while the key length can be different. A mode of operation describes how to repeatedly apply a cipher's single-block operation to securely transform amounts of data larger than a block.
    
    The default is CBC.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    DukptEncryptionMode
  - withMode
```
public DukptEncryptionAttributes withMode(DukptEncryptionMode mode)
```
    The block cipher mode of operation. Block ciphers are designed to encrypt a block of data of fixed size, for example, 128 bits. The size of the input block is usually same as the size of the encrypted output block, while the key length can be different. A mode of operation describes how to repeatedly apply a cipher's single-block operation to securely transform amounts of data larger than a block.
    
    The default is CBC.
    
    Parameters:
    
    mode - The block cipher mode of operation. Block ciphers are designed to encrypt a block of data of fixed size, for example, 128 bits. The size of the input block is usually same as the size of the encrypted output block, while the key length can be different. A mode of operation describes how to repeatedly apply a cipher's single-block operation to securely transform amounts of data larger than a block.
    
    The default is CBC.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    DukptEncryptionMode
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public DukptEncryptionAttributes clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.496

Class DukptEncryptionAttributes

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DukptEncryptionAttributes

Method Detail

setDukptKeyDerivationType

getDukptKeyDerivationType

withDukptKeyDerivationType

withDukptKeyDerivationType

setDukptKeyVariant

getDukptKeyVariant

withDukptKeyVariant

withDukptKeyVariant

setInitializationVector

getInitializationVector

withInitializationVector

setKeySerialNumber

getKeySerialNumber

withKeySerialNumber

setMode

getMode

withMode

withMode

toString

equals

hashCode

clone

marshall