org.maestro.client.notes

Class MaestroRequest<T>

java.lang.Object

org.maestro.client.notes.MaestroEvent<T>

org.maestro.client.notes.MaestroRequest<T>

All Implemented Interfaces:

MaestroNote

Direct Known Subclasses:

AgentSourceRequest, DrainRequest, FlushRequest, GetRequest, Halt, LogRequest, PingRequest, SetRequest, StartAgent, StartInspector, StartReceiver, StartSender, StatsRequest, StopAgent, StopInspector, StopReceiver, StopSender, UserCommand1Request

public abstract class MaestroRequest<T>
extends MaestroEvent<T>

Constructor Summary

Constructors

Constructor and Description
MaestroRequest(MaestroCommand maestroCommand)
MaestroRequest(MaestroCommand maestroCommand, 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)
MaestroCommand	getMaestroCommand() Gets the Maestro command for the note
MaestroNoteType	getNoteType() Gets the note type
protected org.msgpack.core.MessageBufferPacker	pack()
byte[]	serialize() Serialize the note
String	toString() Converts the note to string for debugging purposes

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

notify

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.maestro.common.client.notes.MaestroNote

hasNext, next

Constructor Detail

MaestroRequest

public MaestroRequest(MaestroCommand maestroCommand)

MaestroRequest

public MaestroRequest(MaestroCommand maestroCommand,
                      org.msgpack.core.MessageUnpacker unpacker)
               throws IOException

Throws:

IOException

Method Detail

toString

public String toString()

Description copied from interface: MaestroNote

Converts the note to string for debugging purposes

Specified by:

toString in interface MaestroNote

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

pack

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

Throws:

IOException

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