Package org.apache.commons.net.ftp
Class FTPFile
java.lang.Object
org.apache.commons.net.ftp.FTPFile
- All Implemented Interfaces:
Serializable
The FTPFile class is used to represent information about files stored on an FTP server.
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate Calendar
static final int
A constant indicating an FTPFile is a directory.static final int
A constant indicating file execute permission or directory listing permission.static final int
A constant indicating an FTPFile is a file.private String
static final int
A constant indicating group access permissions.private int
0 is invalid as a link count.private String
private String
private final boolean[][]
If this is null, then list entry parsing failed.private String
static final int
A constant indicating file/directory read permission.private static final long
private long
0 is valid, so use -1.static final int
A constant indicating an FTPFile is a symbolic link.private int
static final int
A constant indicating an FTPFile is of unknown type.private String
static final int
A constant indicating user access permissions.static final int
A constant indicating world access permissions.static final int
A constant indicating file/directory write permission. -
Constructor Summary
ConstructorsConstructorDescriptionFTPFile()
Creates an empty FTPFile.Constructor for use byFTPListParseEngine
only. -
Method Summary
Modifier and TypeMethodDescriptionprivate char
getGroup()
Gets the name of the group owning the file.int
Gets the number of hard links to this file.getLink()
If the FTPFile is a symbolic link, this method returns the name of the file being pointed to by the symbolic link.getName()
Gets the name of the file.Gets the original FTP server raw listing used to initialize the FTPFile.long
getSize()
Gets the file size in bytes.Gets the file timestamp.int
getType()
Gets the type of the file (one of the_TYPE
constants), e.g., if it is a directory, a regular file, or a symbolic link.getUser()
Gets the name of the user owning the file.boolean
hasPermission
(int access, int permission) Tests if the given access group (one of the_ACCESS
constants) has the given access permission (one of the_PERMISSION
constants) to the file.boolean
Tests if the file is a directory.boolean
isFile()
Tests if the file is a regular file.boolean
Tests if the file is a symbolic link.boolean
Tests if the type of the file is unknown.boolean
isValid()
Tests whether an entry is valid or not.private String
permissionToString
(int access) void
Sets the name of the group owning the file.void
setHardLinkCount
(int links) Sets the number of hard links to this file.void
If the FTPFile is a symbolic link, use this method to set the name of the file being pointed to by the symbolic link.void
Sets the name of the file.void
setPermission
(int access, int permission, boolean value) Sets if the given access group (one of the_ACCESS
constants) has the given access permission (one of the_PERMISSION
constants) to the file.void
setRawListing
(String rawListing) Sets the original FTP server raw listing from which the FTPFile was created.void
setSize
(long size) Sets the file size in bytes.void
setTimestamp
(Calendar date) Sets the file timestamp.void
setType
(int type) Sets the type of the file (DIRECTORY_TYPE
,FILE_TYPE
, etc.).void
Sets the name of the user owning the file.Gets a string representation of the FTPFile information.toFormattedString
(String timezone) Gets a string representation of the FTPFile information.toString()
Gets a string representation of the FTPFile information.
-
Field Details
-
serialVersionUID
private static final long serialVersionUID- See Also:
-
FILE_TYPE
public static final int FILE_TYPEA constant indicating an FTPFile is a file.- See Also:
-
DIRECTORY_TYPE
public static final int DIRECTORY_TYPEA constant indicating an FTPFile is a directory.- See Also:
-
SYMBOLIC_LINK_TYPE
public static final int SYMBOLIC_LINK_TYPEA constant indicating an FTPFile is a symbolic link.- See Also:
-
UNKNOWN_TYPE
public static final int UNKNOWN_TYPEA constant indicating an FTPFile is of unknown type.- See Also:
-
USER_ACCESS
public static final int USER_ACCESSA constant indicating user access permissions.- See Also:
-
GROUP_ACCESS
public static final int GROUP_ACCESSA constant indicating group access permissions.- See Also:
-
WORLD_ACCESS
public static final int WORLD_ACCESSA constant indicating world access permissions.- See Also:
-
READ_PERMISSION
public static final int READ_PERMISSIONA constant indicating file/directory read permission.- See Also:
-
WRITE_PERMISSION
public static final int WRITE_PERMISSIONA constant indicating file/directory write permission.- See Also:
-
EXECUTE_PERMISSION
public static final int EXECUTE_PERMISSIONA constant indicating file execute permission or directory listing permission.- See Also:
-
type
private int type -
hardLinkCount
private int hardLinkCount0 is invalid as a link count. -
size
private long size0 is valid, so use -1. -
rawListing
-
user
-
group
-
name
-
link
-
date
-
permissions
private final boolean[][] permissionsIf this is null, then list entry parsing failed.
-
-
Constructor Details
-
FTPFile
public FTPFile()Creates an empty FTPFile. -
FTPFile
FTPFile(String rawListing) Constructor for use byFTPListParseEngine
only. Used to create FTPFile entries for failed parses- Parameters:
rawListing
- line that could not be parsed.- Since:
- 3.4
-
-
Method Details
-
formatType
private char formatType() -
getGroup
Gets the name of the group owning the file. Sometimes this will be a string representation of the group number.- Returns:
- The name of the group owning the file.
-
getHardLinkCount
public int getHardLinkCount()Gets the number of hard links to this file. This is not to be confused with symbolic links.- Returns:
- The number of hard links to this file.
-
getLink
If the FTPFile is a symbolic link, this method returns the name of the file being pointed to by the symbolic link. Otherwise it returns null.- Returns:
- The file pointed to by the symbolic link (null if the FTPFile is not a symbolic link).
-
getName
Gets the name of the file.- Returns:
- The name of the file.
-
getRawListing
Gets the original FTP server raw listing used to initialize the FTPFile.- Returns:
- The original FTP server raw listing used to initialize the FTPFile.
-
getSize
public long getSize()Gets the file size in bytes.- Returns:
- The file size in bytes.
-
getTimestamp
Gets the file timestamp. This usually the last modification time.- Returns:
- A Calendar instance representing the file timestamp.
-
getType
public int getType()Gets the type of the file (one of the_TYPE
constants), e.g., if it is a directory, a regular file, or a symbolic link.- Returns:
- The type of the file.
-
getUser
Gets the name of the user owning the file. Sometimes this will be a string representation of the user number.- Returns:
- The name of the user owning the file.
-
hasPermission
public boolean hasPermission(int access, int permission) Tests if the given access group (one of the_ACCESS
constants) has the given access permission (one of the_PERMISSION
constants) to the file.- Parameters:
access
- The access group (one of the_ACCESS
constants)permission
- The access permission (one of the_PERMISSION
constants)- Returns:
- true if
isValid()
istrue &&
the associated permission is set;false
otherwise. - Throws:
ArrayIndexOutOfBoundsException
- if either of the parameters is out of range
-
isDirectory
public boolean isDirectory()Tests if the file is a directory.- Returns:
- True if the file is of type
DIRECTORY_TYPE
, false if not.
-
isFile
public boolean isFile()Tests if the file is a regular file.- Returns:
- True if the file is of type
FILE_TYPE
, false if not.
-
isSymbolicLink
public boolean isSymbolicLink()Tests if the file is a symbolic link.- Returns:
- True if the file is of type
UNKNOWN_TYPE
, false if not.
-
isUnknown
public boolean isUnknown()Tests if the type of the file is unknown.- Returns:
- True if the file is of type
UNKNOWN_TYPE
, false if not.
-
isValid
public boolean isValid()Tests whether an entry is valid or not. If the entry is invalid, only thegetRawListing()
method will be useful. Other methods may fail. Used in conjunction with list parsing that preseverves entries that failed to parse.- Returns:
- true if the entry is valid
- Since:
- 3.4
- See Also:
-
permissionToString
-
setGroup
Sets the name of the group owning the file. This may be a string representation of the group number.- Parameters:
group
- The name of the group owning the file.
-
setHardLinkCount
public void setHardLinkCount(int links) Sets the number of hard links to this file. This is not to be confused with symbolic links.- Parameters:
links
- The number of hard links to this file.
-
setLink
If the FTPFile is a symbolic link, use this method to set the name of the file being pointed to by the symbolic link.- Parameters:
link
- The file pointed to by the symbolic link.
-
setName
Sets the name of the file.- Parameters:
name
- The name of the file.
-
setPermission
public void setPermission(int access, int permission, boolean value) Sets if the given access group (one of the_ACCESS
constants) has the given access permission (one of the_PERMISSION
constants) to the file.- Parameters:
access
- The access group (one of the_ACCESS
constants)permission
- The access permission (one of the_PERMISSION
constants)value
- True if permission is allowed, false if not.- Throws:
ArrayIndexOutOfBoundsException
- if either of the parameters is out of range
-
setRawListing
Sets the original FTP server raw listing from which the FTPFile was created.- Parameters:
rawListing
- The raw FTP server listing.
-
setSize
public void setSize(long size) Sets the file size in bytes.- Parameters:
size
- The file size in bytes.
-
setTimestamp
Sets the file timestamp. This usually the last modification time. The parameter is not cloned, so do not alter its value after calling this method.- Parameters:
date
- A Calendar instance representing the file timestamp.
-
setType
public void setType(int type) Sets the type of the file (DIRECTORY_TYPE
,FILE_TYPE
, etc.).- Parameters:
type
- The integer code representing the type of the file.
-
setUser
Sets the name of the user owning the file. This may be a string representation of the user number;- Parameters:
user
- The name of the user owning the file.
-
toFormattedString
Gets a string representation of the FTPFile information. This currently mimics the Unix listing format. This method uses the time zone of the Calendar entry, which is the server time zone (if one was provided) otherwise it is the local time zone.Note: if the instance is not valid
isValid()
, no useful information can be returned. In this case, usegetRawListing()
instead.- Returns:
- A string representation of the FTPFile information.
- Since:
- 3.0
-
toFormattedString
Gets a string representation of the FTPFile information. This currently mimics the Unix listing format. This method allows the Calendar time zone to be overridden.Note: if the instance is not valid
isValid()
, no useful information can be returned. In this case, usegetRawListing()
instead.- Parameters:
timezone
- the time zone to use for displaying the time stamp Ifnull
, then use the Calendar entry- Returns:
- A string representation of the FTPFile information.
- Since:
- 3.4
-
toString
Gets a string representation of the FTPFile information.
-