net.adamcin.httpsig.api

Interface Keychain

All Superinterfaces:

java.lang.Iterable<Key>

All Known Implementing Classes:

DefaultKeychain

public interface Keychain
extends java.lang.Iterable<Key>

Immutable interface for a list of Keys

Method Summary

Modifier and Type	Method and Description
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.Map<java.lang.String,Key>	toMap(KeyId keyId)

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Method Detail

getAlgorithms

java.util.Set<Algorithm> getAlgorithms()

Returns:

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

filterAlgorithms

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

Filter this keychain by a Collection of supported Algorithms

Parameters:

algorithms - supported algorithms

Returns:

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

discard

Keychain discard()

Returns:

a reference to a Keychain which excludes the current Key.

currentKey

Key currentKey()

Returns:

a reference to the current Key.

toMap

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

Parameters:

keyId - the KeyId

Returns:

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

isEmpty

boolean isEmpty()

Returns:

true if this Keychain has no more keys