Class NodeIIAR

java.lang.Object

com.scivicslab.pojoactor.core.ActorRef<NodeInterpreter>

com.scivicslab.pojoactor.workflow.IIActorRef<NodeInterpreter>

com.scivicslab.actoriac.NodeIIAR

All Implemented Interfaces:

com.scivicslab.pojoactor.core.CallableByActionName, AutoCloseable

public class NodeIIAR
extends com.scivicslab.pojoactor.workflow.IIActorRef<NodeInterpreter>

Interpreter-interfaced actor reference for NodeInterpreter instances.

This class provides a concrete implementation of IIActorRef specifically for NodeInterpreter objects. It handles action invocations by name, supporting both workflow execution actions (inherited from Interpreter) and infrastructure actions (SSH command execution).

Supported actions:

Workflow actions (from Interpreter):

• execCode - Executes the loaded workflow code
• readYaml - Reads a YAML workflow definition from a file path
• readJson - Reads a JSON workflow definition from a file path
• readXml - Reads an XML workflow definition from a file path
• reset - Resets the interpreter state

Infrastructure actions (Node-specific):

• executeCommand - Executes a command and reports to accumulator (default)
• executeCommandQuiet - Executes a command without reporting
• executeSudoCommand - Executes sudo command and reports to accumulator (default)
• executeSudoCommandQuiet - Executes sudo command without reporting

Example YAML Workflow:

name: deploy-application
steps:
  - states: ["0", "1"]
    actions:
      - actor: this
        method: executeCommand
        arguments:
          - "apt-get update"
  - states: ["1", "end"]
    actions:
      - actor: this
        method: executeCommand
        arguments:
          - "ls -la"

Author:

devteam@scivics-lab.com

Field Summary

Fields

Modifier and Type	Field	Description
(package private) Logger	logger

Fields inherited from class com.scivicslab.pojoactor.core.ActorRef

actorName, actorSystem, object

Constructor Summary

Constructors

Constructor	Description
NodeIIAR(String actorName, NodeInterpreter object)	Constructs a new NodeIIAR with the specified actor name and node interpreter object.
NodeIIAR(String actorName, NodeInterpreter object, com.scivicslab.pojoactor.workflow.IIActorSystem system)	Constructs a new NodeIIAR with the specified actor name, node interpreter object, and actor system.

Method Summary

Modifier and Type	Method	Description
com.scivicslab.pojoactor.core.ActionResult	callByActionName(String actionName, String arg)	Invokes an action on the node by name with the given arguments.
private String	combineOutput(Node.CommandResult result)	Combines stdout and stderr into a single output string.
private com.scivicslab.pojoactor.core.ActionResult	executeCommandQuiet(String arg)
private com.scivicslab.pojoactor.core.ActionResult	executeCommandWithReport(String arg)
private com.scivicslab.pojoactor.core.ActionResult	executeSudoCommandQuiet(String arg)
private com.scivicslab.pojoactor.core.ActionResult	executeSudoCommandWithReport(String arg)
private String	extractCommandFromArgs(String arg)	Extracts a command string from JSON array arguments.
private String	extractRootCauseMessage(ExecutionException e)	Extracts the root cause message from an ExecutionException.
private com.scivicslab.pojoactor.core.ActionResult	handleCommandAction(String actionName, String arg)	Handles SSH command execution actions.
private com.scivicslab.pojoactor.core.ActionResult	handleDocumentAction(String actionName, String arg)	Handles document workflow actions (detect, clone, build, deploy).
private com.scivicslab.pojoactor.core.ActionResult	handleReadJson(String arg)
private com.scivicslab.pojoactor.core.ActionResult	handleReadXml(String arg)
private com.scivicslab.pojoactor.core.ActionResult	handleReadYaml(String arg)
private com.scivicslab.pojoactor.core.ActionResult	handleUtilityAction(String actionName, String arg)	Handles utility actions (sleep, print, doNothing).
private com.scivicslab.pojoactor.core.ActionResult	handleWorkflowAction(String actionName, String arg)	Handles workflow-related actions (from Interpreter).
private int	parseMaxIterations(String arg, int defaultValue)
private void	reportToAccumulator(Node.CommandResult result)	Reports command result to the accumulator actor if available.

Methods inherited from class com.scivicslab.pojoactor.core.ActorRef

ask, ask, askNow, clearJsonState, clearPendingMessages, close, createChild, getJsonBoolean, getJsonInt, getJsonString, getJsonString, getName, getNamesOfChildren, getParentName, hasJson, hasJsonState, initLogger, isAlive, json, putJson, setParentName, system, tell, tell, tellNow

Methods inherited from class Object

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

Field Details

logger

Logger logger

Constructor Details

NodeIIAR

public NodeIIAR(String actorName,
 NodeInterpreter object)

Constructs a new NodeIIAR with the specified actor name and node interpreter object.

Parameters:

actorName - the name of this actor

object - the NodeInterpreter instance managed by this actor reference

NodeIIAR

public NodeIIAR(String actorName,
 NodeInterpreter object,
 com.scivicslab.pojoactor.workflow.IIActorSystem system)

Constructs a new NodeIIAR with the specified actor name, node interpreter object, and actor system.

Parameters:

actorName - the name of this actor

object - the NodeInterpreter instance managed by this actor reference

system - the actor system managing this actor

Method Details

callByActionName

public com.scivicslab.pojoactor.core.ActionResult callByActionName(String actionName,
 String arg)

Invokes an action on the node by name with the given arguments.

This method dispatches to specialized handler methods based on the action type:

• Workflow actions: handleWorkflowAction(String, String)
• Command execution actions: handleCommandAction(String, String)
• Utility actions: handleUtilityAction(String, String)

Specified by:

callByActionName in interface com.scivicslab.pojoactor.core.CallableByActionName

Specified by:

callByActionName in class com.scivicslab.pojoactor.workflow.IIActorRef<NodeInterpreter>

Parameters:

actionName - the name of the action to execute

arg - the argument string (file path for read operations, JSON array for commands)

Returns:

an ActionResult indicating success or failure with a message

handleWorkflowAction

private com.scivicslab.pojoactor.core.ActionResult handleWorkflowAction(String actionName,
 String arg)
                                                                 throws InterruptedException,
ExecutionException

Handles workflow-related actions (from Interpreter).

Parameters:

actionName - the action name

arg - the argument string

Returns:

ActionResult if handled, null if not a workflow action

Throws:

InterruptedException

ExecutionException

handleCommandAction

private com.scivicslab.pojoactor.core.ActionResult handleCommandAction(String actionName,
 String arg)
                                                                throws InterruptedException,
ExecutionException

Handles SSH command execution actions.

Parameters:

actionName - the action name

arg - the argument string

Returns:

ActionResult if handled, null if not a command action

Throws:

InterruptedException

ExecutionException

handleUtilityAction

private com.scivicslab.pojoactor.core.ActionResult handleUtilityAction(String actionName,
 String arg)

Handles utility actions (sleep, print, doNothing).

Parameters:

actionName - the action name

arg - the argument string

Returns:

ActionResult if handled, null if not a utility action

handleDocumentAction

private com.scivicslab.pojoactor.core.ActionResult handleDocumentAction(String actionName,
 String arg)
                                                                 throws InterruptedException,
ExecutionException

Handles document workflow actions (detect, clone, build, deploy).

Parameters:

actionName - the action name

arg - the argument string

Returns:

ActionResult if handled, null if not a document action

Throws:

InterruptedException

ExecutionException

handleReadYaml

private com.scivicslab.pojoactor.core.ActionResult handleReadYaml(String arg)
                                                           throws InterruptedException,
ExecutionException

Throws:

InterruptedException

ExecutionException

handleReadJson

private com.scivicslab.pojoactor.core.ActionResult handleReadJson(String arg)
                                                           throws InterruptedException,
ExecutionException

Throws:

InterruptedException

ExecutionException

handleReadXml

private com.scivicslab.pojoactor.core.ActionResult handleReadXml(String arg)
                                                          throws InterruptedException,
ExecutionException

Throws:

InterruptedException

ExecutionException

parseMaxIterations

private int parseMaxIterations(String arg,
 int defaultValue)

executeCommandQuiet

private com.scivicslab.pojoactor.core.ActionResult executeCommandQuiet(String arg)
                                                                throws InterruptedException,
ExecutionException

Throws:

InterruptedException

ExecutionException

executeSudoCommandQuiet

private com.scivicslab.pojoactor.core.ActionResult executeSudoCommandQuiet(String arg)
                                                                    throws InterruptedException,
ExecutionException

Throws:

InterruptedException

ExecutionException

executeCommandWithReport

private com.scivicslab.pojoactor.core.ActionResult executeCommandWithReport(String arg)
                                                                     throws InterruptedException,
ExecutionException

Throws:

InterruptedException

ExecutionException

executeSudoCommandWithReport

private com.scivicslab.pojoactor.core.ActionResult executeSudoCommandWithReport(String arg)
                                                                         throws InterruptedException,
ExecutionException

Throws:

InterruptedException

ExecutionException

reportToAccumulator

private void reportToAccumulator(Node.CommandResult result)

Reports command result to the accumulator actor if available.

combineOutput

private String combineOutput(Node.CommandResult result)

Combines stdout and stderr into a single output string.

extractRootCauseMessage

private String extractRootCauseMessage(ExecutionException e)

Extracts the root cause message from an ExecutionException.

extractCommandFromArgs

private String extractCommandFromArgs(String arg)

Extracts a command string from JSON array arguments.

Expects arguments in the format: ["command string"]

Parameters:

arg - the JSON array argument string

Returns:

the extracted command string

Throws:

IllegalArgumentException - if the argument format is invalid