net.formicary.remoterun.common.proto

Enum RemoteRun.MasterToAgent.MessageType

java.lang.Object

java.lang.Enum<RemoteRun.MasterToAgent.MessageType>

net.formicary.remoterun.common.proto.RemoteRun.MasterToAgent.MessageType

All Implemented Interfaces:

com.google.protobuf.Internal.EnumLite, com.google.protobuf.ProtocolMessageEnum, Serializable, Comparable<RemoteRun.MasterToAgent.MessageType>

Enclosing class:

RemoteRun.MasterToAgent

public static enum RemoteRun.MasterToAgent.MessageType
extends Enum<RemoteRun.MasterToAgent.MessageType>
implements com.google.protobuf.ProtocolMessageEnum

Protobuf enum MasterToAgent.MessageType

Enum Constant Summary

Enum Constants

Enum Constant and Description
CLOSE_STDIN CLOSE_STDIN = 3;
REQUEST_DATA REQUEST_DATA = 4;
RUN_COMMAND RUN_COMMAND = 1;
SEND_DATA_FRAGMENT SEND_DATA_FRAGMENT = 6;
SEND_DATA_NOTIFICATION SEND_DATA_NOTIFICATION = 5;
STDIN_FRAGMENT STDIN_FRAGMENT = 2;

Field Summary

Fields

Modifier and Type	Field and Description
static int	CLOSE_STDIN_VALUE CLOSE_STDIN = 3;
static int	REQUEST_DATA_VALUE REQUEST_DATA = 4;
static int	RUN_COMMAND_VALUE RUN_COMMAND = 1;
static int	SEND_DATA_FRAGMENT_VALUE SEND_DATA_FRAGMENT = 6;
static int	SEND_DATA_NOTIFICATION_VALUE SEND_DATA_NOTIFICATION = 5;
static int	STDIN_FRAGMENT_VALUE STDIN_FRAGMENT = 2;

Method Summary

Methods

Modifier and Type	Method and Description
static com.google.protobuf.Descriptors.EnumDescriptor	getDescriptor()
com.google.protobuf.Descriptors.EnumDescriptor	getDescriptorForType()
int	getNumber()
com.google.protobuf.Descriptors.EnumValueDescriptor	getValueDescriptor()
static com.google.protobuf.Internal.EnumLiteMap<RemoteRun.MasterToAgent.MessageType>	internalGetValueMap()
static RemoteRun.MasterToAgent.MessageType	valueOf(com.google.protobuf.Descriptors.EnumValueDescriptor desc)
static RemoteRun.MasterToAgent.MessageType	valueOf(int value)
static RemoteRun.MasterToAgent.MessageType	valueOf(String name) Returns the enum constant of this type with the specified name.
static RemoteRun.MasterToAgent.MessageType[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

RUN_COMMAND

public static final RemoteRun.MasterToAgent.MessageType RUN_COMMAND

RUN_COMMAND = 1;

(requestId, runCommand) populated

A request to run the given command on the agent.  The requestId is used to identify all future messages concerning
this particular process instance.
 

STDIN_FRAGMENT

public static final RemoteRun.MasterToAgent.MessageType STDIN_FRAGMENT

STDIN_FRAGMENT = 2;

(requestId, fragment) populated

An additional fragment of stdin data that should be sent to the specified process running on the agent.  Will be
ignored by the agent if process is not running.
 

CLOSE_STDIN

public static final RemoteRun.MasterToAgent.MessageType CLOSE_STDIN

CLOSE_STDIN = 3;

(requestId) populated

An instruction to close the stdin stream since no more data will be provided to the process.   It is not required to
close stdin.
 

REQUEST_DATA

public static final RemoteRun.MasterToAgent.MessageType REQUEST_DATA

REQUEST_DATA = 4;

(requestId, path) populated

Message #1: Master to Agent
When the master wants a file from the agent, it sends a REQUEST_DATA stating which file or directory it wants.

Message #2+: Agent to Master
The agent responds with one or more REQUESTED_DATA messages including the requestId and fragment of data.  When the
file is either finished sending, or the agent encountered a problem that caused it to fail, the exitCode and
exitReason are populated where applicable.
 

SEND_DATA_NOTIFICATION

public static final RemoteRun.MasterToAgent.MessageType SEND_DATA_NOTIFICATION

SEND_DATA_NOTIFICATION = 5;

(requestId, path) populated

Message #1: Master to Agent
When the master wants to send the agent a file, it sends a SEND_DATA_NOTIFICATION to the agent.  This contains a
location on the agent that the master would like to use to store the sent file, and a request ID to correlate
related SEND_DATA_* type messages.
SEND_DATA_NOTIFICATION has (requestId, path) populated.

Message #2: Master to Agent
Subsequently, the master sends one or more SEND_DATA_FRAGMENT messages containing the actual data, and then when it
finishes or errors, the final SEND_DATA_FRAGMENT will have dataSuccess set.  If false, no error information is
provided since the failure occurred on the master side, and the agent shouldn't know anything about it.
SEND_DATA_FRAGMENT has (requestId, fragment [if any], dataSuccess [true if finished ok, false if failed]) populated

Message #3: Agent to Master
After receiving the final SEND_DATA_FRAGMENT, the agent responds to the master to tell if it has been successful
writing the file to the requested location, or returning an error if anything has gone wrong.
(requestId, exitCode [if receiving and finished], exitReason [if failed]) populated
 

SEND_DATA_FRAGMENT

public static final RemoteRun.MasterToAgent.MessageType SEND_DATA_FRAGMENT

SEND_DATA_FRAGMENT = 6;

(requestId, fragment [if any], dataSuccess [true if finished ok, false if failed]) populated

Message #1: Master to Agent
When the master wants to send the agent a file, it sends a SEND_DATA_NOTIFICATION to the agent.  This contains a
location on the agent that the master would like to use to store the sent file, and a request ID to correlate
related SEND_DATA_* type messages.
SEND_DATA_NOTIFICATION has (requestId, path) populated.

Message #2: Master to Agent
Subsequently, the master sends one or more SEND_DATA_FRAGMENT messages containing the actual data, and then when it
finishes or errors, the final SEND_DATA_FRAGMENT will have dataSuccess set.  If false, no error information is
provided since the failure occurred on the master side, and the agent shouldn't know anything about it.
SEND_DATA_FRAGMENT has (requestId, fragment [if any], dataSuccess [true if finished ok, false if failed]) populated

Message #3: Agent to Master
After receiving the final SEND_DATA_FRAGMENT, the agent responds to the master to tell if it has been successful
writing the file to the requested location, or returning an error if anything has gone wrong.
(requestId, exitCode [if receiving and finished], exitReason [if failed]) populated
 

Field Detail

RUN_COMMAND_VALUE

public static final int RUN_COMMAND_VALUE

RUN_COMMAND = 1;

(requestId, runCommand) populated

A request to run the given command on the agent.  The requestId is used to identify all future messages concerning
this particular process instance.
 

See Also:

Constant Field Values

STDIN_FRAGMENT_VALUE

public static final int STDIN_FRAGMENT_VALUE

STDIN_FRAGMENT = 2;

(requestId, fragment) populated

An additional fragment of stdin data that should be sent to the specified process running on the agent.  Will be
ignored by the agent if process is not running.
 

See Also:

Constant Field Values

CLOSE_STDIN_VALUE

public static final int CLOSE_STDIN_VALUE

CLOSE_STDIN = 3;

(requestId) populated

An instruction to close the stdin stream since no more data will be provided to the process.   It is not required to
close stdin.
 

See Also:

Constant Field Values

REQUEST_DATA_VALUE

public static final int REQUEST_DATA_VALUE

REQUEST_DATA = 4;

(requestId, path) populated

Message #1: Master to Agent
When the master wants a file from the agent, it sends a REQUEST_DATA stating which file or directory it wants.

Message #2+: Agent to Master
The agent responds with one or more REQUESTED_DATA messages including the requestId and fragment of data.  When the
file is either finished sending, or the agent encountered a problem that caused it to fail, the exitCode and
exitReason are populated where applicable.
 

See Also:

Constant Field Values

SEND_DATA_NOTIFICATION_VALUE

public static final int SEND_DATA_NOTIFICATION_VALUE

SEND_DATA_NOTIFICATION = 5;

(requestId, path) populated

Message #1: Master to Agent
When the master wants to send the agent a file, it sends a SEND_DATA_NOTIFICATION to the agent.  This contains a
location on the agent that the master would like to use to store the sent file, and a request ID to correlate
related SEND_DATA_* type messages.
SEND_DATA_NOTIFICATION has (requestId, path) populated.

Message #2: Master to Agent
Subsequently, the master sends one or more SEND_DATA_FRAGMENT messages containing the actual data, and then when it
finishes or errors, the final SEND_DATA_FRAGMENT will have dataSuccess set.  If false, no error information is
provided since the failure occurred on the master side, and the agent shouldn't know anything about it.
SEND_DATA_FRAGMENT has (requestId, fragment [if any], dataSuccess [true if finished ok, false if failed]) populated

Message #3: Agent to Master
After receiving the final SEND_DATA_FRAGMENT, the agent responds to the master to tell if it has been successful
writing the file to the requested location, or returning an error if anything has gone wrong.
(requestId, exitCode [if receiving and finished], exitReason [if failed]) populated
 

See Also:

Constant Field Values

SEND_DATA_FRAGMENT_VALUE

public static final int SEND_DATA_FRAGMENT_VALUE

SEND_DATA_FRAGMENT = 6;

(requestId, fragment [if any], dataSuccess [true if finished ok, false if failed]) populated

Message #1: Master to Agent
When the master wants to send the agent a file, it sends a SEND_DATA_NOTIFICATION to the agent.  This contains a
location on the agent that the master would like to use to store the sent file, and a request ID to correlate
related SEND_DATA_* type messages.
SEND_DATA_NOTIFICATION has (requestId, path) populated.

Message #2: Master to Agent
Subsequently, the master sends one or more SEND_DATA_FRAGMENT messages containing the actual data, and then when it
finishes or errors, the final SEND_DATA_FRAGMENT will have dataSuccess set.  If false, no error information is
provided since the failure occurred on the master side, and the agent shouldn't know anything about it.
SEND_DATA_FRAGMENT has (requestId, fragment [if any], dataSuccess [true if finished ok, false if failed]) populated

Message #3: Agent to Master
After receiving the final SEND_DATA_FRAGMENT, the agent responds to the master to tell if it has been successful
writing the file to the requested location, or returning an error if anything has gone wrong.
(requestId, exitCode [if receiving and finished], exitReason [if failed]) populated
 

See Also:

Constant Field Values

Method Detail

values

public static RemoteRun.MasterToAgent.MessageType[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (RemoteRun.MasterToAgent.MessageType c : RemoteRun.MasterToAgent.MessageType.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static RemoteRun.MasterToAgent.MessageType valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getNumber

public final int getNumber()

Specified by:

getNumber in interface com.google.protobuf.Internal.EnumLite

Specified by:

getNumber in interface com.google.protobuf.ProtocolMessageEnum

valueOf

public static RemoteRun.MasterToAgent.MessageType valueOf(int value)

internalGetValueMap

public static com.google.protobuf.Internal.EnumLiteMap<RemoteRun.MasterToAgent.MessageType> internalGetValueMap()

getValueDescriptor

public final com.google.protobuf.Descriptors.EnumValueDescriptor getValueDescriptor()

Specified by:

getValueDescriptor in interface com.google.protobuf.ProtocolMessageEnum

getDescriptorForType

public final com.google.protobuf.Descriptors.EnumDescriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface com.google.protobuf.ProtocolMessageEnum

getDescriptor

public static final com.google.protobuf.Descriptors.EnumDescriptor getDescriptor()

valueOf

public static RemoteRun.MasterToAgent.MessageType valueOf(com.google.protobuf.Descriptors.EnumValueDescriptor desc)