net.sf.sshapi.sftp

Class SftpFile

java.lang.Object

net.sf.sshapi.sftp.SftpFile

public class SftpFile
extends java.lang.Object

Represents a single file on the remote server.

Field Summary

Fields

Modifier and Type	Field and Description
static int	TYPE_BLOCK File is a of block special device type
static int	TYPE_CHARACTER File is a of character special device type
static int	TYPE_DIRECTORY File is a of Directory type
static int	TYPE_FIFO File is a of FIFO type
static int	TYPE_FILE File is a of File type
static int	TYPE_LINK File is a of Symbolic Link type
static int	TYPE_SOCKET File is a of socket type
static int	TYPE_UNKNOWN File is a of an unknown type.
static char[]	TYPES Type mnemonics (match those returned by 'ls' command)

Constructor Summary

Constructors

Constructor and Description
SftpFile(int type, java.lang.String path, long size, long lastModified, long created, long accessed, int gid, int uid, int permissions) Constructor.

Method Summary

Modifier and Type	Method and Description
long	getAccessed() Get the time in milliseconds the file was last accessed.
long	getCreated() Get the time in milliseconds the file was created.
int	getGID() Get the group ID (GID).
long	getLastModified() Get the time this file was last modified in milliseconds since the epoch, or when it was created if it has not yet.
java.lang.String	getName() Get the base name of this file (i.e.
java.lang.String	getPath() Get the absolute path of this file.
int	getPermissions() Get the permissions value.
long	getSize() Get the size of this file in bytes.
int	getType() Get the type of file.
int	getUID() Get the user ID (UID)
boolean	isDirectory() Convenience method to determine if the file is a directory.
boolean	isFile() Convenience method to determine if the file is a regular file.
boolean	isLink() Convenience method to determine if the file is a symbolic link.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

TYPES

public static char[] TYPES

Type mnemonics (match those returned by 'ls' command)

TYPE_FILE

public static final int TYPE_FILE

File is a of File type

See Also:

getType(), Constant Field Values

TYPE_DIRECTORY

public static final int TYPE_DIRECTORY

File is a of Directory type

See Also:

getType(), Constant Field Values

TYPE_LINK

public static final int TYPE_LINK

File is a of Symbolic Link type

See Also:

getType(), Constant Field Values

TYPE_FIFO

public static final int TYPE_FIFO

File is a of FIFO type

See Also:

getType(), Constant Field Values

TYPE_UNKNOWN

public static final int TYPE_UNKNOWN

File is a of an unknown type.

See Also:

getType(), Constant Field Values

TYPE_SOCKET

public static final int TYPE_SOCKET

File is a of socket type

See Also:

getType(), Constant Field Values

TYPE_CHARACTER

public static final int TYPE_CHARACTER

File is a of character special device type

See Also:

getType(), Constant Field Values

TYPE_BLOCK

public static final int TYPE_BLOCK

File is a of block special device type

See Also:

getType(), Constant Field Values

Constructor Detail

SftpFile

public SftpFile(int type,
                java.lang.String path,
                long size,
                long lastModified,
                long created,
                long accessed,
                int gid,
                int uid,
                int permissions)

Constructor.

Parameters:

type - see getType()

path - full path to the file

size - size of file

lastModified - time in milliseconds since epoch file was last modified

created - time in milliseconds the file was created

accessed - time in milliseconds the file was last accessed

gid - the groud ID

uid - the user ID

permissions - permissions

Method Detail

isDirectory

public boolean isDirectory()

Convenience method to determine if the file is a directory.

Returns:

directory

isFile

public boolean isFile()

Convenience method to determine if the file is a regular file.

Returns:

regular file

isLink

public boolean isLink()

Convenience method to determine if the file is a symbolic link.

Returns:

regular file

getType

public int getType()

Get the type of file. May be one of TYPE_FILE, TYPE_DIRECTORY, TYPE_LINK, TYPE_UNKNOWN, TYPE_FIFO, TYPE_CHARACTER, TYPE_BLOCK or TYPE_LINK.

Returns:

type

getPath

public java.lang.String getPath()

Get the absolute path of this file.

Returns:

absolute path

getName

public java.lang.String getName()

Get the base name of this file (i.e. with out any path)

Returns:

base name

getSize

public long getSize()

Get the size of this file in bytes.

Returns:

size

getLastModified

public long getLastModified()

Get the time this file was last modified in milliseconds since the epoch, or when it was created if it has not yet. been modified.

Returns:

last modified

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getGID

public int getGID()

Get the group ID (GID).

Returns:

GID

getUID

public int getUID()

Get the user ID (UID)

Returns:

UID

getAccessed

public long getAccessed()

Get the time in milliseconds the file was last accessed.

Returns:

time in milliseconds the file was last accessed.

getCreated

public long getCreated()

Get the time in milliseconds the file was created.

Returns:

time in milliseconds the file was created.

getPermissions

public int getPermissions()

Get the permissions value.

Returns:

permissions