Class FtpFileObject

java.lang.Object

org.apache.commons.vfs2.provider.AbstractFileObject<FtpFileSystem>

org.apache.commons.vfs2.provider.ftp.FtpFileObject

All Implemented Interfaces:

Closeable, AutoCloseable, Comparable<FileObject>, Iterable<FileObject>, FileObject

public class FtpFileObject
extends AbstractFileObject<FtpFileSystem>

An FTP file.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) class	FtpFileObject.FtpInputStream	An InputStream that monitors for end-of-file.
private class	FtpFileObject.FtpOutputStream	An OutputStream that monitors for end-of-file.

Field Summary

Fields

Modifier and Type	Field	Description
private Map<String, org.apache.commons.net.ftp.FTPFile>	childMap
private static final long	DEFAULT_TIMESTAMP
private static final Map<String, org.apache.commons.net.ftp.FTPFile>	EMPTY_FTP_FILE_MAP
private org.apache.commons.net.ftp.FTPFile	ftpFile
private final AtomicBoolean	inRefresh
private FileObject	linkDestination
private static final org.apache.commons.logging.Log	log
private boolean	mdtmSet
private final String	relPath
private static final org.apache.commons.net.ftp.FTPFile	UNKNOWN

Fields inherited from class AbstractFileObject

DEFAULT_BUFFER_SIZE

Fields inherited from interface FileObject

EMPTY_ARRAY

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	FtpFileObject(AbstractFileName name, FtpFileSystem fileSystem, FileName rootName)

Method Summary

Modifier and Type	Method	Description
protected void	doAttach()	Attaches this file object to its file resource.
protected void	doCreateFolder()	Creates this file as a folder.
protected void	doDelete()	Deletes the file.
protected void	doDetach()	Detaches this file object from its file resource.
private void	doGetChildren()	Fetches the children of this file, if not already cached.
protected long	doGetContentSize()	Returns the size of the file content (in bytes).
protected InputStream	doGetInputStream(int bufferSize)	Creates an input stream to read the file content from.
protected long	doGetLastModifiedTime()	Get the last modified time on an FTP file
protected OutputStream	doGetOutputStream(boolean bAppend)	Creates an output stream to write the file content to.
protected RandomAccessContent	doGetRandomAccessContent(RandomAccessMode mode)	Creates access to the file for random i/o.
protected FileType	doGetType()	Determines the type of the file, returns null if the file does not exist.
protected String[]	doListChildren()	Lists the children of the file.
protected FileObject[]	doListChildrenResolved()	Lists the children of this file.
protected void	doRename(FileObject newFile)	Renames the file
private org.apache.commons.net.ftp.FTPFile	getChildFile(String name, boolean flush)	Called by child file objects, to locate their FTP file info.
FileObject[]	getChildren()	Returns the file's list of children.
(package private) FtpFileObject.FtpInputStream	getInputStream(long filePointer)
private FileObject	getLinkDestination()
(package private) String	getRelPath()
private long	getTimestampMillis()	ftpFile is not null.
private boolean	isCircular(FileObject linkDest)	This is an over simplistic implementation for VFS-437.
protected void	onChange()	Called when the type or content of this file changes.
protected void	onChildrenChanged(FileName child, FileType newType)	Called when the children of this file change.
void	refresh()	This will prepare the fileObject to get resynchronized with the underlying file system if required.
private void	setFTPFile(boolean flush)	Sets the internal FTPFile for this instance.

Methods inherited from class AbstractFileObject

canRenameTo, childrenChanged, close, compareTo, copyFrom, createFile, createFolder, delete, delete, deleteAll, doCreateFileContent, doGetAttributes, doGetCertificates, doGetInputStream, doIsExecutable, doIsHidden, doIsReadable, doIsSameFile, doIsSymbolicLink, doIsWriteable, doRemoveAttribute, doSetAttribute, doSetExecutable, doSetLastModifiedTime, doSetReadable, doSetWritable, endOutput, exists, finalize, findFiles, findFiles, getAbstractFileSystem, getChild, getContent, getFileContentInfoFactory, getFileOperations, getFileSystem, getInputStream, getInputStream, getName, getOutputStream, getOutputStream, getParent, getPublicURIString, getRandomAccessContent, getType, getURL, handleChanged, handleCreate, handleDelete, holdObject, injectType, isAttached, isContentOpen, isExecutable, isFile, isFolder, isHidden, isReadable, isSameFile, isSymbolicLink, isWriteable, iterator, listFiles, moveTo, notifyAllStreamsClosed, resolveFile, resolveFile, setExecutable, setReadable, setWritable, toString

Methods inherited from class Object

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

Methods inherited from interface FileObject

getPath, getURI

Methods inherited from interface Iterable

forEach, spliterator

Field Details

DEFAULT_TIMESTAMP

private static final long DEFAULT_TIMESTAMP

See Also:

• Constant Field Values

EMPTY_FTP_FILE_MAP

private static final Map<String, org.apache.commons.net.ftp.FTPFile> EMPTY_FTP_FILE_MAP

UNKNOWN

private static final org.apache.commons.net.ftp.FTPFile UNKNOWN

log

private static final org.apache.commons.logging.Log log

mdtmSet

private volatile boolean mdtmSet

relPath

private final String relPath

ftpFile

private volatile org.apache.commons.net.ftp.FTPFile ftpFile

childMap

private volatile Map<String, org.apache.commons.net.ftp.FTPFile> childMap

linkDestination

private volatile FileObject linkDestination

inRefresh

private final AtomicBoolean inRefresh

Constructor Details

FtpFileObject

protected FtpFileObject(AbstractFileName name,
 FtpFileSystem fileSystem,
 FileName rootName)
                 throws FileSystemException

Throws:

FileSystemException

Method Details

doAttach

protected void doAttach()
                 throws IOException

Attaches this file object to its file resource.

Overrides:

doAttach in class AbstractFileObject<FtpFileSystem>

Throws:

IOException

doCreateFolder

protected void doCreateFolder()
                       throws Exception

Creates this file as a folder.

Overrides:

doCreateFolder in class AbstractFileObject<FtpFileSystem>

Throws:

Exception - if an error occurs.

doDelete

protected void doDelete()
                 throws Exception

Deletes the file.

Overrides:

doDelete in class AbstractFileObject<FtpFileSystem>

Throws:

Exception - if an error occurs.

doDetach

protected void doDetach()

Detaches this file object from its file resource.

Overrides:

doDetach in class AbstractFileObject<FtpFileSystem>

doGetChildren

private void doGetChildren()
                    throws IOException

Fetches the children of this file, if not already cached.

Throws:

IOException

doGetContentSize

protected long doGetContentSize()
                         throws Exception

Returns the size of the file content (in bytes).

Specified by:

doGetContentSize in class AbstractFileObject<FtpFileSystem>

Returns:

The size of the file in bytes.

Throws:

Exception - if an error occurs.

doGetInputStream

protected InputStream doGetInputStream(int bufferSize)
                                throws Exception

Creates an input stream to read the file content from.

Overrides:

doGetInputStream in class AbstractFileObject<FtpFileSystem>

Parameters:

bufferSize - Buffer size hint.

Returns:

An InputStream to read the file content.

Throws:

Exception - if an error occurs.

doGetLastModifiedTime

protected long doGetLastModifiedTime()
                              throws Exception

Get the last modified time on an FTP file

Overrides:

doGetLastModifiedTime in class AbstractFileObject<FtpFileSystem>

Returns:

The last modification time.

Throws:

Exception - if an error occurs.

See Also:

• AbstractFileObject.doGetLastModifiedTime()

doGetOutputStream

protected OutputStream doGetOutputStream(boolean bAppend)
                                  throws Exception

Creates an output stream to write the file content to.

Overrides:

doGetOutputStream in class AbstractFileObject<FtpFileSystem>

Parameters:

bAppend - true if the file should be appended to, false if it should be overwritten.

Returns:

An OutputStream to write to the file.

Throws:

Exception - if an error occurs.

doGetRandomAccessContent

protected RandomAccessContent doGetRandomAccessContent(RandomAccessMode mode)
                                                throws Exception

Description copied from class: AbstractFileObject

Creates access to the file for random i/o. Is only called if AbstractFileObject.doGetType() returns FileType.FILE.

It is guaranteed that there are no open output streams for this file when this method is called.

Overrides:

doGetRandomAccessContent in class AbstractFileObject<FtpFileSystem>

Parameters:

mode - The mode to access the file.

Returns:

The RandomAccessContext.

Throws:

Exception - if an error occurs.

doGetType

protected FileType doGetType()
                      throws Exception

Determines the type of the file, returns null if the file does not exist.

Specified by:

doGetType in class AbstractFileObject<FtpFileSystem>

Returns:

the type of the file.

Throws:

Exception - if an error occurs.

doListChildren

protected String[] doListChildren()
                           throws Exception

Lists the children of the file.

Specified by:

doListChildren in class AbstractFileObject<FtpFileSystem>

Returns:

a possible empty String array if the file is a directory or null or an exception if the file is not a directory or can't be read.

Throws:

Exception - if an error occurs.

doListChildrenResolved

protected FileObject[] doListChildrenResolved()
                                       throws Exception

Description copied from class: AbstractFileObject

Lists the children of this file.

Is only called if AbstractFileObject.doGetType() returns FileType.FOLDER.

The return value of this method is cached, so the implementation can be expensive. Other than doListChildren you could return FileObject's to e.g. reinitialize the type of the file.

(Introduced for Webdav: "permission denied on resource" during getType())

Overrides:

doListChildrenResolved in class AbstractFileObject<FtpFileSystem>

Returns:

The children of this FileObject.

Throws:

Exception - if an error occurs.

doRename

protected void doRename(FileObject newFile)
                 throws Exception

Renames the file

Overrides:

doRename in class AbstractFileObject<FtpFileSystem>

Parameters:

newFile - A FileObject with the new file name.

Throws:

Exception - if an error occurs.

getChildFile

private org.apache.commons.net.ftp.FTPFile getChildFile(String name,
 boolean flush)
                                                 throws IOException

Called by child file objects, to locate their FTP file info.

Parameters:

name - the file name in its native form ie. without URI stuff (%nn)

flush - recreate children cache

Throws:

IOException

getChildren

public FileObject[] getChildren()
                         throws FileSystemException

Returns the file's list of children.

Specified by:

getChildren in interface FileObject

Overrides:

getChildren in class AbstractFileObject<FtpFileSystem>

Returns:

The list of children

Throws:

FileSystemException - If there was a problem listing children

Since:

2.0

See Also:

• AbstractFileObject.getChildren()

getInputStream

FtpFileObject.FtpInputStream getInputStream(long filePointer)
                                     throws IOException

Throws:

IOException

getLinkDestination

private FileObject getLinkDestination()
                               throws FileSystemException

Throws:

FileSystemException

getRelPath

String getRelPath()

getTimestampMillis

private long getTimestampMillis()
                         throws IOException

ftpFile is not null.

Throws:

IOException

isCircular

private boolean isCircular(FileObject linkDest)
                    throws FileSystemException

This is an over simplistic implementation for VFS-437.

Throws:

FileSystemException

onChange

protected void onChange()
                 throws IOException

Called when the type or content of this file changes.

Overrides:

onChange in class AbstractFileObject<FtpFileSystem>

Throws:

IOException

onChildrenChanged

protected void onChildrenChanged(FileName child,
 FileType newType)

Called when the children of this file change.

Overrides:

onChildrenChanged in class AbstractFileObject<FtpFileSystem>

Parameters:

child - The name of the child that changed.

newType - The type of the file.

refresh

public void refresh()
             throws FileSystemException

Description copied from class: AbstractFileObject

This will prepare the fileObject to get resynchronized with the underlying file system if required.

Specified by:

refresh in interface FileObject

Overrides:

refresh in class AbstractFileObject<FtpFileSystem>

Throws:

FileSystemException - if an error occurs.

setFTPFile

private void setFTPFile(boolean flush)
                 throws IOException

Sets the internal FTPFile for this instance.

Throws:

IOException