Apache Mina SSHD 2.15.0 · org.apache.sshd.sftp.client.impl.SftpDirEntryIterator

Modifier and Type	Field and Description
private final SftpClient	client
private final boolean	closeOnFinished
private List<SftpClient.DirEntry>	dirEntries
private SftpClient.Handle	dirHandle
private final String	dirPath
private final AtomicReference<Boolean>	eolIndicator
private int	index
private final AtomicBoolean	open

Constructor Summary

Access	Constructor and Description
public	SftpDirEntryIterator(SftpClient The `SftpClient` instance to use for the iteration client, String The remote directory path path)
public	SftpDirEntryIterator(SftpClient The `SftpClient` instance to use for the iteration client, SftpClient.Handle The directory `Handle` to use for listing the entries dirHandle)
public	SftpDirEntryIterator(SftpClient The `SftpClient` instance to use for the iteration client, String A hint as to the remote directory path - used only for logging path, SftpClient.Handle The directory `Handle` to use for listing the entries dirHandle, boolean If `true` then close the directory handle when all entries have been exhausted closeOnFinished)

Method Summary

Modifier and Type	Method and Description
public void	close() Implements java.nio.channels.Channel.close. Closes this channel.
public final SftpClient	getClient() Implements org.apache.sshd.sftp.client.SftpClientHolder.getClient.
public final SftpClient.Handle	Returns: The directory `Handle` used to access the remote directory getHandle()
public final String	Returns: Remote directory hint - may be the handle's value if accessed directly via a `Handle` instead of via a path - used only for logging getPath() The remotely accessed directory path
public boolean	hasNext() Implements java.util.Iterator.hasNext. Returns `true` if the iteration has more elements.
public boolean	isCloseOnFinished()
public boolean	isOpen() Implements java.nio.channels.Channel.isOpen. Tells whether or not this channel is open.
protected List<SftpClient.DirEntry>	load(SftpClient.Handle handle)
public SftpClient.DirEntry	next() Implements java.util.Iterator.next. Returns the next element in the iteration.
public void	remove() Overrides default java.util.Iterator.remove. Removes from the underlying collection the last element returned by this iterator (optional operation).

Inherited from org.apache.sshd.common.util.logging.AbstractLoggingBean:: debug debug debug debug debug error error error error error getSimplifiedLogger info info warn warn warn warn warn warn warn warn

Field Detail

client	back to summary
private final SftpClient client

closeOnFinished	back to summary
private final boolean closeOnFinished

dirEntries	back to summary
private List<SftpClient.DirEntry> dirEntries

dirHandle	back to summary
private SftpClient.Handle dirHandle

dirPath	back to summary
private final String dirPath

eolIndicator	back to summary
private final AtomicReference<Boolean> eolIndicator

index	back to summary
private int index

open	back to summary
private final AtomicBoolean open

Constructor Detail

SftpDirEntryIterator	back to summary
public SftpDirEntryIterator(SftpClient client, String path) throws IOException Parameters client:SftpClient The `SftpClient` instance to use for the iteration path:String The remote directory path Exceptions IOException: If failed to gain access to the remote directory path

SftpDirEntryIterator	back to summary
public SftpDirEntryIterator(SftpClient client, SftpClient.Handle dirHandle) Parameters client:SftpClient The `SftpClient` instance to use for the iteration dirHandle:SftpClient.Handle The directory `Handle` to use for listing the entries

SftpDirEntryIterator back to summary

SftpDirEntryIterator	back to summary
public SftpDirEntryIterator(SftpClient client, String path, SftpClient.Handle dirHandle, boolean closeOnFinished) Parameters client:SftpClient The `SftpClient` instance to use for the iteration path:String A hint as to the remote directory path - used only for logging dirHandle:SftpClient.Handle The directory `Handle` to use for listing the entries closeOnFinished:boolean If `true` then close the directory handle when all entries have been exhausted

public SftpDirEntryIterator(SftpClient client, String path, SftpClient.Handle dirHandle, boolean closeOnFinished)

Parameters

client:SftpClient: The SftpClient instance to use for the iteration
path:String: A hint as to the remote directory path - used only for logging
dirHandle:SftpClient.Handle: The directory Handle to use for listing the entries
closeOnFinished:boolean: If true then close the directory handle when all entries have been exhausted

Method Detail

close back to summary

close	back to summary
public void close() throws IOException Implements java.nio.channels.Channel.close. Doc from java.nio.channels.Channel.close. Closes this channel. After a channel is closed, any further attempt to invoke I/O operations upon it will cause a `ClosedChannelException` to be thrown. If this channel is already closed then invoking this method has no effect. This method may be invoked at any time. If some other thread has already invoked it, however, then another invocation will block until the first invocation is complete, after which it will return without effect. Annotations @Override Exceptions IOException: If an I/O error occurs

public void close() throws IOException

Implements java.nio.channels.Channel.close.

Doc from java.nio.channels.Channel.close.

Closes this channel.

After a channel is closed, any further attempt to invoke I/O operations upon it will cause a ClosedChannelException to be thrown.

If this channel is already closed then invoking this method has no effect.

This method may be invoked at any time. If some other thread has already invoked it, however, then another invocation will block until the first invocation is complete, after which it will return without effect.

Annotations

@Override

Exceptions

IOException:: If an I/O error occurs

getClient	back to summary
public final SftpClient getClient() Implements org.apache.sshd.sftp.client.SftpClientHolder.getClient. Annotations @Override

getClient

back to summary

public final SftpClient getClient()

Implements org.apache.sshd.sftp.client.SftpClientHolder.getClient.

Annotations

@Override

getHandle	back to summary
public final SftpClient.Handle getHandle() Returns:SftpClient.Handle The directory `Handle` used to access the remote directory

getPath back to summary

getPath	back to summary
public final String getPath() The remotely accessed directory path Returns:String Remote directory hint - may be the handle's value if accessed directly via a `Handle` instead of via a path - used only for logging

public final String getPath()

The remotely accessed directory path

Returns:String: Remote directory hint - may be the handle's value if accessed directly via a Handle instead of via a path - used only for logging

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

isCloseOnFinished	back to summary
public boolean isCloseOnFinished()

isOpen back to summary

isOpen	back to summary
public boolean isOpen() Implements java.nio.channels.Channel.isOpen. Doc from java.nio.channels.Channel.isOpen. Tells whether or not this channel is open. Returns:boolean `true` if, and only if, this channel is open Annotations @Override

public boolean isOpen()

Implements java.nio.channels.Channel.isOpen.

Doc from java.nio.channels.Channel.isOpen.

Tells whether or not this channel is open.

Returns:boolean

true if, and only if, this channel is open

Annotations

@Override

load	back to summary
protected List<SftpClient.DirEntry> load(SftpClient.Handle handle)

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

back to summary

public SftpClient.DirEntry next()

Implements java.util.Iterator.next.

Doc from java.util.Iterator.next.

Returns the next element in the iteration.

Returns:SftpClient.DirEntry

the next element in the iteration

Annotations

@Override

remove back to summary

remove	back 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

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

public Class SftpDirEntryIterator

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail