Package io.jawk.jrt

Class SandboxedJRT

java.lang.Object

io.jawk.jrt.JRT

io.jawk.jrt.SandboxedJRT

public class SandboxedJRT
extends JRT

Runtime component that raises AwkSandboxException when sandboxed code attempts operations that would escape the sandbox.

Constructor Summary

Constructors

Constructor	Description
SandboxedJRT(VariableManager vm, Locale locale, AwkSink awkSink, PrintStream error)	Creates a sandboxed runtime facade with explicit default output settings.

Method Summary

Modifier and Type	Method	Description
protected AwkSink	getFileAwkSink(String filename, boolean append)	Resolves the sink used by file redirection.
protected AwkSink	getPipeAwkSink(String cmd)	Resolves the sink used by pipe redirection.
boolean	jrtConsumeCommandInput(String cmd)	jrtConsumeCommandInput.
boolean	jrtConsumeFileInput(String filename)	jrtConsumeFileInput.
PrintStream	jrtGetPrintStream(String filename, boolean append)	Retrieve the PrintStream which writes to a particular file, creating the PrintStream if necessary.
PrintStream	jrtSpawnForOutput(String cmd)	Retrieve the PrintStream which shuttles data to stdin for a process, executing the process if necessary.
Integer	jrtSystem(String cmd)	Executes the command specified by cmd and waits for termination, returning an Integer object containing the return code.

Methods inherited from class io.jawk.jrt.JRT

advanceToNextFile, applyRS, applySpecialVariable, applySpecialVariables, assignEnvironmentVariables, assignInitialVariables, caseAwarePattern, compare2, compare2, consumeCurrentFileInput, consumeCurrentFileInputToTarget, consumeInput, consumeInputForEval, consumeInputToTarget, containsAwkKey, copySpecialVariables, createAwkMap, dec, dynamicPattern, getARGCVar, getARGIND, getAssocArrayValue, getAwkSink, getAwkStringEntry, getCONVFMTString, getCONVFMTVar, getERRNO, getFILENAME, getFNR, getFSString, getFSVar, getIGNORECASEVar, getInputLine, getLocale, getNF, getNR, getOFMTString, getOFSString, getOFSVar, getORSString, getORSVar, getOutputFiles, getPartitioningReader, getReplaceResult, getRLENGTH, getRSString, getRSTART, getRSVar, getSUBSEPString, getSUBSEPVar, hasInputFields, hasPendingInputFileError, inc, index, initializeInputFields, isActuallyLong, isGawkOnlySpecialVariable, isIgnoreCase, isJrtManagedSpecialVariable, isParseableNumber, jrtClose, jrtCloseAll, jrtConsumeCommandInputForGetline, jrtConsumeFileInputForGetline, jrtGetInputField, jrtGetInputField, jrtGetInputString, jrtParseFields, jrtSetInputField, jrtSetNF, matches, matchPosition, newRandom, parseFieldNumber, prepareForExecution, prepareReplacement, prepareReplacement, printDefault, printfDefault, printfNoCatch, printfNoCatch, printfToFile, printfToProcess, printToFile, printToProcess, printWarning, rebuildDollarZeroFromFields, regexpFlags, replaceAll, replaceFirst, setARGC, setARGIND, setAwkSink, setCONVFMT, setERRNO, setErrorStream, setFILENAMEViaJrt, setFNR, setFS, setIGNORECASE, setInputLine, setNF, setNR, setOFMT, setOFS, setORS, setRLENGTH, setRS, setRSTART, setSUBSEP, setWarningStream, split, split, splitTokenizer, sprintfNoCatch, substr, substr, timeSeed, toAwkString, toBoolean, toDouble, toInputScalar, toJavaScalar, toLong, untypedToBlank

Methods inherited from class java.lang.Object

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

Constructor Details

SandboxedJRT

public SandboxedJRT(VariableManager vm,
 Locale locale,
 AwkSink awkSink,
 PrintStream error)

Creates a sandboxed runtime facade with explicit default output settings.

Parameters:

vm - Variable manager used by the sandboxed runtime

locale - locale to use for runtime formatting

awkSink - default output sink

error - error stream for spawned-process stderr

Method Details

getFileAwkSink

protected AwkSink getFileAwkSink(String filename,
 boolean append)

Description copied from class: JRT

Resolves the sink used by file redirection.

Overrides:

getFileAwkSink in class JRT

Parameters:

filename - target file name

append - whether output should be appended

Returns:

the sink that writes to the requested file

getPipeAwkSink

protected AwkSink getPipeAwkSink(String cmd)

Description copied from class: JRT

Resolves the sink used by pipe redirection.

Overrides:

getPipeAwkSink in class JRT

Parameters:

cmd - command to execute

Returns:

the sink connected to the process stdin

jrtGetPrintStream

public PrintStream jrtGetPrintStream(String filename,
 boolean append)

Description copied from class: JRT

Retrieve the PrintStream which writes to a particular file, creating the PrintStream if necessary.

Overrides:

jrtGetPrintStream in class JRT

Parameters:

filename - The file which to write the contents of the PrintStream.

append - true to append to the file, false to overwrite the file.

Returns:

a PrintStream object

jrtSpawnForOutput

public PrintStream jrtSpawnForOutput(String cmd)

Description copied from class: JRT

Retrieve the PrintStream which shuttles data to stdin for a process, executing the process if necessary. Threads are created to shuttle the data to/from the process.

Overrides:

jrtSpawnForOutput in class JRT

Parameters:

cmd - The command to execute.

Returns:

The PrintStream which to write to provide input data to the process.

jrtConsumeFileInput

public boolean jrtConsumeFileInput(String filename)
                            throws IOException

Description copied from class: JRT

jrtConsumeFileInput.

Overrides:

jrtConsumeFileInput in class JRT

Parameters:

filename - a String object

Returns:

a boolean

Throws:

IOException - if any.

jrtConsumeCommandInput

public boolean jrtConsumeCommandInput(String cmd)
                               throws IOException

Description copied from class: JRT

jrtConsumeCommandInput.

Overrides:

jrtConsumeCommandInput in class JRT

Parameters:

cmd - a String object

Returns:

a boolean

Throws:

IOException - if any.

jrtSystem

public Integer jrtSystem(String cmd)

Description copied from class: JRT

Executes the command specified by cmd and waits for termination, returning an Integer object containing the return code. stdin to this process is closed while threads are created to shuttle stdout and stderr of the command to stdout/stderr of the calling process.

Overrides:

jrtSystem in class JRT

Parameters:

cmd - The command to execute.

Returns:

Integer(return_code) of the created process. Integer(-1) is returned on an IO error.