CkSFtpFile Java Programming
Reference Documentation

CkSFtpFile

Represents a remote SFTP file.

Object Creation

CkSFtpFile obj = new CkSFtpFile();

Properties

// sysTime is a SYSTEMTIME object (output)
get_CreateTime( sysTime )

The file creation date and time (GMT / UTC). This property is only supported by servers running SFTP v4 or later.

// str is a CkString object (output)
get_FileType( str )

One of the following values:

  regular
  directory
  symLink
  special
  unknown
  socket
  charDevice
  blockDevice
  fifo

// str is a CkString object (output)
get_Filename( str )

The filename (or directory name, symbolic link name, etc.)

// Returns an integer value
get_Gid( )

The integer Group ID of the file.

// str is a CkString object (output)
get_Group( str )

The group ownership of the file. This property is only supported by servers running SFTP v4 or later.

// Returns a boolean value
get_IsAppendOnly( )

If true, this file may only be appended. This property is only supported by servers running SFTP v6 or later.

// Returns a boolean value
get_IsArchive( )

If true, the file should be included in backup / archive operations. This property is only supported by servers running SFTP v6 or later.

// Returns a boolean value
get_IsCaseInsensitive( )

This attribute applies only to directories. This attribute means that files and directory names in this directory should be compared without regard to case. This property is only supported by servers running SFTP v6 or later.

// Returns a boolean value
get_IsCompressed( )

The file is stored on disk using file-system level transparent compression. This flag does not affect the file data on the wire. This property is only supported by servers running SFTP v6 or later.

// Returns a boolean value
get_IsDirectory( )

If true, this is a directory.

// Returns a boolean value
get_IsEncrypted( )

The file is stored on disk using file-system level transparent encryption. This flag does not affect the file data on the wire (for either READ or WRITE requests.) This property is only supported by servers running SFTP v6 or later.

// Returns a boolean value
get_IsHidden( )

If true, the file SHOULD NOT be shown to user unless specifically requested.

// Returns a boolean value
get_IsImmutable( )

The file cannot be deleted or renamed, no hard link can be created to this file, and no data can be written to the file.
This bit implies a stronger level of protection than ReadOnly, the file permission mask or ACLs. Typically even the superuser cannot write to immutable files, and only the superuser can set or remove the bit.
This property is only supported by servers running SFTP v6 or later.

// Returns a boolean value
get_IsReadOnly( )

If true, the file is read-only. This property is only supported by servers running SFTP v6 or later.

// Returns a boolean value
get_IsRegular( )

true if this is a normal file (not a directory or any of the other non-file types).

// Returns a boolean value
get_IsSparse( )

The file is a sparse file; this means that file blocks that have not been explicitly written are not stored on disk. For example, if a client writes a buffer at 10 M from the beginning of the file, the blocks between the previous EOF marker and the 10 M offset would not consume physical disk space.
Some servers may store all files as sparse files, in which case this bit will be unconditionally set. Other servers may not have a mechanism for determining if the file is sparse, and so the file MAY be stored sparse even if this flag is not set.
This property is only supported by servers running SFTP v6 or later.

// Returns a boolean value
get_IsSymLink( )

true if this is a symbolic link.

// Returns a boolean value
get_IsSync( )

When the file is modified, the changes are written synchronously to the disk. This property is only supported by servers running SFTP v6 or later.

// Returns a boolean value
get_IsSystem( )

true if the file is part of the operating system. This property is only supported by servers running SFTP v6 or later.

// sysTime is a SYSTEMTIME object (output)
get_LastAccessTime( sysTime )

The last-access date and time (GMT / UTC).

// str is a CkString object (output)
LastErrorHtml( str )

Error information in HTML format for the last method called.

// str is a CkString object (output)
LastErrorText( str )

Error information in plain-text format for the last method called.

// str is a CkString object (output)
LastErrorXml( str )

Error information in XML format for the last method called.

// sysTime is a SYSTEMTIME object (output)
get_LastModifiedTime( sysTime )

The last-modified date and time (GMT / UTC).

// str is a CkString object (output)
get_Owner( str )

The owner of the file. This property is only supported by servers running SFTP v4 or later.

// Returns an integer value
get_Permissions( )

The 'permissions' field contains a bit mask specifying file permissions. These permissions correspond to the st_mode field of the stat structure defined by POSIX [IEEE.1003-1.1996].
This protocol uses the following values for the symbols declared in the POSIX standard.
       S_IRUSR  0000400 (octal)
       S_IWUSR  0000200
       S_IXUSR  0000100
       S_IRGRP  0000040
       S_IWGRP  0000020
       S_IXGRP  0000010
       S_IROTH  0000004
       S_IWOTH  0000002
       S_IXOTH  0000001
       S_ISUID  0004000
       S_ISGID  0002000
       S_ISVTX  0001000

// Returns an integer value
get_Size32( )

Size of the file in bytes. If the size is too large for 32-bits, a -1 is returned.

// str is a CkString object (output)
get_SizeStr( str )

Same as Size64, but the number is returned as a string in decimal format.

// Returns an integer value
get_Uid( )

The integer User ID of the file.

// Returns a boolean value
get_Utf8( )

// b is a boolean (input)
put_Utf8( b )

To be documented soon...

Methods

// filename is a string (input)
// Returns a boolean value
SaveLastError( filename )

Saves the last error information to an XML formatted file.

// Returns a string
fileType( )

One of the following values:
  regular
  directory
  symLink
  special
  unknown
  socket
  charDevice
  blockDevice
  fifo
Returns a null on failure

// Returns a string
filename( )

The filename (or directory name, symbolic link name, etc.)
Returns a null on failure

// Returns a string
group( )

The group ownership of the file. This property is only supported by servers running SFTP v4 or later.
Returns a null on failure

// Returns a string
lastErrorHtml( )

Error information in HTML format for the last method called.
Returns a null on failure

// Returns a string
lastErrorText( )

Error information in plain-text format for the last method called.
Returns a null on failure

// Returns a string
lastErrorXml( )

Error information in XML format for the last method called.
Returns a null on failure

// Returns a string
owner( )

The owner of the file. This property is only supported by servers running SFTP v4 or later.
Returns a null on failure

// Returns a string
sizeStr( )

Same as Size64, but the number is returned as a string in decimal format.
Returns a null on failure

CkSFtpFile Java ProgrammingReference Documentation

CkSFtpFile

CkSFtpFile Java Programming
Reference Documentation