Package step.plans.parser.yaml

Interface YamlPlanReaderExtender

public interface YamlPlanReaderExtender
Allows to extend the logic of working with Yaml plans (for Step EE). To do that, there should be a class implementing the YamlPlanReaderExtender and annotated with YamlPlanReaderExtension. The following functionality can be extended via this class: - the conversion from the Yaml plan to the Plan object - the serialization from Plan to the Yaml format - the generation of json schema for Yaml Plan format (see YamlPlanSchemaGenerationTool - the used json schema (for example, to switch to extended json schema in Step EE)

  • Method Details

    • getSerializationExtensions

      default List<YamlArtefactFieldSerializationProcessor> getSerializationExtensions()
      Defines the additional list of YamlArtefactFieldSerializationProcessors to be used during serialization from Plan to the Yaml format. This allows to add some special logic for Step EE artefacts (custom field processing for Step EE artefacts).

    • getDeserializationExtensions

      default List<YamlArtefactFieldDeserializationProcessor> getDeserializationExtensions()
      Defines the additional list of YamlArtefactFieldDeserializationProcessor to be used during reading the Yaml Plan and convert it to the Plan. This allows to add some special logic for Step EE artefacts (custom field processing for Step EE artefacts).

    • getJsonSchemaFieldProcessingExtensions

      default List<step.handlers.javahandler.jsonschema.JsonSchemaFieldProcessor> getJsonSchemaFieldProcessingExtensions()
      Defines the additional list of JsonSchemaFieldProcessor to be used during the json schema preparation. This allows to add some custom json schema parts for Step EE artefacts (see YamlPlanSchemaGenerationTool).

    • getJsonSchemaDefinitionsExtensions

      default List<YamlPlanJsonSchemaDefinitionCreator> getJsonSchemaDefinitionsExtensions()
      Defines the additional list of YamlPlanJsonSchemaDefinitionCreator to be used to add some type reusable definitions (sub-schemas) to json the schema

    • getJsonSchemaPath

      default String getJsonSchemaPath()
      Allows to redefine the json schema (for instance, switch used json schema to extended one for Step EE). There should be at max one YamlPlanReaderExtender annotated with YamlPlanReaderExtension overriding the json schema (returning the non-null string via this method).