net.adamcin.httpsig.api

Class DefaultKeychain

java.lang.Object

net.adamcin.httpsig.api.DefaultKeychain

All Implemented Interfaces:

java.lang.Iterable<Key>, java.util.Collection<Key>, Keychain

public class DefaultKeychain
extends java.lang.Object
implements Keychain, java.util.Collection<Key>

Simple implementation of Keychain backed by a HashMap and modified via Collection methods

Constructor Summary

Constructors

Constructor and Description
DefaultKeychain()
DefaultKeychain(java.util.Collection<? extends Key> identities)

Method Summary

Modifier and Type	Method and Description
boolean	add(Key key)
boolean	addAll(java.util.Collection<? extends Key> c)
void	clear()
boolean	contains(java.lang.Object o)
boolean	containsAll(java.util.Collection<?> c)
Key	currentKey()
Keychain	discard()
Keychain	filterAlgorithms(java.util.Collection<Algorithm> algorithms) Filter this keychain by a Collection of supported Algorithms
java.util.Set<Algorithm>	getAlgorithms()
boolean	isEmpty()
java.util.Iterator<Key>	iterator()
boolean	remove(java.lang.Object o)
boolean	removeAll(java.util.Collection<?> c)
boolean	retainAll(java.util.Collection<?> c)
int	size()
java.lang.Object[]	toArray()
<T> T[]	toArray(T[] a)
java.util.Map<java.lang.String,Key>	toMap(KeyId keyIdentifier)

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Collection

equals, hashCode, parallelStream, removeIf, spliterator, stream

Methods inherited from interface java.lang.Iterable

forEach

Constructor Detail

DefaultKeychain

public DefaultKeychain()

DefaultKeychain

public DefaultKeychain(java.util.Collection<? extends Key> identities)

Method Detail

getAlgorithms

public java.util.Set<Algorithm> getAlgorithms()

Specified by:

getAlgorithms in interface Keychain

Returns:

a Set containing the union of all algorithms supported by each Key in this Keychain

size

public int size()

Specified by:

size in interface java.util.Collection<Key>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface java.util.Collection<Key>

Specified by:

isEmpty in interface Keychain

Returns:

true if this Keychain has no more keys

contains

public boolean contains(java.lang.Object o)

Specified by:

contains in interface java.util.Collection<Key>

iterator

public java.util.Iterator<Key> iterator()

Specified by:

iterator in interface java.lang.Iterable<Key>

Specified by:

iterator in interface java.util.Collection<Key>

toArray

public java.lang.Object[] toArray()

Specified by:

toArray in interface java.util.Collection<Key>

toArray

public <T> T[] toArray(T[] a)

Specified by:

toArray in interface java.util.Collection<Key>

add

public boolean add(Key key)

Specified by:

add in interface java.util.Collection<Key>

remove

public boolean remove(java.lang.Object o)

Specified by:

remove in interface java.util.Collection<Key>

containsAll

public boolean containsAll(java.util.Collection<?> c)

Specified by:

containsAll in interface java.util.Collection<Key>

addAll

public boolean addAll(java.util.Collection<? extends Key> c)

Specified by:

addAll in interface java.util.Collection<Key>

removeAll

public boolean removeAll(java.util.Collection<?> c)

Specified by:

removeAll in interface java.util.Collection<Key>

retainAll

public boolean retainAll(java.util.Collection<?> c)

Specified by:

retainAll in interface java.util.Collection<Key>

clear

public void clear()

Specified by:

clear in interface java.util.Collection<Key>

discard

public Keychain discard()

Specified by:

discard in interface Keychain

Returns:

a reference to a Keychain which excludes the current Key.

currentKey

public Key currentKey()

Specified by:

currentKey in interface Keychain

Returns:

the current key

Throws:

java.util.NoSuchElementException - if the keychain is empty

filterAlgorithms

public Keychain filterAlgorithms(java.util.Collection<Algorithm> algorithms)

Description copied from interface: Keychain

Filter this keychain by a Collection of supported Algorithms

Specified by:

filterAlgorithms in interface Keychain

Parameters:

algorithms - supported algorithms

Returns:

a new Keychain containing only those keys which support at least one of the provided algorithms

toMap

public java.util.Map<java.lang.String,Key> toMap(KeyId keyIdentifier)

Specified by:

toMap in interface Keychain

Parameters:

keyIdentifier - the KeyId

Returns:

a Map where the values are the Keys and the map entry keys are the keyId's generated by the KeyId