Package org.yamcs.activities
Class ScriptExecutor
java.lang.Object
org.yamcs.activities.ScriptExecutor
- All Implemented Interfaces:
ActivityExecutor
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptioncreateExecution
(Activity activity, User caller) Create an executable activity with the provided argumentsdescribeActivity
(Map<String, Object> args) Return a short (one-line) descriptive text for an activity that would have the specified args.Specify the allowed arguments of an activityThe activity recognized by this executorShort imperative description of this type of activity.UI-friendly display name for this type of activitygetIcon()
Icon hint for UI purpose.getSpec()
Specify the options for this executor.void
init
(ActivityService activityService, YConfiguration options) Initialize this executor.
-
Constructor Details
-
ScriptExecutor
public ScriptExecutor()
-
-
Method Details
-
getActivityType
Description copied from interface:ActivityExecutor
The activity recognized by this executor- Specified by:
getActivityType
in interfaceActivityExecutor
-
getDisplayName
Description copied from interface:ActivityExecutor
UI-friendly display name for this type of activity- Specified by:
getDisplayName
in interfaceActivityExecutor
-
getDescription
Description copied from interface:ActivityExecutor
Short imperative description of this type of activity.- Specified by:
getDescription
in interfaceActivityExecutor
-
getIcon
Description copied from interface:ActivityExecutor
Icon hint for UI purpose. This should be a name present in Material Icons.- Specified by:
getIcon
in interfaceActivityExecutor
-
getSpec
Description copied from interface:ActivityExecutor
Specify the options for this executor.The name of this spec, is where the options are to be defined as part of the
ActivityService
configuration.For example, the name for
ScriptExecutor
isscriptExecution
. It is suggested to use the same naming strategy.- Specified by:
getSpec
in interfaceActivityExecutor
-
init
Description copied from interface:ActivityExecutor
Initialize this executor. Called when the activity service starts.- Specified by:
init
in interfaceActivityExecutor
-
getActivitySpec
Description copied from interface:ActivityExecutor
Specify the allowed arguments of an activity- Specified by:
getActivitySpec
in interfaceActivityExecutor
-
describeActivity
Description copied from interface:ActivityExecutor
Return a short (one-line) descriptive text for an activity that would have the specified args.- Specified by:
describeActivity
in interfaceActivityExecutor
-
getScripts
- Throws:
IOException
-
createExecution
Description copied from interface:ActivityExecutor
Create an executable activity with the provided arguments- Specified by:
createExecution
in interfaceActivityExecutor
- Parameters:
activity
- the activity to executecaller
- the calling user- Throws:
ValidationException
-