Module org.yamcs.core

Package org.yamcs.activities

Class CommandExecutor

java.lang.Object

org.yamcs.activities.CommandExecutor

All Implemented Interfaces:

ActivityExecutor

public class CommandExecutor
extends Object
implements ActivityExecutor

Constructor Summary

Constructors

Constructor	Description
CommandExecutor()

Method Summary

Modifier and Type	Method	Description
CommandExecution	createExecution(Activity activity, User caller)	Create an executable activity with the provided arguments
String	describeActivity(Map<String,Object> args)	Return a short (one-line) descriptive text for an activity that would have the specified args.
Spec	getActivitySpec()	Specify the allowed arguments of an activity
String	getActivityType()	The activity recognized by this executor
String	getDescription()	Short imperative description of this type of activity.
String	getDisplayName()	UI-friendly display name for this type of activity
String	getIcon()	Icon hint for UI purpose.
Spec.NamedSpec	getSpec()	Specify the options for this executor.
void	init(ActivityService activityService, YConfiguration options)	Initialize this executor.

Methods inherited from class java.lang.Object

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

Constructor Details

CommandExecutor

public CommandExecutor()

Method Details

getActivityType

public String getActivityType()

Description copied from interface: ActivityExecutor

The activity recognized by this executor

Specified by:

getActivityType in interface ActivityExecutor

getDisplayName

public String getDisplayName()

Description copied from interface: ActivityExecutor

UI-friendly display name for this type of activity

Specified by:

getDisplayName in interface ActivityExecutor

getDescription

public String getDescription()

Description copied from interface: ActivityExecutor

Short imperative description of this type of activity.

Specified by:

getDescription in interface ActivityExecutor

getIcon

public String getIcon()

Description copied from interface: ActivityExecutor

Icon hint for UI purpose. This should be a name present in Material Icons.

Specified by:

getIcon in interface ActivityExecutor

getSpec

public Spec.NamedSpec 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 is scriptExecution. It is suggested to use the same naming strategy.

Specified by:

getSpec in interface ActivityExecutor

init

public void init(ActivityService activityService,
 YConfiguration options)

Description copied from interface: ActivityExecutor

Initialize this executor. Called when the activity service starts.

Specified by:

init in interface ActivityExecutor

getActivitySpec

public Spec getActivitySpec()

Description copied from interface: ActivityExecutor

Specify the allowed arguments of an activity

Specified by:

getActivitySpec in interface ActivityExecutor

describeActivity

public String describeActivity(Map<String,Object> args)

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 interface ActivityExecutor

createExecution

public CommandExecution createExecution(Activity activity,
 User caller)
                                 throws ValidationException

Description copied from interface: ActivityExecutor

Create an executable activity with the provided arguments

Specified by:

createExecution in interface ActivityExecutor

Parameters:

activity - the activity to execute

caller - the calling user

Throws:

ValidationException