• Home
• pl.touk.nussknacker
• nussknacker-extensions-api_2.13
• 1.18.0-RC2
• source code
• CustomActionDefinition.scala

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

pl.touk.nussknacker.engine.deployment.CustomActionDefinition.scala Maven / Gradle / Ivy

package pl.touk.nussknacker.engine.deployment

import pl.touk.nussknacker.engine.api.definition.{ParameterEditor, ParameterValidator}
import pl.touk.nussknacker.engine.api.deployment.{ScenarioActionName, StateStatus}

import java.net.URI

/*
This is an experimental version, API will change in the future.
CustomActions purpose is to allow non standard process management actions (like deploy, cancel, etc.)

FIXME:
1. Additional validations on action invoke, like checking if process definition is valid

Things to consider in future changes:
1. Allowing for attaching comments to custom actions, similarly to stop/deploy comments.
2. Storing custom actions taken in DB.
 */

case class CustomActionDefinition(
    actionName: ScenarioActionName,
    // We cannot use "engine.api.deployment.StateStatus" because it can be implemented as a class containing nonconstant attributes
    allowedStateStatusNames: List[StateStatus.StatusName],
    parameters: List[CustomActionParameter] = Nil,
    icon: Option[URI] = None
)

case class CustomActionParameter(
    name: String,
    editor: ParameterEditor,
    validators: List[ParameterValidator] = Nil
)

case class CustomActionResult(msg: String)