RawKeyring.Builder (Amazon S3 Encryption Client 3.5.0 API)

java.lang.Object
- software.amazon.encryption.s3.materials.S3Keyring.Builder<KeyringT,BuilderT>
- - software.amazon.encryption.s3.materials.RawKeyring.Builder<KeyringT,BuilderT,T>

Type Parameters:

KeyringT - the type of keyring being built

BuilderT - the type of builder

T - the type of key material used by this keyring

Direct Known Subclasses:

AesKeyring.Builder, RsaKeyring.Builder

Enclosing class:

RawKeyring<T>
```
public abstract static class RawKeyring.Builder<KeyringT extends RawKeyring<T>,BuilderT extends RawKeyring.Builder<KeyringT,BuilderT,T>,T>
extends S3Keyring.Builder<KeyringT,BuilderT>
```
Abstract builder for RawKeyring implementations. Provides common functionality for setting materials description on raw keyrings.

Field Summary

Fields
Modifier and Type	Field	Description
`protected Map<MaterialsDescription,RawKeyMaterial<T>>`	`_additionalDecryptionKeyMaterial`
`protected MaterialsDescription`	`_materialsDescription`

Constructor Summary

Constructors
Modifier Constructor Description

protected Builder()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`BuilderT`	`additionalDecryptionKeyMaterial(Map<MaterialsDescription,RawKeyMaterial<T>> additionalDecryptionKeyMaterial)`	Sets the map of keys for which to use for decryption.
`BuilderT`	`materialsDescription(MaterialsDescription materialsDescription)`	Sets the materials description for this keyring.

Methods inherited from class software.amazon.encryption.s3.materials.S3Keyring.Builder
build, builder, dataKeyGenerator, enableLegacyWrappingAlgorithms, secureRandom

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - _materialsDescription
```
protected MaterialsDescription _materialsDescription
```
  - _additionalDecryptionKeyMaterial
```
protected Map<MaterialsDescription,RawKeyMaterial<T>> _additionalDecryptionKeyMaterial
```
- Constructor Detail
  - Builder
```
protected Builder()
```
- Method Detail
  - materialsDescription
```
public BuilderT materialsDescription(MaterialsDescription materialsDescription)
```
    Sets the materials description for this keyring. Materials description provides additional metadata for raw keyrings.
    
    Parameters:
    
    materialsDescription - the materials description to associate with this keyring.
    
    Returns:
    
    a reference to this object so that method calls can be chained together.
  - additionalDecryptionKeyMaterial
```
public BuilderT additionalDecryptionKeyMaterial(Map<MaterialsDescription,RawKeyMaterial<T>> additionalDecryptionKeyMaterial)
```
    Sets the map of keys for which to use for decryption.
    
    Parameters:
    
    additionalDecryptionKeyMaterial - the map of additional key material for decryption, where the key is the materials description and the value is the key material
    
    Returns:
    
    a reference to this object so that method calls can be chained together.