net.formicary.remoterun.embed.request

Class TextOutputRequest

java.lang.Object

net.formicary.remoterun.embed.request.TextOutputRequest

All Implemented Interfaces:

AgentRequest

public class TextOutputRequest
extends Object
implements AgentRequest

Convenience class to wrap a command that expects text output. Override onStdOut and onStdErr to capture each line as it's received.

Author:

Chris Pearson

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_MAX_LINE_LENGTH

Constructor Summary

Constructors

Constructor and Description
TextOutputRequest(RemoteRun.MasterToAgent.Builder requestBuilder, int maxLineLength, Charset charset, TextOutputCallback callback)
TextOutputRequest(RemoteRun.MasterToAgent.Builder requestBuilder, int maxLineLength, TextOutputCallback callback) Same as new TextOutputRequest(requestBuilder, maxLineLength, UTF_8).
TextOutputRequest(RemoteRun.MasterToAgent.Builder requestBuilder, TextOutputCallback callback) Same as new TextOutputRequest(requestBuilder, 4096, UTF_8).

Method Summary

Methods

Modifier and Type	Method and Description
CountDownLatch	getCompletionLatch()
RemoteRun.MasterToAgent	getMessage()
RemoteRun.MasterToAgent	getRequest()
void	receivedMessage(AgentConnection agent, RemoteRun.AgentToMaster message)

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_MAX_LINE_LENGTH

public static final int DEFAULT_MAX_LINE_LENGTH

See Also:

Constant Field Values

Constructor Detail

TextOutputRequest

public TextOutputRequest(RemoteRun.MasterToAgent.Builder requestBuilder,
                 TextOutputCallback callback)

Same as new TextOutputRequest(requestBuilder, 4096, UTF_8).

Parameters:

requestBuilder - builder for the run command

TextOutputRequest

public TextOutputRequest(RemoteRun.MasterToAgent.Builder requestBuilder,
                 int maxLineLength,
                 TextOutputCallback callback)

Same as new TextOutputRequest(requestBuilder, maxLineLength, UTF_8).

Parameters:

requestBuilder - builder for the run command

maxLineLength - max number of characters that can form a line of output

TextOutputRequest

public TextOutputRequest(RemoteRun.MasterToAgent.Builder requestBuilder,
                 int maxLineLength,
                 Charset charset,
                 TextOutputCallback callback)

Method Detail

getMessage

public RemoteRun.MasterToAgent getMessage()

Specified by:

getMessage in interface AgentRequest

getRequest

public RemoteRun.MasterToAgent getRequest()

getCompletionLatch

public CountDownLatch getCompletionLatch()

Specified by:

getCompletionLatch in interface AgentRequest

receivedMessage

public final void receivedMessage(AgentConnection agent,
                   RemoteRun.AgentToMaster message)

Specified by:

receivedMessage in interface AgentRequest