ShellPlanElement (ExecutionEngine 1.1.5-SNAPSHOT API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

gr.uoa.di.madgik.execution.plan.element
Class ShellPlanElement

java.lang.Object
  gr.uoa.di.madgik.execution.plan.element.PlanElementBase
      gr.uoa.di.madgik.execution.plan.element.ShellPlanElement

All Implemented Interfaces:: IPlanElement, Observer

public class ShellPlanElement
extends PlanElementBase
extends PlanElementBase

This class acts as an invocation wrapper of a shell script, or in general an external executable, enabling it to be directly included in the execution of a plan. The executable is defined using its absolute or relative path in the Command field. Any parameters it may require to be provided are specified in the ArgumentParameters. Additionally, any environmental variables that need to be present for the execution of the command can be defined in Environment. The execution of the external executable is done using a ProcessBuilder. It is also possible to define the data that will be written to the processe's standard input using the StdInParameter. The standard output and standard error of the process can be retrieved by setting the StdOutParameter and StdErrParameter respectively. these inputs and outputs can be retrieved / dumped from /to files by setting the respective flags StdInIsFile, StdOutIsFile and StdErrIsFile

Author:: gpapanikos

Nested Class Summary

Nested classes/interfaces inherited from class gr.uoa.di.madgik.execution.plan.element.PlanElementBase
`PlanElementBase.ClockType`

Nested classes/interfaces inherited from interface gr.uoa.di.madgik.execution.plan.element.IPlanElement
`IPlanElement.PlanElementType`

Field Summary
`List<AttributedInputParameter>`	`ArgumentParameters` The parameters that should be provided to the process's executable
`String`	`Command` The executable that is to be started
`List<EnvironmentKeyValue>`	`Environment` The environmental variables that must be set for the process being started
`List<ExceptionExitCodeMaping>`	`ExitCodeErrors` A mapping of exit codes to the respective errors they should produce
`boolean`	`StdErrIsFile` A flag indicating that the standard error output should be stored in a file
`ParameterFilterBase`	`StdErrOnlineFilter` A filter that can be applied on the fly in the output of the element's standard error
`IInputOutputParameter`	`StdErrParameter` The parameter to store the product of the standard error output.
`IOutputParameter`	`StdExitValueParameter` The parameter where to store the exit value of the process
`boolean`	`StdInIsFile` A flag indicating that the standard input should be retrieved by a file
`IInputParameter`	`StdInParameter` The parameter to retrieve the products of the standard input.
`boolean`	`StdOutIsFile` A flag indicating that the standard output products should be stored in a file
`ParameterFilterBase`	`StdOutOnlineFilter` A filter that can be applied on the fly in the output of the element's standard output
`IInputOutputParameter`	`StdOutParameter` The parameter to store the product of the standard error output.
`List<ContingencyTrigger>`	`Triggers` The Triggers this element supports

Constructor Summary
`ShellPlanElement()`

Method Summary
`void`	`ExecuteExtender(ExecutionHandle Handle)` Execute extender.
`void`	`FromXML(Element XML)` Populate the element from its xml serialization as returned by `IPlanElement.ToXML()`
`void`	`FromXML(String XML)` Populate the element from its xml serialization as returned by `IPlanElement.ToXML()`
`List<ContingencyTrigger>`	`GetContingencyTriggers()` Gets the contingency triggers.
`Logger`	`GetExtenderLogger()` Gets the extender logger.
`String`	`GetID()` Gets the id.
`Set<String>`	`GetModifiedVariableNames()` Gets the modified variable names of the element and of the elements contained.
`String`	`GetName()` Gets the name.
`Set<String>`	`GetNeededVariableNames()` Gets the needed variable names of the element and of the elements contained.
`IPlanElement.PlanElementType`	`GetPlanElementType()` Gets the plan element type.
`IPlanElement`	`Locate(String ID)` Locate the plan element with the provided id.
`Set<IPlanElement>`	`LocateActionElements()` Retrieves the Action elements under this elements
`void`	`SetContingencyResourcePick(ExecutionHandle Handle, String Pick)` Sets the picked resource in case the `IContingencyReaction.ReactionType#Pick` reaction is supported
`void`	`SetName(String Name)` Sets the name.
`IContingencyReaction.ReactionType[]`	`SupportedContingencyTriggers()` Retrieves the supported contingency triggers.
`boolean`	`SupportsContingencyTriggers()` Checks if the element supports contingency triggers.
`String`	`ToXML()` Serialize to xml the element and all its contained elements
`void`	`Validate()` Validate the element and any sub element it contains
`void`	`ValidatePreExecution(ExecutionHandle Handle)` Validate the element and any sub element it contains before it is executed

Methods inherited from class gr.uoa.di.madgik.execution.plan.element.PlanElementBase
`CheckStatus, Execute, ExecuteWithStateAwareness, GetPerformanceEvent, RegisterToRunningActionElementsRestriction, ResetClocks, StartClock, StopClock, UnregisterToRunningActionElementsRestriction, update`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Field Detail

Triggers

public List<ContingencyTrigger> Triggers

The Triggers this element supports

Command

public String Command

The executable that is to be started

ArgumentParameters

public List<AttributedInputParameter> ArgumentParameters

The parameters that should be provided to the process's executable

StdInParameter

public IInputParameter StdInParameter

The parameter to retrieve the products of the standard input. If the StdInIsFile is set then this parameter will hold the file that the input should be read from

StdInIsFile

public boolean StdInIsFile

A flag indicating that the standard input should be retrieved by a file

StdOutParameter

public IInputOutputParameter StdOutParameter

The parameter to store the product of the standard error output. If the StdOutIsFile is set then this parameter will hold the file that the output was dumped to

StdOutIsFile

public boolean StdOutIsFile

A flag indicating that the standard output products should be stored in a file

StdOutOnlineFilter

public ParameterFilterBase StdOutOnlineFilter

A filter that can be applied on the fly in the output of the element's standard output

StdErrParameter

public IInputOutputParameter StdErrParameter

The parameter to store the product of the standard error output. If the StdErrIsFile is set then this parameter will hold the file that the output was dumped to

StdErrIsFile

public boolean StdErrIsFile

A flag indicating that the standard error output should be stored in a file

StdErrOnlineFilter

public ParameterFilterBase StdErrOnlineFilter

A filter that can be applied on the fly in the output of the element's standard error

StdExitValueParameter

public IOutputParameter StdExitValueParameter

The parameter where to store the exit value of the process

ExitCodeErrors

public List<ExceptionExitCodeMaping> ExitCodeErrors

A mapping of exit codes to the respective errors they should produce

Environment

public List<EnvironmentKeyValue> Environment

The environmental variables that must be set for the process being started

Constructor Detail

ShellPlanElement

public ShellPlanElement()

Method Detail