com.amazonaws.cloudhsm.jce.provider.attributes

Class KeyAttributesMap

java.lang.Object

com.amazonaws.cloudhsm.jce.provider.attributes.KeyAttributesMap

All Implemented Interfaces:

java.security.spec.AlgorithmParameterSpec, java.security.spec.KeySpec

public class KeyAttributesMap
extends java.lang.Object
implements java.security.spec.AlgorithmParameterSpec, java.security.spec.KeySpec

KeyAttributesMap defines key attributes to be used during key-related operations.

KeyAttributesMap implements AlgorithmParameterSpec for use with Services that accept an AlgorithmParameterSpec.

See Also:

AlgorithmParameterSpec

Constructor Summary

Constructors

Constructor and Description
KeyAttributesMap() Constructs an empty KeyAttributesMap containing no key attributes or values.
KeyAttributesMap(KeyAttributePermissiveProfile permissiveProfile) Constructs a new KeyAttributesMap using the key attributes and permissive values as specified in KeyAttributePermissiveProfile.
KeyAttributesMap(KeyAttributesMap keyAttributesMap) Constructs a new KeyAttributesMap with the same key attributes and values as the specified KeyAttributesMap.

Method Summary

Modifier and Type	Method and Description
boolean	containsKey(KeyAttribute keyAttribute) Returns true if this map contains a mapping for the specified key attribute.
java.util.Set<java.util.Map.Entry<KeyAttribute,java.lang.Object>>	entrySet() Returns a Set view of the mappings contained in this map.
java.lang.Object	get(KeyAttribute keyAttribute) Returns the value to which the specified key attribute is mapped, or null if this map contains no mapping for the key attribute.
java.lang.Object	getOrDefault(KeyAttribute keyAttribute, java.lang.Object defaultValue) Returns the value to which the specified key attribute is mapped, or defaultValue if this map contains no mapping for the key attribute.
java.util.Set<KeyAttribute>	keySet() Returns a Set view of the key attributes contained in this map.
java.lang.Object	put(KeyAttribute keyAttribute, java.lang.Object value) Associates the specified value with the specified key attribute in this map.
void	putAll(KeyAttributesMap keyAttributesMap) Copies all mappings from the specified map to this map.
java.lang.Object	remove(KeyAttribute keyAttribute) Removes the mapping for the specified key attribute from this map if present.
boolean	remove(KeyAttribute keyAttribute, java.lang.Object value) Removes the entry for the specified key attribute only if it is currently mapped to the specified value.

Methods inherited from class java.lang.Object

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

Constructor Detail

KeyAttributesMap

public KeyAttributesMap()

Constructs an empty KeyAttributesMap containing no key attributes or values.

KeyAttributesMap

public KeyAttributesMap(KeyAttributesMap keyAttributesMap)
                 throws AddAttributeException

Constructs a new KeyAttributesMap with the same key attributes and values as the specified KeyAttributesMap.

Parameters:

keyAttributesMap - The KeyAttributesMap whose key attributes and values are to be placed in this KeyAttributesMap.

Throws:

java.security.InvalidParameterException - If the specified object is null.

AddAttributeException - If there was a problem adding attributes from keyAttributesMap.

KeyAttributesMap

public KeyAttributesMap(KeyAttributePermissiveProfile permissiveProfile)

Constructs a new KeyAttributesMap using the key attributes and permissive values as specified in KeyAttributePermissiveProfile.

Parameters:

permissiveProfile - A specific KeyAttributePermissiveProfile profile whose key attributes and permissive values will be used to populate a new instance of KeyAttributesMap.

Method Detail

containsKey

public boolean containsKey(KeyAttribute keyAttribute)

Returns true if this map contains a mapping for the specified key attribute.

Parameters:

keyAttribute - The key attribute whose presence in this map is to be tested.

Returns:

true if this map contains a mapping for the specified key attribute.

entrySet

public java.util.Set<java.util.Map.Entry<KeyAttribute,java.lang.Object>> entrySet()

Returns a Set view of the mappings contained in this map.

The set is backed by the map, so changes to the map are reflected in the set, and vice-versa. If the map is modified while an iteration over the set is in progress (except through the iterator's own remove operation, or through the setValue operation on a map entry returned by the iterator) the results of the iteration are undefined.

Returns:

A Set view of the mappings contained in this map.

get

public java.lang.Object get(KeyAttribute keyAttribute)

Returns the value to which the specified key attribute is mapped, or null if this map contains no mapping for the key attribute.

Parameters:

keyAttribute - Key attribute whose associated value is to be returned.

Returns:

The value to which the specified key attribute is mapped, or null if this map contains no mapping for the key attribute.

Throws:

java.security.InvalidParameterException - If the specified key attribute is null.

getOrDefault

public java.lang.Object getOrDefault(KeyAttribute keyAttribute,
                                     java.lang.Object defaultValue)

Returns the value to which the specified key attribute is mapped, or defaultValue if this map contains no mapping for the key attribute.

Parameters:

keyAttribute - Key attribute whose associated value is to be returned.

defaultValue - The default mapping of the key attribute.

Returns:

The value to which the specified key attribute is mapped, or defaultValue if this map contains no mapping for the key attribute.

Throws:

java.security.InvalidParameterException - If the specified key attribute is null.

keySet

public java.util.Set<KeyAttribute> keySet()

Returns a Set view of the key attributes contained in this map.

The set is backed by the map, so changes to the map are reflected in the set, and vice-versa. If the map is modified while an iteration over the set is in progress (except through the iterator's own remove operation), the results of the iteration are undefined.

Returns:

A Set view of the key attributes contained in this map.

put

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

Associates the specified value with the specified key attribute in this map.

If the 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.

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

Returns:

The previous value associated with the key attribute, or null if there was no mapping for key attribute.

Throws:

java.security.InvalidParameterException - If the specified key attribute or value is null .

AddAttributeException - If there was a problem adding the specified attribute.

putAll

public void putAll(KeyAttributesMap keyAttributesMap)
            throws AddAttributeException

Copies all mappings from the specified map to this map.

These mappings will replace any mappings that this map had for any of the key attributes currently in the specified map.

Parameters:

keyAttributesMap - Key attribute mappings to be stored in this map.

Throws:

java.security.InvalidParameterException - If the specified map is null or it contains null key attributes or values.

AddAttributeException - If there was a problem adding attributes from keyAttributesMap.

remove

public java.lang.Object remove(KeyAttribute keyAttribute)
                        throws java.lang.NullPointerException

Removes the mapping for the specified key attribute from this map if present.

Parameters:

keyAttribute - Key attribute whose mapping is to be removed.

Returns:

The previous value associated with keyAttribute, or null if there was no mapping for keyAttribute.

Throws:

java.security.InvalidParameterException - If the specified key attribute is null.

java.lang.NullPointerException

remove

public boolean remove(KeyAttribute keyAttribute,
                      java.lang.Object value)

Removes the entry for the specified key attribute only if it is currently mapped to the specified value.

Parameters:

keyAttribute - Key attribute with which the specified value is associated.

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

Returns:

Returns true if the attribute is found and is removed. Returns false otherwise.

Throws:

java.security.InvalidParameterException - If the specified key attribute or value is null .