Top Fields Constructors Methods
org.apache.sshd.client.auth.pubkey

public abstract Class AbstractKeyPairIterator<I extends PublicKeyIdentity>

extends Object
implements Iterator<I extends PublicKeyIdentity>, SessionHolder<ClientSession>, ClientSessionHolder
Class Inheritance
All Implemented Interfaces
org.apache.sshd.client.session.ClientSessionHolder, org.apache.sshd.common.session.SessionHolder, org.apache.sshd.common.session.SessionContextHolder, java.util.Iterator
Known Direct Subclasses
org.apache.sshd.client.auth.pubkey.SessionKeyPairIterator, org.apache.sshd.client.auth.pubkey.SshAgentPublicKeyIterator, org.apache.sshd.client.auth.pubkey.UserAuthPublicKeyIterator
Type Parameters
<I>
Type of PublicKeyIdentity being iterated
Imports
java.util.Iterator, .Objects, org.apache.sshd.client.session.ClientSession, .ClientSessionHolder, org.apache.sshd.common.session.SessionHolder
Author
Apache MINA SSHD Project

Field Summary

Modifier and TypeField and Description
private final ClientSession
session

Constructor Summary

AccessConstructor and Description
protected
AbstractKeyPairIterator(ClientSession session)

Method Summary

Modifier and TypeMethod and Description
public final ClientSession
getClientSession()

Implements org.apache.sshd.client.session.ClientSessionHolder.getClientSession.

public final ClientSession
getSession()

Implements org.apache.sshd.common.session.SessionHolder.getSession.

public void
remove()

Overrides default java.util.Iterator.remove.

Removes from the underlying collection the last element returned by this iterator (optional operation).

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAllwaitwaitwait

Field Detail

sessionback to summary
private final ClientSession session

Constructor Detail

AbstractKeyPairIteratorback to summary
protected AbstractKeyPairIterator(ClientSession session)

Method Detail

getClientSessionback to summary
public final ClientSession getClientSession()

Implements org.apache.sshd.client.session.ClientSessionHolder.getClientSession.

Returns:ClientSession

Doc from org.apache.sshd.client.session.ClientSessionHolder.getClientSession.

The underlying ClientSession used

Annotations
@Override
getSessionback to summary
public final ClientSession getSession()

Implements org.apache.sshd.common.session.SessionHolder.getSession.

Annotations
@Override
removeback to summary
public void remove()

Overrides default java.util.Iterator.remove.

Doc from java.util.Iterator.remove.

Removes from the underlying collection the last element returned by this iterator (optional operation). This method can be called only once per call to next.

The behavior of an iterator is unspecified if the underlying collection is modified while the iteration is in progress in any way other than by calling this method, unless an overriding class has specified a concurrent modification policy.

The behavior of an iterator is unspecified if this method is called after a call to the forEachRemaining method.

Annotations
@Override
toStringback 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