org.arl.fjage.shell

Class GetFileReq

java.lang.Object

org.arl.fjage.Message

org.arl.fjage.shell.GetFileReq

All Implemented Interfaces:

java.io.Serializable

public class GetFileReq
extends Message

Request to read a file or a directory. If the filename specified represents a directory, then the contents of the directory (list of files) are returned as a tab separated string with: filename, file size, last modification time. The time is represented as epoch time (milliseconds since 1 Jan 1970).

See Also:

Serialized Form

Field Summary

Fields inherited from class org.arl.fjage.Message

inReplyTo, msgID, perf, recipient, sender, sentAt

Constructor Summary

Constructors

Constructor and Description
GetFileReq() Create an empty request for file/directory.
GetFileReq(AgentID to) Create an empty request for file/directory.
GetFileReq(AgentID to, java.lang.String filename) Create request for file/directory.
GetFileReq(AgentID to, java.lang.String filename, long ofs, long len) Create request for partial file.
GetFileReq(java.lang.String filename) Create request for file/directory.
GetFileReq(java.lang.String filename, long ofs, long len) Create request for partial file.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getFilename() Get the name of the file/directory.
long	getLength() Get number of bytes to read from file.
long	getOffset() Get the start location in file to read from.
void	setFilename(java.lang.String filename) Set the name of the file/directory.
void	setLength(long len) Set number of bytes to read from file.
void	setOffset(long ofs) Set the start location in file to read from.

Methods inherited from class org.arl.fjage.Message

getInReplyTo, getJsonCache, getMessageID, getPerformative, getRecipient, getSender, getSentAt, setInReplyTo, setJsonCache, setMessageID, setPerformative, setRecipient, setSender, setSentAt, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

GetFileReq

public GetFileReq()

Create an empty request for file/directory.

GetFileReq

public GetFileReq(AgentID to)

Create an empty request for file/directory.

Parameters:

to - shell agent id.

GetFileReq

public GetFileReq(java.lang.String filename)

Create request for file/directory.

Parameters:

filename - name of the file/directory to read.

GetFileReq

public GetFileReq(AgentID to,
                  java.lang.String filename)

Create request for file/directory.

Parameters:

to - shell agent id.

filename - name of the file/directory to read.

GetFileReq

public GetFileReq(java.lang.String filename,
                  long ofs,
                  long len)

Create request for partial file.

Parameters:

filename - name of the file/directory to read.

ofs - start location in file (negative for offset relative to end of file).

len - maximum number of bytes to read (0 for unlimited).

GetFileReq

public GetFileReq(AgentID to,
                  java.lang.String filename,
                  long ofs,
                  long len)

Create request for partial file.

Parameters:

to - shell agent id.

filename - name of the file/directory to read.

ofs - start location in file (negative for offset relative to end of file).

len - maximum number of bytes to read (0 for unlimited).

Method Detail

getFilename

public java.lang.String getFilename()

Get the name of the file/directory.

Returns:

name of the file/directory.

setFilename

public void setFilename(java.lang.String filename)

Set the name of the file/directory.

Parameters:

filename - name of the file/directory.

getOffset

public long getOffset()

Get the start location in file to read from.

Returns:

start locaion in file (negative for offset relative to end of file).

setOffset

public void setOffset(long ofs)

Set the start location in file to read from.

Parameters:

ofs - start location in file (negative for offset relative to end of file).

getLength

public long getLength()

Get number of bytes to read from file.

Returns:

number of bytes to read, 0 for no limit.

setLength

public void setLength(long len)

Set number of bytes to read from file.

Parameters:

len - number of bytes to read, 0 for no limit.