io.warp10.script

Interface WarpScriptStack

All Known Implementing Classes:

MemoryWarpScriptStack

public interface WarpScriptStack

The WarpScript Geo Time Serie manipulation environment usually uses a stack to operate. There may be multiple implementations of stacks that WarpScript can use, including some that persist to a cache or that may spill to disk. All those implementations MUST implement this interface.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	WarpScriptStack.Macro
static class	WarpScriptStack.Mark
static class	WarpScriptStack.Signal Signals that can be sent to a stack The higher the ordinal of a signal, the higher its priority
static class	WarpScriptStack.StackContext

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ATTRIBUTE_ALLOW_REDEFINED Flag indicating whether or not redefined functions are allowed
static java.lang.String	ATTRIBUTE_CREATION_TIME Creation timestamp for the stack
static java.lang.String	ATTRIBUTE_DEBUG_DEPTH Debug depth of the stack.
static java.lang.String	ATTRIBUTE_ELAPSED List of elapsed times (in ns) per line
static java.lang.String	ATTRIBUTE_EXPORTED_SYMBOLS List of symbols to export upon script termination as a map of symbol name to symbol value pushed onto the stack.
static java.lang.String	ATTRIBUTE_FETCH_COUNT Number of datapoints fetched so far in the session
static java.lang.String	ATTRIBUTE_FETCH_LIMIT Maximum number of datapoints that can be fetched in a session
static java.lang.String	ATTRIBUTE_FETCH_LIMIT_HARD
static java.lang.String	ATTRIBUTE_GTS_COUNT Number of GTS retrieved so far in the session
static java.lang.String	ATTRIBUTE_GTS_LIMIT Maximum number of GTS which can be retrieved from directory in a session
static java.lang.String	ATTRIBUTE_GTS_LIMIT_HARD
static java.lang.String	ATTRIBUTE_HADOOP_PROGRESSABLE Key for storing an instance of Hadoop's Progressable to report progress to the Hadoop framework
static java.lang.String	ATTRIBUTE_HEADERS Map of headers to return with the response
static java.lang.String	ATTRIBUTE_IMPORT_RULES Name of attribute for storing macro import rules
static java.lang.String	ATTRIBUTE_IN_SECURE_MACRO Flag indicating if we are currently in a secure macro execution
static java.lang.String	ATTRIBUTE_IN_XEVAL Flag indicating if we are currently executing an XEVAL call, in which case generated macros should not be flagged secure.
static java.lang.String	ATTRIBUTE_INFOMODE Flag indicating whether or not the stack is currently in info mode
static java.lang.String	ATTRIBUTE_INTERACTIVE_ECHO Should the interactive mode display the top of the stack after each command?
static java.lang.String	ATTRIBUTE_INTERACTIVE_JSON Should the REL display the stack levels as JSON?
static java.lang.String	ATTRIBUTE_INTERACTIVE_TIME Flag indicating whether or not to display timing information after each command.
static java.lang.String	ATTRIBUTE_INTERACTIVE_WRITER PrintWriter instance for the REL (Read Execute Loop)
static java.lang.String	ATTRIBUTE_JSON_MAXSIZE Maximum size of a JSON created and pushed on the stack, in number of characters.
static java.lang.String	ATTRIBUTE_JSON_MAXSIZE_HARD
static java.lang.String	ATTRIBUTE_JSON_PRETTY Is the stack configured to output pretty JSON (i.e with ident)?
static java.lang.String	ATTRIBUTE_JSON_STRICT Is the stack configured to output strict JSON (i.e with no NaN/Infinity)?
static java.lang.String	ATTRIBUTE_LAST_ERROR Last error encountered in a TRY block
static java.lang.String	ATTRIBUTE_LINENO Flag indicating whether or not to set section with the current line number
static java.lang.String	ATTRIBUTE_LOOP_MAXDURATION Maximum duration of loops in ms and its hard limit
static java.lang.String	ATTRIBUTE_LOOP_MAXDURATION_HARD
static java.lang.String	ATTRIBUTE_MACRO_NAME Name of the current macro, or null if not in a macro or in an anonymous one
static java.lang.String	ATTRIBUTE_MACRO_TTL TTL (in ms since the epoch) of a macro
static java.lang.String	ATTRIBUTE_MAX_BUCKETS Maximum number of buckets in bucketized GTS
static java.lang.String	ATTRIBUTE_MAX_BUCKETS_HARD
static java.lang.String	ATTRIBUTE_MAX_DEPTH Maximum depth of the stack
static java.lang.String	ATTRIBUTE_MAX_DEPTH_HARD
static java.lang.String	ATTRIBUTE_MAX_GEOCELLS Maximum number of cells if GeoXPShapes
static java.lang.String	ATTRIBUTE_MAX_GEOCELLS_HARD
static java.lang.String	ATTRIBUTE_MAX_OPS Maximum number of operations for the stack
static java.lang.String	ATTRIBUTE_MAX_OPS_HARD
static java.lang.String	ATTRIBUTE_MAX_PIXELS Maximum number of pixels for images created on the stack
static java.lang.String	ATTRIBUTE_MAX_PIXELS_HARD
static java.lang.String	ATTRIBUTE_MAX_SYMBOLS Maximum number of symbols for the stack
static java.lang.String	ATTRIBUTE_MAX_SYMBOLS_HARD
static java.lang.String	ATTRIBUTE_NAME Name given to the stack
static java.lang.String	ATTRIBUTE_OPS Current number of operations performed on this stack
static java.lang.String	ATTRIBUTE_PARSING_ERRORS List of parsing errors or unknown function errors generated in WarpScript audit mode.
static java.lang.String	ATTRIBUTE_RECURSION_MAXDEPTH Maximum recursion depth
static java.lang.String	ATTRIBUTE_RECURSION_MAXDEPTH_HARD
static java.lang.String	ATTRIBUTE_RUNNER_RESCHEDULE_PERIOD Stack attribute for runner rescheduling period in millisecond
static java.lang.String	ATTRIBUTE_RUNNER_RESCHEDULE_TIMESTAMP Stack attribute for runner rescheduling absolute timestamp in millisecond
static java.lang.String	ATTRIBUTE_SECTION_NAME Name of current code section, null is unnamed
static java.lang.String	ATTRIBUTE_SECURE_KEY Key for securing scripts
static java.lang.String	ATTRIBUTE_TIMEBOXED Stack attribute used to indicate the execution is currently timeboxed
static java.lang.String	ATTRIBUTE_TIMINGS Flag indicating whether or not to track elapsed times per script line
static java.lang.String	CAPABILITIES_ATTR
static java.lang.String	CAPABILITIES_PREFIX
static java.lang.String	CAPABILITY_DEBUG
static java.lang.String	CAPABILITY_HTTP
static java.lang.String	CAPABILITY_INVENTORY
static java.lang.String	CAPABILITY_LEVELDB
static java.lang.String	CAPABILITY_LEVELDB_ADMIN
static java.lang.String	CAPABILITY_LEVELDB_CLOSE
static java.lang.String	CAPABILITY_LEVELDB_COMPACT
static java.lang.String	CAPABILITY_LEVELDB_FIND
static java.lang.String	CAPABILITY_LEVELDB_INFO
static java.lang.String	CAPABILITY_LEVELDB_OPEN
static java.lang.String	CAPABILITY_LEVELDB_PURGE
static java.lang.String	CAPABILITY_LEVELDB_REPAIR
static java.lang.String	CAPABILITY_LEVELDB_REPORT
static java.lang.String	CAPABILITY_LEVELDB_SNAPSHOT
static java.lang.String	CAPABILITY_LEVELDB_TIMESTAMP
static java.lang.String	CAPABILITY_LIMIT
static java.lang.String	CAPABILITY_LIMITS
static java.lang.String	CAPABILITY_MANAGER
static java.lang.String	CAPABILITY_MAXBUCKETS
static java.lang.String	CAPABILITY_MAXDEPTH
static java.lang.String	CAPABILITY_MAXGEOCELLS
static java.lang.String	CAPABILITY_MAXGTS
static java.lang.String	CAPABILITY_MAXJSON
static java.lang.String	CAPABILITY_MAXLOOP
static java.lang.String	CAPABILITY_MAXOPS
static java.lang.String	CAPABILITY_MAXPIXELS
static java.lang.String	CAPABILITY_MAXRECURSION
static java.lang.String	CAPABILITY_MAXSYMBOLS
static java.lang.String	CAPABILITY_REPORT
static java.lang.String	CAPABILITY_SETMACROCONFIG
static java.lang.String	CAPABILITY_SLEEP_MAXTIME
static java.lang.String	CAPABILITY_TIMEBOX_MAXTIME
static java.lang.String	CAPABILITY_WFGET
static java.lang.String	CAPABILITY_WFSET
static java.lang.String	CAPNAME_RUNNER_RESCHEDULE_MIN_PERIOD Cap name for runner rescheduling minimum period in millisecond
static java.lang.String	COMMENT_END
static java.lang.String	COMMENT_START
static int	COUNTER_RETURN_DEPTH Index of RETURN_DEPTH counter
static long	DEFAULT_FETCH_LIMIT
static long	DEFAULT_GTS_LIMIT
static int	DEFAULT_MAX_BUCKETS
static int	DEFAULT_MAX_DEPTH
static int	DEFAULT_MAX_GEOCELLS
static long	DEFAULT_MAX_JSON
static long	DEFAULT_MAX_LOOP_DURATION
static long	DEFAULT_MAX_OPS
static long	DEFAULT_MAX_PIXELS
static int	DEFAULT_MAX_RECURSION_LEVEL
static int	DEFAULT_MAX_SYMBOLS
static long	DEFAULT_REGISTERS
static java.lang.String	MACRO_END
static java.lang.String	MACRO_START
static java.lang.String	MULTILINE_END
static java.lang.String	MULTILINE_START
static java.lang.String	SECURE_SCRIPT_END
static java.lang.String	SECURE_SCRIPT_START
static java.lang.String	TOP_LEVEL_SECTION

Method Summary

Modifier and Type	Method and Description
void	auditMode(boolean auditMode) Turn on/off auditMode.
void	checkBalanced() Perform a final check to ensure balancing constructs are balanced.
void	clear() Empty the stack
void	define(java.lang.String stmt, WarpScriptStack.Macro macro) (re)define 'stmt' as a valid statement executing 'macro' This allows for the overriding of built-in statements
int	depth() Return the depth (i.e.
void	drop() Remove the top of the stack.
void	dropn() Remove the top 'N' objects of the stack.
java.lang.String	dump(int n) Produces a String representation of the top 'n' levels of the stack
void	dup() Duplicate the object on top of the stack.
void	dupn() Duplicate the top 'N' objects of the stack.
void	exec(java.lang.String line) Execute a serie of statements against the stack.
void	exec(java.lang.String line, long lineNumber) Execute a series of statements against the stack.
void	exec(WarpScriptStack.Macro macro) Execute a macro against the stack.
void	execMulti(java.lang.String script)
WarpScriptStack.Macro	find(java.lang.String macroName) Find a macro by name
java.lang.Object	findFunction(java.lang.String macroName) Find a function by name
void	forget(java.lang.String symbol) Forget the given symbol
java.lang.Object	get(int level) Return the object at level 'level' on the stack.
java.lang.Object	getAttribute(java.lang.String key) Return the value of an attribute.
java.util.concurrent.atomic.AtomicLong	getCounter(int i) Return the ith counter associated with the stack
java.util.Map<java.lang.String,WarpScriptStackFunction>	getDefined() Return the current map of redefined functions
DirectoryClient	getDirectoryClient() Retrieve the DirectoryClient instance associated with this stack
java.lang.Object[]	getRegisters() Return the current registers.
StoreClient	getStoreClient() Retrieve the StoreClient instance associated with this stack.
java.util.Map<java.lang.String,java.lang.Object>	getSymbolTable() Return the current symbol table.
java.lang.String	getUUID() Return a UUID for the instance of WarpScriptStack
void	handleSignal() Throw the exception associated with the current signal sent to the stack
int	hide() Hide all stack levels
int	hide(int count) Hide the deepest 'count' stack levels
java.lang.Object	load(int regidx) Return the content associated with the given register
java.lang.Object	load(java.lang.String symbol) Return the content associated with the given symbol.
void	macroClose() Closes the currently open macro (after macroOpen was called) and push it onto the stack.
void	macroOpen() Force the stack to create a macro with all following statements.
java.lang.Object	peek() Return the object on top of the stack without removing it from the stack.
java.lang.Object	peekn() Return the object at 'distance' from the top of the stack.
void	pick() Copy the object at level 'N' on top of the stack.
java.lang.Object	pop() Remove and return the object on top of the stack.
java.lang.Object[]	popn() Remove and return 'N' objects from the top of the stack.
java.lang.Object[]	popn(int n) Remove and return 'N' objects from the top of the stack.
void	push(java.lang.Object o) Push an object onto the stack
void	reset(int depth) Reset the stack to the given depth
void	restore() Restore the stack context from that on top of the stack
void	restore(WarpScriptStack.StackContext context) Restore the given stack context
void	roll() Rotate up the top 'N' objects of the stack.
void	rolld() Rotate down the top 'N' objects of the stack.
void	rot() Rotate the top 3 objects of the stack, pushing the top of the stack down D D C -> B B A A (top) C (top)
void	run(java.lang.String macroName) Execute a macro known by name.
void	save() Push the current stack context (symbols + redefined statements) onto the stack.
java.lang.Object	setAttribute(java.lang.String key, java.lang.Object value) Set a stack attribute.
void	show() Show all previously hidden stack levels.
void	show(int count) Show some stack levels previously hidden.
void	signal(WarpScriptStack.Signal signal) Signal the stack, i.e.
void	store(int regidx, java.lang.Object value) Stores the given value in register 'regidx'
void	store(java.lang.String symbol, java.lang.Object value) Store the given object under 'symbol'.
void	swap() Swap the top 2 objects of the stack.

Field Detail

DEFAULT_MAX_RECURSION_LEVEL

static final int DEFAULT_MAX_RECURSION_LEVEL

See Also:

Constant Field Values

DEFAULT_FETCH_LIMIT

static final long DEFAULT_FETCH_LIMIT

See Also:

Constant Field Values

DEFAULT_GTS_LIMIT

static final long DEFAULT_GTS_LIMIT

See Also:

Constant Field Values

DEFAULT_MAX_OPS

static final long DEFAULT_MAX_OPS

See Also:

Constant Field Values

DEFAULT_MAX_BUCKETS

static final int DEFAULT_MAX_BUCKETS

See Also:

Constant Field Values

DEFAULT_MAX_GEOCELLS

static final int DEFAULT_MAX_GEOCELLS

See Also:

Constant Field Values

DEFAULT_MAX_DEPTH

static final int DEFAULT_MAX_DEPTH

See Also:

Constant Field Values

DEFAULT_MAX_LOOP_DURATION

static final long DEFAULT_MAX_LOOP_DURATION

See Also:

Constant Field Values

DEFAULT_MAX_SYMBOLS

static final int DEFAULT_MAX_SYMBOLS

See Also:

Constant Field Values

DEFAULT_MAX_PIXELS

static final long DEFAULT_MAX_PIXELS

See Also:

Constant Field Values

DEFAULT_MAX_JSON

static final long DEFAULT_MAX_JSON

See Also:

Constant Field Values

DEFAULT_REGISTERS

static final long DEFAULT_REGISTERS

See Also:

Constant Field Values

MACRO_START

static final java.lang.String MACRO_START

See Also:

Constant Field Values

MACRO_END

static final java.lang.String MACRO_END

See Also:

Constant Field Values

COMMENT_START

static final java.lang.String COMMENT_START

See Also:

Constant Field Values

COMMENT_END

static final java.lang.String COMMENT_END

See Also:

Constant Field Values

MULTILINE_START

static final java.lang.String MULTILINE_START

See Also:

Constant Field Values

MULTILINE_END

static final java.lang.String MULTILINE_END

See Also:

Constant Field Values

SECURE_SCRIPT_START

static final java.lang.String SECURE_SCRIPT_START

See Also:

Constant Field Values

SECURE_SCRIPT_END

static final java.lang.String SECURE_SCRIPT_END

See Also:

Constant Field Values

TOP_LEVEL_SECTION

static final java.lang.String TOP_LEVEL_SECTION

See Also:

Constant Field Values

ATTRIBUTE_IMPORT_RULES

static final java.lang.String ATTRIBUTE_IMPORT_RULES

Name of attribute for storing macro import rules

See Also:

Constant Field Values

ATTRIBUTE_LINENO

static final java.lang.String ATTRIBUTE_LINENO

Flag indicating whether or not to set section with the current line number

See Also:

Constant Field Values

ATTRIBUTE_INTERACTIVE_WRITER

static final java.lang.String ATTRIBUTE_INTERACTIVE_WRITER

PrintWriter instance for the REL (Read Execute Loop)

See Also:

Constant Field Values

ATTRIBUTE_INTERACTIVE_JSON

static final java.lang.String ATTRIBUTE_INTERACTIVE_JSON

Should the REL display the stack levels as JSON?

See Also:

Constant Field Values

ATTRIBUTE_INTERACTIVE_ECHO

static final java.lang.String ATTRIBUTE_INTERACTIVE_ECHO

Should the interactive mode display the top of the stack after each command?

See Also:

Constant Field Values

ATTRIBUTE_INTERACTIVE_TIME

static final java.lang.String ATTRIBUTE_INTERACTIVE_TIME

Flag indicating whether or not to display timing information after each command.

See Also:

Constant Field Values

ATTRIBUTE_SECTION_NAME

static final java.lang.String ATTRIBUTE_SECTION_NAME

Name of current code section, null is unnamed

See Also:

Constant Field Values

ATTRIBUTE_MACRO_NAME

static final java.lang.String ATTRIBUTE_MACRO_NAME

Name of the current macro, or null if not in a macro or in an anonymous one

See Also:

Constant Field Values

ATTRIBUTE_INFOMODE

static final java.lang.String ATTRIBUTE_INFOMODE

Flag indicating whether or not the stack is currently in info mode

See Also:

Constant Field Values

ATTRIBUTE_PARSING_ERRORS

static final java.lang.String ATTRIBUTE_PARSING_ERRORS

List of parsing errors or unknown function errors generated in WarpScript audit mode. These errors are stored as WarpScriptAuditStatement with UNKNOWN or WS_EXCEPTION type.

See Also:

Constant Field Values

ATTRIBUTE_DEBUG_DEPTH

static final java.lang.String ATTRIBUTE_DEBUG_DEPTH

Debug depth of the stack. This is the number of elements to return when an error occurs.

See Also:

Constant Field Values

ATTRIBUTE_JSON_STRICT

static final java.lang.String ATTRIBUTE_JSON_STRICT

Is the stack configured to output strict JSON (i.e with no NaN/Infinity)?

See Also:

Constant Field Values

ATTRIBUTE_JSON_PRETTY

static final java.lang.String ATTRIBUTE_JSON_PRETTY

Is the stack configured to output pretty JSON (i.e with ident)?

See Also:

Constant Field Values

ATTRIBUTE_JSON_MAXSIZE

static final java.lang.String ATTRIBUTE_JSON_MAXSIZE

Maximum size of a JSON created and pushed on the stack, in number of characters.

See Also:

Constant Field Values

ATTRIBUTE_JSON_MAXSIZE_HARD

static final java.lang.String ATTRIBUTE_JSON_MAXSIZE_HARD

See Also:

Constant Field Values

ATTRIBUTE_FETCH_LIMIT

static final java.lang.String ATTRIBUTE_FETCH_LIMIT

Maximum number of datapoints that can be fetched in a session

See Also:

Constant Field Values

ATTRIBUTE_FETCH_LIMIT_HARD

static final java.lang.String ATTRIBUTE_FETCH_LIMIT_HARD

See Also:

Constant Field Values

ATTRIBUTE_GTS_LIMIT

static final java.lang.String ATTRIBUTE_GTS_LIMIT

Maximum number of GTS which can be retrieved from directory in a session

See Also:

Constant Field Values

ATTRIBUTE_GTS_LIMIT_HARD

static final java.lang.String ATTRIBUTE_GTS_LIMIT_HARD

See Also:

Constant Field Values

ATTRIBUTE_FETCH_COUNT

static final java.lang.String ATTRIBUTE_FETCH_COUNT

Number of datapoints fetched so far in the session

See Also:

Constant Field Values

ATTRIBUTE_GTS_COUNT

static final java.lang.String ATTRIBUTE_GTS_COUNT

Number of GTS retrieved so far in the session

See Also:

Constant Field Values

ATTRIBUTE_ELAPSED

static final java.lang.String ATTRIBUTE_ELAPSED

List of elapsed times (in ns) per line

See Also:

Constant Field Values

ATTRIBUTE_TIMINGS

static final java.lang.String ATTRIBUTE_TIMINGS

Flag indicating whether or not to track elapsed times per script line

See Also:

Constant Field Values

ATTRIBUTE_LOOP_MAXDURATION

static final java.lang.String ATTRIBUTE_LOOP_MAXDURATION

Maximum duration of loops in ms and its hard limit

See Also:

Constant Field Values

ATTRIBUTE_LOOP_MAXDURATION_HARD

static final java.lang.String ATTRIBUTE_LOOP_MAXDURATION_HARD

See Also:

Constant Field Values

ATTRIBUTE_RECURSION_MAXDEPTH

static final java.lang.String ATTRIBUTE_RECURSION_MAXDEPTH

Maximum recursion depth

See Also:

Constant Field Values

ATTRIBUTE_RECURSION_MAXDEPTH_HARD

static final java.lang.String ATTRIBUTE_RECURSION_MAXDEPTH_HARD

See Also:

Constant Field Values

ATTRIBUTE_MAX_DEPTH

static final java.lang.String ATTRIBUTE_MAX_DEPTH

Maximum depth of the stack

See Also:

Constant Field Values

ATTRIBUTE_MAX_DEPTH_HARD

static final java.lang.String ATTRIBUTE_MAX_DEPTH_HARD

See Also:

Constant Field Values

ATTRIBUTE_MAX_OPS

static final java.lang.String ATTRIBUTE_MAX_OPS

Maximum number of operations for the stack

See Also:

Constant Field Values

ATTRIBUTE_MAX_OPS_HARD

static final java.lang.String ATTRIBUTE_MAX_OPS_HARD

See Also:

Constant Field Values

ATTRIBUTE_MAX_PIXELS

static final java.lang.String ATTRIBUTE_MAX_PIXELS

Maximum number of pixels for images created on the stack

See Also:

Constant Field Values

ATTRIBUTE_MAX_PIXELS_HARD

static final java.lang.String ATTRIBUTE_MAX_PIXELS_HARD

See Also:

Constant Field Values

ATTRIBUTE_MAX_BUCKETS

static final java.lang.String ATTRIBUTE_MAX_BUCKETS

Maximum number of buckets in bucketized GTS

See Also:

Constant Field Values

ATTRIBUTE_MAX_BUCKETS_HARD

static final java.lang.String ATTRIBUTE_MAX_BUCKETS_HARD

See Also:

Constant Field Values

ATTRIBUTE_MAX_GEOCELLS

static final java.lang.String ATTRIBUTE_MAX_GEOCELLS

Maximum number of cells if GeoXPShapes

See Also:

Constant Field Values

ATTRIBUTE_MAX_GEOCELLS_HARD

static final java.lang.String ATTRIBUTE_MAX_GEOCELLS_HARD

See Also:

Constant Field Values

ATTRIBUTE_OPS

static final java.lang.String ATTRIBUTE_OPS

Current number of operations performed on this stack

See Also:

Constant Field Values

ATTRIBUTE_MAX_SYMBOLS

static final java.lang.String ATTRIBUTE_MAX_SYMBOLS

Maximum number of symbols for the stack

See Also:

Constant Field Values

ATTRIBUTE_MAX_SYMBOLS_HARD

static final java.lang.String ATTRIBUTE_MAX_SYMBOLS_HARD

See Also:

Constant Field Values

ATTRIBUTE_SECURE_KEY

static final java.lang.String ATTRIBUTE_SECURE_KEY

Key for securing scripts

See Also:

Constant Field Values

ATTRIBUTE_ALLOW_REDEFINED

static final java.lang.String ATTRIBUTE_ALLOW_REDEFINED

Flag indicating whether or not redefined functions are allowed

See Also:

Constant Field Values

ATTRIBUTE_HADOOP_PROGRESSABLE

static final java.lang.String ATTRIBUTE_HADOOP_PROGRESSABLE

Key for storing an instance of Hadoop's Progressable to report progress to the Hadoop framework

See Also:

Constant Field Values

ATTRIBUTE_IN_XEVAL

static final java.lang.String ATTRIBUTE_IN_XEVAL

Flag indicating if we are currently executing an XEVAL call, in which case generated macros should not be flagged secure.

See Also:

Constant Field Values

ATTRIBUTE_IN_SECURE_MACRO

static final java.lang.String ATTRIBUTE_IN_SECURE_MACRO

Flag indicating if we are currently in a secure macro execution

See Also:

Constant Field Values

ATTRIBUTE_MACRO_TTL

static final java.lang.String ATTRIBUTE_MACRO_TTL

TTL (in ms since the epoch) of a macro

See Also:

Constant Field Values

ATTRIBUTE_EXPORTED_SYMBOLS

static final java.lang.String ATTRIBUTE_EXPORTED_SYMBOLS

List of symbols to export upon script termination as a map of symbol name to symbol value pushed onto the stack.

See Also:

Constant Field Values

ATTRIBUTE_HEADERS

static final java.lang.String ATTRIBUTE_HEADERS

Map of headers to return with the response

See Also:

Constant Field Values

ATTRIBUTE_LAST_ERROR

static final java.lang.String ATTRIBUTE_LAST_ERROR

Last error encountered in a TRY block

See Also:

Constant Field Values

ATTRIBUTE_CREATION_TIME

static final java.lang.String ATTRIBUTE_CREATION_TIME

Creation timestamp for the stack

See Also:

Constant Field Values

ATTRIBUTE_NAME

static final java.lang.String ATTRIBUTE_NAME

Name given to the stack

See Also:

Constant Field Values

ATTRIBUTE_TIMEBOXED

static final java.lang.String ATTRIBUTE_TIMEBOXED

Stack attribute used to indicate the execution is currently timeboxed

See Also:

Constant Field Values

CAPNAME_RUNNER_RESCHEDULE_MIN_PERIOD

static final java.lang.String CAPNAME_RUNNER_RESCHEDULE_MIN_PERIOD

Cap name for runner rescheduling minimum period in millisecond

See Also:

Constant Field Values

ATTRIBUTE_RUNNER_RESCHEDULE_PERIOD

static final java.lang.String ATTRIBUTE_RUNNER_RESCHEDULE_PERIOD

Stack attribute for runner rescheduling period in millisecond

See Also:

Constant Field Values

ATTRIBUTE_RUNNER_RESCHEDULE_TIMESTAMP

static final java.lang.String ATTRIBUTE_RUNNER_RESCHEDULE_TIMESTAMP

Stack attribute for runner rescheduling absolute timestamp in millisecond

See Also:

Constant Field Values

COUNTER_RETURN_DEPTH

static final int COUNTER_RETURN_DEPTH

Index of RETURN_DEPTH counter

See Also:

Constant Field Values

CAPABILITIES_PREFIX

static final java.lang.String CAPABILITIES_PREFIX

See Also:

Constant Field Values

CAPABILITIES_ATTR

static final java.lang.String CAPABILITIES_ATTR

See Also:

Constant Field Values

CAPABILITY_INVENTORY

static final java.lang.String CAPABILITY_INVENTORY

See Also:

Constant Field Values

CAPABILITY_SETMACROCONFIG

static final java.lang.String CAPABILITY_SETMACROCONFIG

See Also:

Constant Field Values

CAPABILITY_MANAGER

static final java.lang.String CAPABILITY_MANAGER

See Also:

Constant Field Values

CAPABILITY_REPORT

static final java.lang.String CAPABILITY_REPORT

See Also:

Constant Field Values

CAPABILITY_DEBUG

static final java.lang.String CAPABILITY_DEBUG

See Also:

Constant Field Values

CAPABILITY_WFGET

static final java.lang.String CAPABILITY_WFGET

See Also:

Constant Field Values

CAPABILITY_WFSET

static final java.lang.String CAPABILITY_WFSET

See Also:

Constant Field Values

CAPABILITY_HTTP

static final java.lang.String CAPABILITY_HTTP

See Also:

Constant Field Values

CAPABILITY_TIMEBOX_MAXTIME

static final java.lang.String CAPABILITY_TIMEBOX_MAXTIME

See Also:

Constant Field Values

CAPABILITY_SLEEP_MAXTIME

static final java.lang.String CAPABILITY_SLEEP_MAXTIME

See Also:

Constant Field Values

CAPABILITY_LEVELDB

static final java.lang.String CAPABILITY_LEVELDB

See Also:

Constant Field Values

CAPABILITY_LEVELDB_ADMIN

static final java.lang.String CAPABILITY_LEVELDB_ADMIN

See Also:

Constant Field Values

CAPABILITY_LEVELDB_CLOSE

static final java.lang.String CAPABILITY_LEVELDB_CLOSE

See Also:

Constant Field Values

CAPABILITY_LEVELDB_COMPACT

static final java.lang.String CAPABILITY_LEVELDB_COMPACT

See Also:

Constant Field Values

CAPABILITY_LEVELDB_OPEN

static final java.lang.String CAPABILITY_LEVELDB_OPEN

See Also:

Constant Field Values

CAPABILITY_LEVELDB_REPAIR

static final java.lang.String CAPABILITY_LEVELDB_REPAIR

See Also:

Constant Field Values

CAPABILITY_LEVELDB_SNAPSHOT

static final java.lang.String CAPABILITY_LEVELDB_SNAPSHOT

See Also:

Constant Field Values

CAPABILITY_LEVELDB_PURGE

static final java.lang.String CAPABILITY_LEVELDB_PURGE

See Also:

Constant Field Values

CAPABILITY_LEVELDB_FIND

static final java.lang.String CAPABILITY_LEVELDB_FIND

See Also:

Constant Field Values

CAPABILITY_LEVELDB_INFO

static final java.lang.String CAPABILITY_LEVELDB_INFO

See Also:

Constant Field Values

CAPABILITY_LEVELDB_REPORT

static final java.lang.String CAPABILITY_LEVELDB_REPORT

See Also:

Constant Field Values

CAPABILITY_LEVELDB_TIMESTAMP

static final java.lang.String CAPABILITY_LEVELDB_TIMESTAMP

See Also:

Constant Field Values

CAPABILITY_LIMITS

static final java.lang.String CAPABILITY_LIMITS

See Also:

Constant Field Values

CAPABILITY_LIMIT

static final java.lang.String CAPABILITY_LIMIT

See Also:

Constant Field Values

CAPABILITY_MAXBUCKETS

static final java.lang.String CAPABILITY_MAXBUCKETS

See Also:

Constant Field Values

CAPABILITY_MAXDEPTH

static final java.lang.String CAPABILITY_MAXDEPTH

See Also:

Constant Field Values

CAPABILITY_MAXGEOCELLS

static final java.lang.String CAPABILITY_MAXGEOCELLS

See Also:

Constant Field Values

CAPABILITY_MAXGTS

static final java.lang.String CAPABILITY_MAXGTS

See Also:

Constant Field Values

CAPABILITY_MAXJSON

static final java.lang.String CAPABILITY_MAXJSON

See Also:

Constant Field Values

CAPABILITY_MAXLOOP

static final java.lang.String CAPABILITY_MAXLOOP

See Also:

Constant Field Values

CAPABILITY_MAXOPS

static final java.lang.String CAPABILITY_MAXOPS

See Also:

Constant Field Values

CAPABILITY_MAXPIXELS

static final java.lang.String CAPABILITY_MAXPIXELS

See Also:

Constant Field Values

CAPABILITY_MAXRECURSION

static final java.lang.String CAPABILITY_MAXRECURSION

See Also:

Constant Field Values

CAPABILITY_MAXSYMBOLS

static final java.lang.String CAPABILITY_MAXSYMBOLS

See Also:

Constant Field Values

Method Detail

getStoreClient

StoreClient getStoreClient()

Retrieve the StoreClient instance associated with this stack.

getDirectoryClient

DirectoryClient getDirectoryClient()

Retrieve the DirectoryClient instance associated with this stack

push

void push(java.lang.Object o)
   throws WarpScriptException

Push an object onto the stack

Parameters:

o - Object to push onto the stack

Throws:

WarpScriptException

pop

java.lang.Object pop()
              throws InformativeEmptyStackException

Remove and return the object on top of the stack.

Returns:

The object on top of the stack

Throws:

InformativeEmptyStackException - if the stack is empty.

popn

java.lang.Object[] popn()
                 throws WarpScriptException

Remove and return 'N' objects from the top of the stack. 'N' is consumed at the top of the stack prior to removing and returning the objects.

Returns:

An array of 'N' objects, the first being the deepest.

Throws:

InformativeEmptyStackException - if the stack is empty.

java.lang.IndexOutOfBoundsException - If 'N' is not present or if 'N' is invalid or if the stack is not deep enough.

WarpScriptException

popn

java.lang.Object[] popn(int n)
                 throws WarpScriptException

Remove and return 'N' objects from the top of the stack. 'N' is NOT taken from the stack but given as parameter.

Returns:

An array of 'N' objects, the first being the deepest.

Throws:

InformativeEmptyStackException - if the stack is empty.

java.lang.IndexOutOfBoundsException - If 'N' is invalid or if the stack is not deep enough.

WarpScriptException

peek

java.lang.Object peek()
               throws InformativeEmptyStackException

Return the object on top of the stack without removing it from the stack.

Returns:

The object on top of the stack

Throws:

InformativeEmptyStackException - if the stack is empty.

peekn

java.lang.Object peekn()
                throws WarpScriptException

Return the object at 'distance' from the top of the stack. The 'distance' is on top of the stack and is consumed by 'peekn'. The object on top the stack is at distance 0.

Throws:

InformativeEmptyStackException - if the stack is empty.

WarpScriptException - if no valid 'distance' is on top of the stack or if the requested distance is passed the bottom of the stack.

depth

int depth()

Return the depth (i.e. number of objects) of the stack

Returns:

The depth of the stack

reset

void reset(int depth)
    throws WarpScriptException

Reset the stack to the given depth

Throws:

WarpScriptException

swap

void swap()
   throws WarpScriptException

Swap the top 2 objects of the stack.

Throws:

InformativeEmptyStackException - if the stack is empty.

java.lang.IndexOutOfBoundsException - if the stack is empty or contains a single element.

WarpScriptException

rot

void rot()
  throws WarpScriptException

Rotate the top 3 objects of the stack, pushing the top of the stack down D D C -> B B A A (top) C (top)

Throws:

InformativeEmptyStackException - if the stack is empty.

java.lang.IndexOutOfBoundsException - if the stack contains less than 3 objects

WarpScriptException

roll

void roll()
   throws WarpScriptException

Rotate up the top 'N' objects of the stack. 'N' is on top of the stack and is consumed by 'roll'.

Throws:

InformativeEmptyStackException - if the stack is empty.

java.lang.IndexOutOfBoundsException - if 'N' is not present on top of the stack, is not a number or if the stack does not have enough elements for the operation.

WarpScriptException

rolld

void rolld()
    throws WarpScriptException

Rotate down the top 'N' objects of the stack. 'N' is on the top of the stack and is consumed by 'rolld'.

Throws:

InformativeEmptyStackException - if the stack is empty

java.lang.IndexOutOfBoundsException - if 'N' is not present on top of the stack, is not a number or if the stack does not have enough elements for the operation.

WarpScriptException

pick

void pick()
   throws WarpScriptException

Copy the object at level 'N' on top of the stack. 'N' is on top of the stack and is consumed by the call to 'pick'.

Throws:

InformativeEmptyStackException

java.lang.IndexOutOfBoundsException

WarpScriptException

drop

void drop()
   throws WarpScriptException

Remove the top of the stack.

Throws:

InformativeEmptyStackException - If the stack is empty.

WarpScriptException

dropn

void dropn()
    throws WarpScriptException

Remove the top 'N' objects of the stack.

Throws:

InformativeEmptyStackException - if the stack is empty.

java.lang.IndexOutOfBoundsException - If 'N' is not present on the top of the stack, is not a number or if the stack has fewer than 'N' objects after consuming 'N'.

WarpScriptException

dup

void dup()
  throws WarpScriptException

Duplicate the object on top of the stack.

Throws:

InformativeEmptyStackException - if the stack is empty.

WarpScriptException

dupn

void dupn()
   throws WarpScriptException

Duplicate the top 'N' objects of the stack. 'N' is consumed at the top of the stack first.

Throws:

InformativeEmptyStackException - if the stack is empty.

java.lang.IndexOutOfBoundsException - if the stack contains less than 'N' objects.

WarpScriptException

get

java.lang.Object get(int level)
              throws WarpScriptException

Return the object at level 'level' on the stack. The top of the stack is level 0

Parameters:

level - Level of the object to return

Returns:

The object found at 'level'

Throws:

WarpScriptException - if the stack contains less than 'level' levels

execMulti

void execMulti(java.lang.String script)
        throws WarpScriptException

Throws:

WarpScriptException

exec

void exec(java.lang.String line)
   throws WarpScriptException

Execute a serie of statements against the stack.

Parameters:

line - String containing a space separated list of statements to execute

Throws:

WarpScriptException

exec

void exec(java.lang.String line,
          long lineNumber)
   throws WarpScriptException

Execute a series of statements against the stack.

Parameters:

line - String containing a space separated list of statements to execute

lineNumber - is the WarpScript line number, when known by exec() caller. Default value is -1.

Throws:

WarpScriptException

clear

void clear()

Empty the stack

exec

void exec(WarpScriptStack.Macro macro)
   throws WarpScriptException

Execute a macro against the stack.

Parameters:

macro - Macro instance to execute

Throws:

WarpScriptException

findFunction

java.lang.Object findFunction(java.lang.String macroName)
                       throws WarpScriptException

Find a function by name

Parameters:

macroName - Name of function to find

Throws:

WarpScriptException - if macro is not found

find

WarpScriptStack.Macro find(java.lang.String macroName)
                    throws WarpScriptException

Find a macro by name

Parameters:

macroName - Name of macro to find

Throws:

WarpScriptException - if macro is not found

run

void run(java.lang.String macroName)
  throws WarpScriptException

Execute a macro known by name.

Throws:

WarpScriptException

dump

java.lang.String dump(int n)

Produces a String representation of the top 'n' levels of the stack

Parameters:

n - Number of stack levels to display at most

load

java.lang.Object load(java.lang.String symbol)

Return the content associated with the given symbol.

Parameters:

symbol - Name of symbol to retrieve

Returns:

The content associated with 'symbol' or null if 'symbol' is not known.

store

void store(java.lang.String symbol,
           java.lang.Object value)
    throws WarpScriptException

Store the given object under 'symbol'.

Parameters:

symbol - Name under which to store a value.

value - Value to store.

Throws:

WarpScriptException

load

java.lang.Object load(int regidx)
               throws WarpScriptException

Return the content associated with the given register

Parameters:

regidx - Index of the register to read

Returns:

The content of the given register or null if the register is not set or does not exist

Throws:

WarpScriptException

store

void store(int regidx,
           java.lang.Object value)
    throws WarpScriptException

Stores the given value in register 'regidx'

Throws:

WarpScriptException

forget

void forget(java.lang.String symbol)

Forget the given symbol

Parameters:

symbol - Name of the symbol to forget.

getSymbolTable

java.util.Map<java.lang.String,java.lang.Object> getSymbolTable()

Return the current symbol table.

getRegisters

java.lang.Object[] getRegisters()

Return the current registers.

getDefined

java.util.Map<java.lang.String,WarpScriptStackFunction> getDefined()

Return the current map of redefined functions

getUUID

java.lang.String getUUID()

Return a UUID for the instance of WarpScriptStack

signal

void signal(WarpScriptStack.Signal signal)

Signal the stack, i.e. stop the currently executing code after the current statement and prevent further executions.

handleSignal

void handleSignal()
           throws WarpScriptATCException

Throw the exception associated with the current signal sent to the stack

Throws:

WarpScriptATCException

setAttribute

java.lang.Object setAttribute(java.lang.String key,
                              java.lang.Object value)

Set a stack attribute.

Parameters:

key - Key under which the attribute should be stored.

value - Value of the attribute. If null, remove the attribute.

Returns:

The previous value of the attribute or null if it was not set.

getAttribute

java.lang.Object getAttribute(java.lang.String key)

Return the value of an attribute.

Parameters:

key - Name of the attribute to retrieve.

Returns:

The value associated with 'key' or null

getCounter

java.util.concurrent.atomic.AtomicLong getCounter(int i)
                                           throws WarpScriptException

Return the ith counter associated with the stack

Throws:

WarpScriptException

checkBalanced

void checkBalanced()
            throws WarpScriptException

Perform a final check to ensure balancing constructs are balanced.

Throws:

WarpScriptException - if the stack is currently unbalanced.

define

void define(java.lang.String stmt,
            WarpScriptStack.Macro macro)

(re)define 'stmt' as a valid statement executing 'macro' This allows for the overriding of built-in statements

save

void save()
   throws WarpScriptException

Push the current stack context (symbols + redefined statements) onto the stack.

Throws:

WarpScriptException

restore

void restore()
      throws WarpScriptException

Restore the stack context from that on top of the stack

Throws:

WarpScriptException

restore

void restore(WarpScriptStack.StackContext context)
      throws WarpScriptException

Restore the given stack context

Throws:

WarpScriptException

hide

int hide()

Hide all stack levels

Returns:

The number of levels actually hidden

hide

int hide(int count)

Hide the deepest 'count' stack levels

Parameters:

count - Number of levels to hide

Returns:

The number of levels actually hidden

show

void show()

Show all previously hidden stack levels.

show

void show(int count)

Show some stack levels previously hidden. Up to 'count' levels previously hidden will be made visible. Those 'count' levels are the less deep of the hidden ones.

Parameters:

count - Number of levels to show

macroOpen

void macroOpen()
        throws WarpScriptException

Force the stack to create a macro with all following statements. The macro will be pushed onto the stack when macroClose is called. Calling this function multiple times without calling macroClose in between will throw an exception.

Throws:

WarpScriptException

macroClose

void macroClose()
         throws WarpScriptException

Closes the currently open macro (after macroOpen was called) and push it onto the stack. If macroOpen was not previously called, this function has no effect.

Throws:

WarpScriptException

auditMode

void auditMode(boolean auditMode)

Turn on/off auditMode. In auditMode, Macros contains WarpScriptAuditStatement with line numbers or WarpScript parsing errors. auditMode exits automatically after closing the first macro level, leaving on stack a macro object.