Apache Mina SSHD 2.15.0 · org.apache.sshd.client.config.keys.LazyClientIdentityIterator

Wraps several ClientIdentityProvider into a KeyPair Iterator that invokes each provider "lazily" - i.e., only when Iterator#hasNext() is invoked. This prevents password protected private keys to be decrypted until they are actually needed.

Field Summary

Modifier and Type	Field and Description
protected Iterator<KeyPair>	currentIdentities
protected KeyPair	currentPair
private final Predicate<KeyPair>	filter
protected boolean	finished
private final Function<? super ClientIdentityProvider, ? extends Iterable<KeyPair>>	kpExtractor
private final Iterator<? extends ClientIdentityProvider>	providers

Constructor Summary

Access Constructor and Description

Access	Constructor and Description
public	LazyClientIdentityIterator(Iterator<? extends ClientIdentityProvider> The providers - ignored if `null` providers, Function<? super ClientIdentityProvider, ? extends Iterable<KeyPair>> The (never `null`) extractor of the `KeyPair` from the `ClientIdentityProvider` argument. If returned pair is `null` then next provider is queried. kpExtractor, Predicate<KeyPair> Any further filter to apply on (non-`null`) key pairs before returning it as the `Iterator#next()` result. filter)

public

LazyClientIdentityIterator(Iterator<? extends ClientIdentityProvider>

The providers - ignored if null

providers, Function<? super ClientIdentityProvider, ? extends Iterable<KeyPair>>

The (never null) extractor of the KeyPair from the ClientIdentityProvider argument. If returned pair is null then next provider is queried.

kpExtractor, Predicate<KeyPair>

Any further filter to apply on (non-null) key pairs before returning it as the Iterator#next() result.

filter)

Method Summary

Modifier and Type	Method and Description
public Predicate<KeyPair>	getFilter()
public Function<? super ClientIdentityProvider, ? extends Iterable<KeyPair>>	getIdentitiesExtractor()
public Iterator<? extends ClientIdentityProvider>	getProviders()
public boolean	hasNext() Implements java.util.Iterator.hasNext. Returns `true` if the iteration has more elements.
public KeyPair	next() Implements java.util.Iterator.next. Returns the next element in the iteration.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

Field Detail

currentIdentities	back to summary
protected Iterator<KeyPair> currentIdentities

currentPair	back to summary
protected KeyPair currentPair

filter	back to summary
private final Predicate<KeyPair> filter

finished	back to summary
protected boolean finished

kpExtractor	back to summary
private final Function<? super ClientIdentityProvider, ? extends Iterable<KeyPair>> kpExtractor

providers	back to summary
private final Iterator<? extends ClientIdentityProvider> providers

Constructor Detail

LazyClientIdentityIterator back to summary

LazyClientIdentityIterator	back to summary
public LazyClientIdentityIterator(Iterator<? extends ClientIdentityProvider> providers, Function<? super ClientIdentityProvider, ? extends Iterable<KeyPair>> kpExtractor, Predicate<KeyPair> filter) Parameters providers:Iterator<? extends ClientIdentityProvider> The providers - ignored if `null` kpExtractor:Function<? super ClientIdentityProvider, ? extends Iterable<KeyPair>> The (never `null`) extractor of the `KeyPair` from the `ClientIdentityProvider` argument. If returned pair is `null` then next provider is queried. filter:Predicate<KeyPair> Any further filter to apply on (non-`null`) key pairs before returning it as the `Iterator#next()` result.

public LazyClientIdentityIterator(Iterator<? extends ClientIdentityProvider> providers, Function<? super ClientIdentityProvider, ? extends Iterable<KeyPair>> kpExtractor, Predicate<KeyPair> filter)

Parameters

providers:Iterator<? extends ClientIdentityProvider>: The providers - ignored if null
kpExtractor:Function<? super ClientIdentityProvider, ? extends Iterable<KeyPair>>: The (never null) extractor of the KeyPair from the ClientIdentityProvider argument. If returned pair is null then next provider is queried.
filter:Predicate<KeyPair>: Any further filter to apply on (non-null) key pairs before returning it as the Iterator#next() result.

Method Detail

getFilter	back to summary
public Predicate<KeyPair> getFilter()

getIdentitiesExtractor	back to summary
public Function<? super ClientIdentityProvider, ? extends Iterable<KeyPair>> getIdentitiesExtractor()

getProviders	back to summary
public Iterator<? extends ClientIdentityProvider> getProviders()

hasNext back to summary

hasNext	back to summary
public boolean hasNext() Implements java.util.Iterator.hasNext. Doc from java.util.Iterator.hasNext. Returns `true` if the iteration has more elements. (In other words, returns `true` if `next` would return an element rather than throwing an exception.) Returns:boolean `true` if the iteration has more elements Annotations @Override

public boolean hasNext()

Implements java.util.Iterator.hasNext.

Doc from java.util.Iterator.hasNext.

Returns true if the iteration has more elements. (In other words, returns true if next would return an element rather than throwing an exception.)

Returns:boolean

true if the iteration has more elements

Annotations

@Override

next	back to summary
public KeyPair next() Implements java.util.Iterator.next. Doc from java.util.Iterator.next. Returns the next element in the iteration. Returns:KeyPair the next element in the iteration Annotations @Override

back to summary

public KeyPair next()

Implements java.util.Iterator.next.

Doc from java.util.Iterator.next.

Returns the next element in the iteration.

Returns:KeyPair

the next element in the iteration

Annotations

@Override

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Satisfying this method's contract implies a non-`null` result must be returned. Returns:String a string representation of the object Annotations @Override

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations

@Override

public Class LazyClientIdentityIterator

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail