org.apache.taverna.server.localworker.remote

Interface RemoteFile

All Superinterfaces:

Remote, RemoteDirectoryEntry

All Known Implementing Classes:

FileDelegate

public interface RemoteFile
extends RemoteDirectoryEntry

Represents a file in the working directory of a workflow instance run, or in some sub-directory of it.

Author:

Donal Fellows

See Also:

RemoteDirectory

Method Summary

Modifier and Type	Method and Description
void	appendContents(byte[] data) Append the data to the file.
void	copy(RemoteFile sourceFile) Copy from another file to this one.
byte[]	getContents(int offset, int length) Read from the file.
String	getNativeHost()
String	getNativeName()
long	getSize()
void	setContents(byte[] data) Write the data to the file, totally replacing what was there before.

Methods inherited from interface org.apache.taverna.server.localworker.remote.RemoteDirectoryEntry

destroy, getContainingDirectory, getModificationDate, getName

Method Detail

getContents

@Nonnull
byte[] getContents(int offset,
                            int length)
                     throws RemoteException,
                            IOException

Read from the file.

Parameters:

offset - Where in the file to read the bytes from.

length - How much of the file to read; -1 for "to the end".

Returns:

The literal byte contents of the given section of the file.

Throws:

RemoteException - If anything goes wrong with the communication.

IOException - If things go wrong reading the file.

setContents

void setContents(@Nonnull
                 byte[] data)
          throws RemoteException,
                 IOException

Write the data to the file, totally replacing what was there before.

Parameters:

data - The literal bytes that will form the new contents of the file.

Throws:

RemoteException - If anything goes wrong with the communication.

IOException - If things go wrong writing the contents.

appendContents

void appendContents(@Nonnull
                    byte[] data)
             throws RemoteException,
                    IOException

Append the data to the file.

Parameters:

data - The literal bytes that will be appended.

Throws:

RemoteException - If anything goes wrong with the communication.

IOException - If things go wrong writing the contents.

getSize

long getSize()
      throws RemoteException

Returns:

The length of the file, in bytes.

Throws:

RemoteException - If anything goes wrong with the communication.

copy

void copy(@Nonnull
          RemoteFile sourceFile)
   throws RemoteException,
          IOException

Copy from another file to this one.

Parameters:

sourceFile - The other file to copy from.

Throws:

RemoteException - If anything goes wrong with the communication.

IOException - If things go wrong during the copy.

getNativeName

@Nonnull
String getNativeName()
                       throws RemoteException

Returns:

The full native OS name for the file.

Throws:

RemoteException - If anything goes wrong with the communication.

getNativeHost

@Nonnull
String getNativeHost()
                       throws RemoteException

Returns:

The host holding the file.

Throws:

RemoteException - If anything goes wrong with the communication.