org.apache.sshd.client.subsystem.sftp

Class SftpDirEntryIterator

java.lang.Object

org.apache.sshd.common.util.logging.AbstractLoggingBean

org.apache.sshd.client.subsystem.sftp.SftpDirEntryIterator

All Implemented Interfaces:

Closeable, AutoCloseable, Channel, Iterator<SftpClient.DirEntry>

public class SftpDirEntryIterator
extends AbstractLoggingBean
implements Iterator<SftpClient.DirEntry>, Channel

Iterates over the available directory entries for a given path. Note: if the iteration is carried out until no more entries are available, then no need to close the iterator. Otherwise, it is recommended to close it so as to release the internal handle.

Author:

Apache MINA SSHD Project

Field Summary

Fields inherited from class org.apache.sshd.common.util.logging.AbstractLoggingBean

log

Constructor Summary

Constructors

Constructor and Description
SftpDirEntryIterator(SftpClient client, String path)

Method Summary

Modifier and Type	Method and Description
void	close()
SftpClient	getClient() The client instance
String	getPath() The remotely accessed directory path
boolean	hasNext()
boolean	isOpen()
protected List<SftpClient.DirEntry>	load(SftpClient.CloseableHandle handle)
SftpClient.DirEntry	next()
protected SftpClient.CloseableHandle	open(String path)
void	remove()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Iterator

forEachRemaining

Constructor Detail

SftpDirEntryIterator

public SftpDirEntryIterator(SftpClient client,
                            String path)

Parameters:

client - The SftpClient instance to use for the iteration

path - The remote directory path

Method Detail

getClient

public final SftpClient getClient()

The client instance

Returns:

SftpClient instance used to access the remote file

getPath

public final String getPath()

The remotely accessed directory path

Returns:

Remote directory path

hasNext

public boolean hasNext()

Specified by:

hasNext in interface Iterator<SftpClient.DirEntry>

next

public SftpClient.DirEntry next()

Specified by:

next in interface Iterator<SftpClient.DirEntry>

isOpen

public boolean isOpen()

Specified by:

isOpen in interface Channel

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Channel

Throws:

IOException

open

protected SftpClient.CloseableHandle open(String path)

load

protected List<SftpClient.DirEntry> load(SftpClient.CloseableHandle handle)

remove

public void remove()

Specified by:

remove in interface Iterator<SftpClient.DirEntry>