com.amazonaws.cloudhsm.jce.provider.attributes

Class KeyPairAttributesMapBuilder

java.lang.Object

com.amazonaws.cloudhsm.jce.provider.attributes.KeyPairAttributesMapBuilder

public class KeyPairAttributesMapBuilder
extends java.lang.Object

A helper class which provides KeyPairAttributesMapBuilder Pattern support for instantiating and populating an instance of KeyPairAttributesMap.

Method chaining is supported.

Constructor Summary

Constructors

Constructor and Description
KeyPairAttributesMapBuilder() Constructs a KeyPairAttributeMapBuilder for instantiating and populating an instance of KeyPairAttributesMap.

Method Summary

Modifier and Type	Method and Description
KeyPairAttributesMap	build() Returns an instance of KeyPairAttributesMap created from the fields set on this builder.
KeyPairAttributesMapBuilder	withPrivate(KeyAttribute keyAttribute, java.lang.Object value) Associates the specified value with the specified key attribute in the private key.
KeyPairAttributesMapBuilder	withPrivate(KeyAttributesMap privateKeyAttributesMap) Populates the private key with the same key attributes and values as the specified KeyPairAttributesMap.
KeyPairAttributesMapBuilder	withPublic(KeyAttribute keyAttribute, java.lang.Object value) Associates the specified value with the specified key attribute in the public key.
KeyPairAttributesMapBuilder	withPublic(KeyAttributesMap publicKeyAttributesMap) Populates the public key with the same key attributes and values as the specified KeyPairAttributesMap.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

KeyPairAttributesMapBuilder

public KeyPairAttributesMapBuilder()

Constructs a KeyPairAttributeMapBuilder for instantiating and populating an instance of KeyPairAttributesMap.

Method Detail

build

public KeyPairAttributesMap build()

Returns an instance of KeyPairAttributesMap created from the fields set on this builder.

Returns:

An instance of KeyPairAttributesMap populated with the key pair attributes and values provided to the builder's methods.

withPublic

public KeyPairAttributesMapBuilder withPublic(KeyAttributesMap publicKeyAttributesMap)
                                       throws AddAttributeException

Populates the public key with the same key attributes and values as the specified KeyPairAttributesMap.

Parameters:

publicKeyAttributesMap - The KeyAttributesMap whose key attributes and values are to be placed in this KeyPairAttributesMap's public key map.

Returns:

The current KeyPairAttributesMapBuilder instance, for method chaining.

Throws:

java.lang.NullPointerException - If the specified object is null.

AddAttributeException - If there was a problem adding attributes from the public key map.

withPublic

public KeyPairAttributesMapBuilder withPublic(KeyAttribute keyAttribute,
                                              java.lang.Object value)
                                       throws AddAttributeException

Associates the specified value with the specified key attribute in the public key.

If the internal map previously contained a mapping for the key attribute, the old value is replaced.

Parameters:

keyAttribute - Key attribute with which the specified value is to be associated in the public key.

value - Value to be associated with the specified key attribute in the public key.

Returns:

The current KeyPairAttributesMapBuilder instance, for method chaining.

Throws:

AddAttributeException - If there is a problem adding the specified public key attribute.

withPrivate

public KeyPairAttributesMapBuilder withPrivate(KeyAttributesMap privateKeyAttributesMap)
                                        throws AddAttributeException

Populates the private key with the same key attributes and values as the specified KeyPairAttributesMap.

Parameters:

privateKeyAttributesMap - The KeyAttributesMap whose key attributes and values are to be placed in this KeyPairAttributesMap's private key map.

Returns:

The current KeyPairAttributesMapBuilder instance, for method chaining.

Throws:

java.lang.NullPointerException - If the specified object is null.

AddAttributeException - If there is a problem adding attributes from the private key map.

withPrivate

public KeyPairAttributesMapBuilder withPrivate(KeyAttribute keyAttribute,
                                               java.lang.Object value)
                                        throws AddAttributeException

Associates the specified value with the specified key attribute in the private key.

If the internal map previously contained a mapping for the key attribute, the old value is replaced.

Parameters:

keyAttribute - Key attribute with which the specified value is to be associated in the private key.

value - Value to be associated with the specified key attribute in the private key.

Returns:

The current KeyPairAttributesMapBuilder instance, for method chaining.

Throws:

AddAttributeException - If there is a problem adding the specified private key attribute.