SFtpDir Chilkat2 Java Reference Documentation

SFtpDir

Current Version: 11.7.0

Markdown version of this page for AI tools (v 11.7.0) · all AI docs

Requires Chilkat Bundle License

Chilkat.SFtpDir

Inspect, sort, and iterate an SFTP directory listing.

Chilkat.SFtpDir represents a directory listing returned by an SFTP operation. It provides the original path used to fetch the listing, the number of files and subdirectories found, methods for retrieving filenames or full SFtpFile entry details by index, sorting support, and a way to load a completed asynchronous directory-listing result.

Directory listing object

Holds the files and subdirectories returned from an SFTP directory-read operation.

Original path tracking

Use OriginalPath to see the remote path that was requested when the directory listing was created.

Entry count

Read NumFilesAndDirs to determine how many directory entries are available for iteration.

Filename access

Use GetFilename to retrieve the name of an entry by zero-based index.

Full entry details

Use FileAt to populate an SFtpFile object with metadata for a selected file or subdirectory.

Sorting and async results

Sort entries by filename, timestamps, or size, and load directory listings returned from completed async tasks.

Common pattern: Use a Chilkat.SFtp object to open or read a remote directory, then use the returned SFtpDir object to inspect NumFilesAndDirs, optionally call Sort, and loop from index 0 through the final entry. Use GetFilename when only names are needed, or FileAt when the application needs the full SFtpFile metadata for each entry.

Object Creation

import com.chilkatsoft.chilkat2.ChilkatException;
import com.chilkatsoft.chilkat2.SFtpDir;

try (SFtpDir sFtpDir = new SFtpDir()) {
    // ... use sFtpDir ...
} catch (ChilkatException e) {
    System.out.println(e.getMessage());          // "SFtpDir.someMethod failed: <reason>"
    System.out.println(e.getLastErrorText());    // the full log of the failed call
}
public SFtpDir()

Creates the underlying native Chilkat object. The native library (chilkat2java) is loaded the first time any Chilkat2 object is created; see the README in the download for where it is looked for (-Dchilkat2.library.path, a classpath resource, or java.library.path).

public void close()

Releases the native object (SFtpDir is AutoCloseable, so try-with-resources calls it). Calling it again does nothing; any other method or property accessor called afterwards throws IllegalStateException. An object that is never closed is freed by a background cleaner once it becomes unreachable, but the garbage collector does not see native memory, so closing is the normal path. Objects returned by methods are owned by the caller too.

public boolean isClosed()

Returns true once close() has been called.

Errors

A method that fails throws ChilkatException, an unchecked exception carrying getClassName(), getMethodName(), getReason() (one line, also in the message) and getLastErrorText() (the full log, captured at the moment of the failure). The object remains usable. Methods that look something up and find nothing return null instead of throwing (each such method says so), and methods that answer a question (hasMember, isUnlocked, ...) return a plain boolean. Property accessors do not throw for Chilkat reasons.

A null string or object argument throws NullPointerException naming the parameter (except where a method documents that null is accepted), and a string containing U+0000 throws IllegalArgumentException.

Use an object from one thread at a time; it may be handed from one thread to another. The one cross-thread operation is setting setAbortCurrent(true) on an object that is busy in another thread (on the classes that have AbortCurrent). Unlocking: call new Global().unlockBundle("...") once at startup.

Properties

DebugLogFilePath
// read/write
String getDebugLogFilePath()
void setDebugLogFilePath(String value)

If set to a file path, this property logs the LastErrorText of each Chilkat method or property call to the specified file. This logging helps identify the context and history of Chilkat calls leading up to any crash or hang, aiding in debugging.

Enabling the VerboseLogging property provides more detailed information. This property is mainly used for debugging rare instances where a Chilkat method call causes a hang or crash, which should generally not happen.

Possible causes of hangs include:

  • A timeout property set to 0, indicating an infinite timeout.
  • A hang occurring within an event callback in the application code.
  • An internal bug in the Chilkat code causing the hang.

More Information and Examples
Example showing how to use DebugLogFilePath.
top
LastErrorHtml
// read-only
String getLastErrorHtml()

Provides HTML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

top
LastErrorText
// read-only
String getLastErrorText()

Provides plain text information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

More Information and Examples
Concept of LastErrorTextLastErrorText Standard Information
top
LastErrorXml
// read-only
String getLastErrorXml()

Provides XML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

top
LastMethodSuccess
// read/write
boolean getLastMethodSuccess()
void setLastMethodSuccess(boolean value)

Indicates the success or failure of the most recent method call: true means success, false means failure. This property remains unchanged by property setters or getters. This method is present to address challenges in checking for null or Nothing returns in certain programming languages. Note: This property does not apply to methods that return integer values or to boolean-returning methods where the boolean does not indicate success or failure.

top
NumFilesAndDirs
// read-only
int getNumFilesAndDirs()

Returns the number of entries in this directory listing.

The count includes every item returned by the server, such as regular files, directories, symbolic links, and special entries. Valid zero-based indexes range from 0 through NumFilesAndDirs - 1.

top
OriginalPath
// read-only
String getOriginalPath()

Returns the original remote path used to create this directory listing.

This is the same path string that was supplied to the SFTP directory-open operation. It identifies the requested directory and is retained with the listing for later reference.

top
VerboseLogging
// read/write
boolean getVerboseLogging()
void setVerboseLogging(boolean value)

If set to true, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. The default value is false. Verbose logging should only be used for debugging. The potentially large quantity of logged information may adversely affect peformance.

top
Version
// read-only
String getVersion()

Version of the component/library, such as "10.1.0"

More Information and Examples
How to get the Chilkat version at runtime.
top

Methods

FileAt
void fileAt(int index, SFtpFile fileObj)
Introduced in version 11.0.0

Copies the metadata for the directory entry at the zero-based index into fileObj.

The first entry is at index 0. Use NumFilesAndDirs to determine the number of available entries.

The populated SFtpFile object provides the entry name, type, size, timestamps, ownership, permissions, and any additional attributes supplied by the SFTP server.

Use GetFilename when only the entry name is needed.

Throws ChilkatException on failure; e.getLastErrorText() (or the object's getLastErrorText()) explains why, and the object remains usable.

top
GetFilename
String getFilename(int index)

Returns the filename of the directory entry at the zero-based index.

The first entry is at index 0. Use NumFilesAndDirs to determine the number of available entries.

Use FileAt when the application needs the full SFtpFile metadata rather than only the entry name.

Throws ChilkatException on failure; e.getLastErrorText() (or the object's getLastErrorText()) explains why, and the object remains usable.

top
Sort
void sort(String field, boolean ascending)
Introduced in version 9.5.0.79

Reorders the files and subdirectories in this listing according to field.

Set ascending to true for ascending order or false for descending order. The new order is used by index-based methods such as GetFilename and FileAt.

field Sort key
filename Filename using the normal case-sensitive comparison.
filenameNoCase Filename using a case-insensitive comparison.
lastModifiedTime Last-modified date and time.
lastAccessTime Last-access date and time.
lastCreateTime Creation date and time.
size Entry size in bytes.
top