SftpATTRS (JSch API)

java.lang.Object
- com.jcraft.jsch.SftpATTRS

```
public class SftpATTRS
extends Object
```
Attributes of a (remote) file manipulated via Sftp. An SftpATTRS object can contain a variable number of actual attributes. A flags field defines which attributes are present in the structure, and then only these follow.
This class manages the flags automatically, the setXXX methods also set the corresponding flag.

When changing attributes using ChannelSftp.setStat(), only these attributes actually contained in the structure are sent to the server and will be changed.

This class corresponds to the ATTRS structure in the form defined in version 00-02 of the Internet draft SSH File Transfer Protocol, corresponding to version 3 of the SSH File transfer protocol. (Later versions changed the format, and there is no version actually published as RFC.)
Here is a quote from the specification:
```
   uint32   flags
   uint64   size           present only if flag SSH_FILEXFER_ATTR_SIZE
   uint32   uid            present only if flag SSH_FILEXFER_ATTR_UIDGID
   uint32   gid            present only if flag SSH_FILEXFER_ATTR_UIDGID
   uint32   permissions    present only if flag SSH_FILEXFER_ATTR_PERMISSIONS
   uint32   atime          present only if flag SSH_FILEXFER_ACMODTIME
   uint32   mtime          present only if flag SSH_FILEXFER_ACMODTIME
   uint32   extended_count present only if flag SSH_FILEXFER_ATTR_EXTENDED
   string   extended_type
   string   extended_data
     ...      more extended data (extended_type - extended_data pairs),
              so that number of pairs equals extended_count
 
```
See Also:

ChannelSftp, stat(), lstat(), setStat()

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`SSH_FILEXFER_ATTR_ACMODTIME` Flag indicating the presence of the `atime` and `mtime` attributes.
`static int`	`SSH_FILEXFER_ATTR_EXTENDED` Flag indicating the presence of extended attributes.
`static int`	`SSH_FILEXFER_ATTR_PERMISSIONS` Flag indicating the presence of the `permissions` attribute.
`static int`	`SSH_FILEXFER_ATTR_SIZE` Flag indicating the presence of the `size` attribute.
`static int`	`SSH_FILEXFER_ATTR_UIDGID` Flag indicating the presence of the `uid` and `gid` attributes.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`getATime()` returns the last access time.
`String`	`getAtimeString()` returns a string representation of the access time.
`String[]`	`getExtended()` returns extended attributes, if any.
`int`	`getFlags()` returns the flags indicating which attributes are present.
`int`	`getGId()` returns the numerical group identifier of the owning group.
`int`	`getMTime()` returns the last modification time.
`String`	`getMtimeString()` returns a string representation of the modifiying time.
`int`	`getPermissions()` Returns the Unix permissions of the file.
`String`	`getPermissionsString()` Returns a string representation of the permissions in the format used by `ls -l`.
`long`	`getSize()` Returns the size of the file, in bytes.
`int`	`getUId()` returns the numerical user identifier of the owning user.
`boolean`	`isBlk()`
`boolean`	`isChr()`
`boolean`	`isDir()` checks whether this file is a directory.
`boolean`	`isFifo()`
`boolean`	`isLink()` checks whether this file is a symbolic link.
`boolean`	`isReg()`
`boolean`	`isSock()`
`void`	`setACMODTIME(int atime, int mtime)` Sets access and modification time.
`void`	`setPERMISSIONS(int permissions)` sets the file permissions.
`void`	`setSIZE(long size)` sets the size.
`void`	`setUIDGID(int uid, int gid)` Sets user and group Identifier.
`String`	`toString()` creates a string representation of this object.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - SSH_FILEXFER_ATTR_SIZE
```
public static final int SSH_FILEXFER_ATTR_SIZE
```
    Flag indicating the presence of the size attribute.
    
    See Also:
    
    Constant Field Values
  - SSH_FILEXFER_ATTR_UIDGID
```
public static final int SSH_FILEXFER_ATTR_UIDGID
```
    Flag indicating the presence of the uid and gid attributes.
    
    See Also:
    
    Constant Field Values
  - SSH_FILEXFER_ATTR_PERMISSIONS
```
public static final int SSH_FILEXFER_ATTR_PERMISSIONS
```
    Flag indicating the presence of the permissions attribute.
    
    See Also:
    
    Constant Field Values
  - SSH_FILEXFER_ATTR_ACMODTIME
```
public static final int SSH_FILEXFER_ATTR_ACMODTIME
```
    Flag indicating the presence of the atime and mtime attributes.
    
    See Also:
    
    Constant Field Values
  - SSH_FILEXFER_ATTR_EXTENDED
```
public static final int SSH_FILEXFER_ATTR_EXTENDED
```
    Flag indicating the presence of extended attributes.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - getPermissionsString
```
public String getPermissionsString()
```
    Returns a string representation of the permissions in the format used by ls -l.
  - getAtimeString
```
public String getAtimeString()
```
    returns a string representation of the access time.
  - getMtimeString
```
public String getMtimeString()
```
    returns a string representation of the modifiying time.
  - setSIZE
```
public void setSIZE(long size)
```
    sets the size.
  - setUIDGID
```
public void setUIDGID(int uid,
                      int gid)
```
    Sets user and group Identifier.
  - setACMODTIME
```
public void setACMODTIME(int atime,
                         int mtime)
```
    Sets access and modification time.
  - setPERMISSIONS
```
public void setPERMISSIONS(int permissions)
```
    sets the file permissions.
    
    Parameters:
    
    permissions - a bit mask containing some combination of the bits 0-11.
  - isReg
```
public boolean isReg()
```
  - isDir
```
public boolean isDir()
```
    checks whether this file is a directory.
    
    Returns:
    
    true if the permissions are included in the structure and the directory bit is set.
  - isChr
```
public boolean isChr()
```
  - isBlk
```
public boolean isBlk()
```
  - isFifo
```
public boolean isFifo()
```
  - isLink
```
public boolean isLink()
```
    checks whether this file is a symbolic link.
    
    Returns:
    
    true if the permissions are included in the structure and the link bits are set.
  - isSock
```
public boolean isSock()
```
  - getFlags
```
public int getFlags()
```
    returns the flags indicating which attributes are present.
  - getSize
```
public long getSize()
```
    Returns the size of the file, in bytes.
  - getUId
```
public int getUId()
```
    returns the numerical user identifier of the owning user.
    The `uid' and `gid' fields contain numeric Unix-like user and group identifiers, respectively.
  - getGId
```
public int getGId()
```
    returns the numerical group identifier of the owning group.
    The `uid' and `gid' fields contain numeric Unix-like user and group identifiers, respectively.
  - getPermissions
```
public int getPermissions()
```
    Returns the Unix permissions of the file.
    The `permissions' field contains a bit mask of file permissions as defined by posix.
  - getATime
```
public int getATime()
```
    returns the last access time.
    The `atime' and `mtime' contain the access and modification times of the files, respectively. They are represented as seconds from Jan 1, 1970 in UTC.
  - getMTime
```
public int getMTime()
```
    returns the last modification time.
    The `atime' and `mtime' contain the access and modification times of the files, respectively. They are represented as seconds from Jan 1, 1970 in UTC.
  - getExtended
```
public String[] getExtended()
```
    returns extended attributes, if any.
    
    Returns:
    
    the attributes, in the form of a string array, alternating type identifier and value.
  - toString
```
public String toString()
```
    creates a string representation of this object. This string contains permissions, UID, GID, size and modification time.
    
    Overrides:
    
    toString in class Object

This is an inofficial Javadoc created by Paŭlo Ebermann. Have a look at the official homepage.

Class SftpATTRS

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SSH_FILEXFER_ATTR_SIZE

SSH_FILEXFER_ATTR_UIDGID

SSH_FILEXFER_ATTR_PERMISSIONS

SSH_FILEXFER_ATTR_ACMODTIME

SSH_FILEXFER_ATTR_EXTENDED

Method Detail

getPermissionsString

getAtimeString

getMtimeString

setSIZE

setUIDGID

setACMODTIME

setPERMISSIONS

isReg

isDir

isChr

isBlk

isFifo

isLink

isSock

getFlags

getSize

getUId

getGId

getPermissions

getATime

getMTime

getExtended

toString