org.maestro.client.notes

Class LogResponse

java.lang.Object

org.maestro.client.notes.MaestroResponse

org.maestro.client.notes.LogResponse

All Implemented Interfaces:

MaestroNote

public class LogResponse
extends MaestroResponse

Field Summary

Fields

Modifier and Type	Field and Description
protected static int	LOG_RESPONSE_MAX_PAYLOAD_SIZE

Constructor Summary

Constructors

Constructor and Description
LogResponse()
LogResponse(org.msgpack.core.MessageUnpacker unpacker)

Method Summary

Modifier and Type	Method and Description
MessageCorrelation	correlate()
void	correlate(MaestroNote note)
void	correlate(MessageCorrelation correlation)
boolean	correlatesTo(MaestroNote note)
boolean	correlatesTo(MessageCorrelation correlation)
protected int	getChunkSize(int maxChunkSize)
File	getFile()
String	getFileHash()
String	getFileName()
LocationType	getLocationType()
InputStream	getLogData()
MaestroCommand	getMaestroCommand() Gets the Maestro command for the note
MaestroNoteType	getNoteType() Gets the note type
boolean	hasNext() Whether the note contains content that cannot be sent in a single exchange.
protected InputStream	initializeInputStream()
boolean	isLast()
void	join(LogResponse logResponse)
void	next() Moves to the next subsequent note
protected org.msgpack.core.MessageBufferPacker	pack()
byte[]	serialize() Serialize the note
void	setFile(File file)
void	setFileHash(String fileHash)
protected void	setFileName(String fileName)
protected void	setFileSize(long fileSize)
void	setLocationType(LocationType locationType)
protected void	setTotal(int total)
String	toString() Converts the note to string for debugging purposes

Methods inherited from class org.maestro.client.notes.MaestroResponse

getId, getName, setId, setName

Methods inherited from class java.lang.Object

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

Field Detail

LOG_RESPONSE_MAX_PAYLOAD_SIZE

protected static final int LOG_RESPONSE_MAX_PAYLOAD_SIZE

See Also:

Constant Field Values

Constructor Detail

LogResponse

public LogResponse()

LogResponse

public LogResponse(org.msgpack.core.MessageUnpacker unpacker)
            throws IOException

Throws:

IOException

Method Detail

getLocationType

public LocationType getLocationType()

setLocationType

public void setLocationType(LocationType locationType)

getFileName

public String getFileName()

setFileName

protected void setFileName(String fileName)

setFileSize

protected void setFileSize(long fileSize)

setTotal

protected void setTotal(int total)

getFileHash

public String getFileHash()

setFileHash

public void setFileHash(String fileHash)

getChunkSize

protected int getChunkSize(int maxChunkSize)

getFile

public File getFile()

setFile

public void setFile(File file)

pack

protected org.msgpack.core.MessageBufferPacker pack()
                                             throws IOException

Overrides:

pack in class MaestroResponse

Throws:

IOException

initializeInputStream

protected InputStream initializeInputStream()
                                     throws IOException

Throws:

IOException

join

public void join(LogResponse logResponse)

getLogData

public InputStream getLogData()

next

public void next()

Description copied from interface: MaestroNote

Moves to the next subsequent note

hasNext

public boolean hasNext()

Description copied from interface: MaestroNote

Whether the note contains content that cannot be sent in a single exchange. The data navigation is done internally whenever the pack method is called. This should repeat until it returns false

Returns:

true if there's a subsequent note to be processed or false otherwise

isLast

public boolean isLast()

toString

public String toString()

Description copied from interface: MaestroNote

Converts the note to string for debugging purposes

Specified by:

toString in interface MaestroNote

Overrides:

toString in class MaestroResponse

Returns:

the note in String format

getNoteType

public MaestroNoteType getNoteType()

Description copied from interface: MaestroNote

Gets the note type

Specified by:

getNoteType in interface MaestroNote

Returns:

the note type

getMaestroCommand

public MaestroCommand getMaestroCommand()

Description copied from interface: MaestroNote

Gets the Maestro command for the note

Specified by:

getMaestroCommand in interface MaestroNote

Returns:

the maestro command as an instance of MaestroCommand

correlate

public MessageCorrelation correlate()

Specified by:

correlate in interface MaestroNote

correlate

public void correlate(MessageCorrelation correlation)

Specified by:

correlate in interface MaestroNote

correlate

public void correlate(MaestroNote note)

Specified by:

correlate in interface MaestroNote

correlatesTo

public boolean correlatesTo(MessageCorrelation correlation)

Specified by:

correlatesTo in interface MaestroNote

correlatesTo

public boolean correlatesTo(MaestroNote note)

Specified by:

correlatesTo in interface MaestroNote

serialize

public final byte[] serialize()
                       throws IOException

Description copied from interface: MaestroNote

Serialize the note

Specified by:

serialize in interface MaestroNote

Returns:

The serialized note

Throws:

IOException - if unable to serialize the note