org.waarp.common.file

Class AbstractFile

java.lang.Object

org.waarp.common.file.AbstractFile

All Implemented Interfaces:

FileInterface

Direct Known Subclasses:

FilesystemBasedFileImpl, PassthroughBasedFileImpl

public abstract class AbstractFile
extends Object
implements FileInterface

Author:

"Frederic Bregier"

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	isReady Is this Document ready to be accessed

Constructor Summary

Constructors

Constructor and Description
AbstractFile()

Method Summary

Methods

Modifier and Type	Method and Description
void	checkIdentify() Check if the authentication is correct
void	clear() Set empty this FtpFile, mark it unReady.
DataBlock	getMarker() Create a restart from context for the current FileInterface
boolean	restartMarker(Restart restart) Restart from a Marker for the current FileInterface if any.
boolean	retrieve() Ask to retrieve the current FileInterface.
boolean	store() Ask to store the current FileInterface.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.waarp.common.file.FileInterface

abortFile, canRead, canWrite, closeFile, delete, exists, getDir, getFile, getSession, isDirectory, isFile, isInReading, isInWriting, length, readDataBlock, renameTo, setPosition, writeDataBlock

Field Detail

isReady

protected boolean isReady

Is this Document ready to be accessed

Constructor Detail

AbstractFile

public AbstractFile()

Method Detail

clear

public void clear()
           throws CommandAbstractException

Description copied from interface: FileInterface

Set empty this FtpFile, mark it unReady.

Specified by:

clear in interface FileInterface

Throws:

CommandAbstractException

checkIdentify

public void checkIdentify()
                   throws Reply530Exception

Description copied from interface: FileInterface

Check if the authentication is correct

Specified by:

checkIdentify in interface FileInterface

Throws:

Reply530Exception

getMarker

public DataBlock getMarker()
                    throws CommandAbstractException

Description copied from interface: FileInterface

Create a restart from context for the current FileInterface

Specified by:

getMarker in interface FileInterface

Returns:

the dataBlock to send to the client

Throws:

CommandAbstractException

restartMarker

public boolean restartMarker(Restart restart)
                      throws CommandAbstractException

Description copied from interface: FileInterface

Restart from a Marker for the current FileInterface if any. This function is to be called at the beginning of every transfer so in store and retrieve method.

Specified by:

restartMarker in interface FileInterface

Returns:

True if the Marker is OK

Throws:

CommandAbstractException

retrieve

public boolean retrieve()
                 throws CommandAbstractException

Description copied from interface: FileInterface

Ask to retrieve the current FileInterface. This command returns quickly since it does not retrieve really. It prepares the object.

Specified by:

retrieve in interface FileInterface

Returns:

True if everything is ready

Throws:

CommandAbstractException

store

public boolean store()
              throws CommandAbstractException

Description copied from interface: FileInterface

Ask to store the current FileInterface. This command returns quickly since it does not store really. It prepares the object.

Specified by:

store in interface FileInterface

Returns:

True if everything is ready

Throws:

CommandAbstractException