org.waarp.openr66.context.filesystem

Class R66File

java.lang.Object

org.waarp.common.file.AbstractFile

org.waarp.common.file.filesystembased.FilesystemBasedFileImpl

org.waarp.openr66.context.filesystem.R66File

All Implemented Interfaces:

FileInterface

public class R66File
extends FilesystemBasedFileImpl

File representation

Field Summary

Fields inherited from class org.waarp.common.file.filesystembased.FilesystemBasedFileImpl

currentFile, currentRealFile, isAppend, session

Fields inherited from class org.waarp.common.file.AbstractFile

isReady

Constructor Summary

Constructors

Constructor and Description
R66File(R66Session session, R66Dir dir, String path) This constructor is for External file
R66File(R66Session session, R66Dir dir, String path, boolean append)

Method Summary

Modifier and Type	Method and Description
boolean	canRead()
boolean	canWrite()
boolean	closeFile() Close the current FileInterface
boolean	delete() Delete the current FileInterface.
boolean	exists()
String	getBasename()
static String	getBasename(String path)
protected FileInputStream	getFileInputStream()
protected FileOutputStream	getFileOutputStream(boolean append) Returns the FileOutputStream in Out mode associated with the current file.
protected String	getFullInDir()
protected RandomAccessFile	getRandomFile() Returns the RandomAccessFile in Out mode associated with the current file.
R66Session	getSession()
File	getTrueFile() This method is a good to have in a true FileInterface implementation.
boolean	isDirectory() Is the current FileInterface a directory and exists
boolean	isExternal()
boolean	isFile() Is the current FileInterface a file and exists
long	length()
boolean	renameTo(String path) Rename the current FileInterface into a new filename from argument
boolean	renameTo(String path, boolean external) Move the current file to the path as destination
void	replaceFilename(String filename, boolean isExternal) Replace the current file with the new filename after closing the previous one.
void	retrieveBlocking(AtomicBoolean running) Start the retrieve (send to the remote host the local file)
String	toString()

Methods inherited from class org.waarp.common.file.filesystembased.FilesystemBasedFileImpl

abortFile, canRead, clear, exists, getDir, getFile, getFileFromPath, getPosition, getRelativePath, isDirectory, isFile, isInReading, isInWriting, readDataBlock, readDataBlock, setPosition, writeDataBlock

Methods inherited from class org.waarp.common.file.AbstractFile

checkIdentify, getMarker, restartMarker, retrieve, store

Methods inherited from class java.lang.Object

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

Constructor Detail

R66File

public R66File(R66Session session,
               R66Dir dir,
               String path,
               boolean append)
        throws CommandAbstractException

Parameters:

session -

dir -

path -

append -

Throws:

CommandAbstractException

R66File

public R66File(R66Session session,
               R66Dir dir,
               String path)

This constructor is for External file

Parameters:

session -

dir -

path -

Method Detail

retrieveBlocking

public final void retrieveBlocking(AtomicBoolean running)
                            throws OpenR66RunnerErrorException,
                                   OpenR66ProtocolSystemException

Start the retrieve (send to the remote host the local file)

Parameters:

running - When false, should stop the runner

Throws:

OpenR66RunnerErrorException

OpenR66ProtocolSystemException

getTrueFile

public final File getTrueFile()

This method is a good to have in a true FileInterface implementation.

Returns:

the File associated with the current FileInterface operation

getBasename

public final String getBasename()

Returns:

the basename of the current file

getBasename

public static String getBasename(String path)

Parameters:

path -

Returns:

the basename from the given path

getSession

public final R66Session getSession()

Specified by:

getSession in interface FileInterface

Overrides:

getSession in class FilesystemBasedFileImpl

Returns:

the FtpSession

canRead

public final boolean canRead()
                      throws CommandAbstractException

Specified by:

canRead in interface FileInterface

Overrides:

canRead in class FilesystemBasedFileImpl

Returns:

True if the current FileInterface is ready for reading

Throws:

CommandAbstractException

canWrite

public final boolean canWrite()
                       throws CommandAbstractException

Specified by:

canWrite in interface FileInterface

Overrides:

canWrite in class FilesystemBasedFileImpl

Returns:

True if the current FileInterface is ready for writing

Throws:

CommandAbstractException

delete

public final boolean delete()
                     throws CommandAbstractException

Description copied from interface: FileInterface

Delete the current FileInterface.

Specified by:

delete in interface FileInterface

Overrides:

delete in class FilesystemBasedFileImpl

Returns:

True if OK, else False if not (or if the file never exists).

Throws:

CommandAbstractException

exists

public final boolean exists()
                     throws CommandAbstractException

Specified by:

exists in interface FileInterface

Overrides:

exists in class FilesystemBasedFileImpl

Returns:

True if the current FileInterface exists

Throws:

CommandAbstractException

getFileInputStream

protected final FileInputStream getFileInputStream()

Overrides:

getFileInputStream in class FilesystemBasedFileImpl

getRandomFile

protected final RandomAccessFile getRandomFile()

Description copied from class: FilesystemBasedFileImpl

Returns the RandomAccessFile in Out mode associated with the current file.

Overrides:

getRandomFile in class FilesystemBasedFileImpl

Returns:

the RandomAccessFile (OUT="rw")

getFileOutputStream

protected final FileOutputStream getFileOutputStream(boolean append)

Returns the FileOutputStream in Out mode associated with the current file.

Overrides:

getFileOutputStream in class FilesystemBasedFileImpl

Parameters:

append - True if the FileOutputStream should be in append mode

Returns:

the FileOutputStream (OUT)

isDirectory

public final boolean isDirectory()
                          throws CommandAbstractException

Description copied from interface: FileInterface

Is the current FileInterface a directory and exists

Specified by:

isDirectory in interface FileInterface

Overrides:

isDirectory in class FilesystemBasedFileImpl

Returns:

True if it is a directory and it exists

Throws:

CommandAbstractException

isFile

public final boolean isFile()
                     throws CommandAbstractException

Description copied from interface: FileInterface

Is the current FileInterface a file and exists

Specified by:

isFile in interface FileInterface

Overrides:

isFile in class FilesystemBasedFileImpl

Returns:

True if it is a file and it exists

Throws:

CommandAbstractException

length

public final long length()
                  throws CommandAbstractException

Specified by:

length in interface FileInterface

Overrides:

length in class FilesystemBasedFileImpl

Returns:

the length of the current FileInterface

Throws:

CommandAbstractException

getFullInDir

protected final String getFullInDir()

renameTo

public final boolean renameTo(String path)
                       throws CommandAbstractException

Description copied from interface: FileInterface

Rename the current FileInterface into a new filename from argument

Specified by:

renameTo in interface FileInterface

Overrides:

renameTo in class FilesystemBasedFileImpl

Parameters:

path - the new filename (path could be relative or absolute - without mount point)

Returns:

True if the operation is done successfully

Throws:

CommandAbstractException

renameTo

public final boolean renameTo(String path,
                              boolean external)
                       throws CommandAbstractException

Move the current file to the path as destination

Parameters:

path -

external - if True, the path is outside authentication control

Returns:

True if the operation is done

Throws:

CommandAbstractException

replaceFilename

public final void replaceFilename(String filename,
                                  boolean isExternal)
                           throws CommandAbstractException

Replace the current file with the new filename after closing the previous one.

Parameters:

filename -

isExternal -

Throws:

CommandAbstractException

closeFile

public final boolean closeFile()
                        throws CommandAbstractException

Description copied from interface: FileInterface

Close the current FileInterface

Specified by:

closeFile in interface FileInterface

Overrides:

closeFile in class FilesystemBasedFileImpl

Returns:

True if correctly closed

Throws:

CommandAbstractException

isExternal

public final boolean isExternal()

Returns:

True if this file is outside OpenR66 Base directory

toString

public String toString()

Overrides:

toString in class Object