net.formicary.remoterun.common.proto

Enum RemoteRun.AgentToMaster.MessageType

java.lang.Object

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

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

All Implemented Interfaces:

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

Enclosing class:

RemoteRun.AgentToMaster

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

Protobuf enum AgentToMaster.MessageType

Enum Constant Summary

Enum Constants

Enum Constant and Description
AGENT_INFO AGENT_INFO = 7;
EXITED EXITED = 4;
RECEIVED_DATA RECEIVED_DATA = 6;
REQUESTED_DATA REQUESTED_DATA = 5;
STARTED STARTED = 1;
STDERR_FRAGMENT STDERR_FRAGMENT = 3;
STDOUT_FRAGMENT STDOUT_FRAGMENT = 2;

Field Summary

Fields

Modifier and Type	Field and Description
static int	AGENT_INFO_VALUE AGENT_INFO = 7;
static int	EXITED_VALUE EXITED = 4;
static int	RECEIVED_DATA_VALUE RECEIVED_DATA = 6;
static int	REQUESTED_DATA_VALUE REQUESTED_DATA = 5;
static int	STARTED_VALUE STARTED = 1;
static int	STDERR_FRAGMENT_VALUE STDERR_FRAGMENT = 3;
static int	STDOUT_FRAGMENT_VALUE STDOUT_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.AgentToMaster.MessageType>	internalGetValueMap()
static RemoteRun.AgentToMaster.MessageType	valueOf(com.google.protobuf.Descriptors.EnumValueDescriptor desc)
static RemoteRun.AgentToMaster.MessageType	valueOf(int value)
static RemoteRun.AgentToMaster.MessageType	valueOf(String name) Returns the enum constant of this type with the specified name.
static RemoteRun.AgentToMaster.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

STARTED

public static final RemoteRun.AgentToMaster.MessageType STARTED

STARTED = 1;

(requestId) populated

When the agent starts a process, it informs the master that the process has been started successfully.
 

STDOUT_FRAGMENT

public static final RemoteRun.AgentToMaster.MessageType STDOUT_FRAGMENT

STDOUT_FRAGMENT = 2;

(requestId, fragment) populated

Some data has been output by the process on the stdout stream, relay it to the master.
 

STDERR_FRAGMENT

public static final RemoteRun.AgentToMaster.MessageType STDERR_FRAGMENT

STDERR_FRAGMENT = 3;

(requestId, fragment) populated

Some data has been output by the process on the stderr stream, relay it to the master.
 

EXITED

public static final RemoteRun.AgentToMaster.MessageType EXITED

EXITED = 4;

(requestId, exitCode, exitReason [if failed]) populated

A process has finished, this message notifies the master of the conditions under which it terminated.  A non-zero
exit code indicates failure, and the exitReason is supplied if there was an error whilst running the process or
reading from its streams, etc.
 

REQUESTED_DATA

public static final RemoteRun.AgentToMaster.MessageType REQUESTED_DATA

REQUESTED_DATA = 5;

(requestId, fragment, exitCode [if uploading and finished], exitReason [if failed]) 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.
 

RECEIVED_DATA

public static final RemoteRun.AgentToMaster.MessageType RECEIVED_DATA

RECEIVED_DATA = 6;

(requestId, exitCode [if receiving and finished], exitReason [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
 

AGENT_INFO

public static final RemoteRun.AgentToMaster.MessageType AGENT_INFO

AGENT_INFO = 7;

(agentInfo) populated

Message #1: Agent to Master
AGENT_INFO sent on successful connection by an agent - includes data about the agent that the master can use to
allow selection of different agents, deduction of paths, etc.
 

Field Detail

STARTED_VALUE

public static final int STARTED_VALUE

STARTED = 1;

(requestId) populated

When the agent starts a process, it informs the master that the process has been started successfully.
 

See Also:

Constant Field Values

STDOUT_FRAGMENT_VALUE

public static final int STDOUT_FRAGMENT_VALUE

STDOUT_FRAGMENT = 2;

(requestId, fragment) populated

Some data has been output by the process on the stdout stream, relay it to the master.
 

See Also:

Constant Field Values

STDERR_FRAGMENT_VALUE

public static final int STDERR_FRAGMENT_VALUE

STDERR_FRAGMENT = 3;

(requestId, fragment) populated

Some data has been output by the process on the stderr stream, relay it to the master.
 

See Also:

Constant Field Values

EXITED_VALUE

public static final int EXITED_VALUE

EXITED = 4;

(requestId, exitCode, exitReason [if failed]) populated

A process has finished, this message notifies the master of the conditions under which it terminated.  A non-zero
exit code indicates failure, and the exitReason is supplied if there was an error whilst running the process or
reading from its streams, etc.
 

See Also:

Constant Field Values

REQUESTED_DATA_VALUE

public static final int REQUESTED_DATA_VALUE

REQUESTED_DATA = 5;

(requestId, fragment, exitCode [if uploading and finished], exitReason [if failed]) 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

RECEIVED_DATA_VALUE

public static final int RECEIVED_DATA_VALUE

RECEIVED_DATA = 6;

(requestId, exitCode [if receiving and finished], exitReason [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

AGENT_INFO_VALUE

public static final int AGENT_INFO_VALUE

AGENT_INFO = 7;

(agentInfo) populated

Message #1: Agent to Master
AGENT_INFO sent on successful connection by an agent - includes data about the agent that the master can use to
allow selection of different agents, deduction of paths, etc.
 

See Also:

Constant Field Values

Method Detail

values

public static RemoteRun.AgentToMaster.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.AgentToMaster.MessageType c : RemoteRun.AgentToMaster.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.AgentToMaster.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.AgentToMaster.MessageType valueOf(int value)

internalGetValueMap

public static com.google.protobuf.Internal.EnumLiteMap<RemoteRun.AgentToMaster.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.AgentToMaster.MessageType valueOf(com.google.protobuf.Descriptors.EnumValueDescriptor desc)