Package com.atlassian.bamboo.trigger.exporters

Class ScheduledTriggerDefinitionExporter

java.lang.Object
com.atlassian.bamboo.trigger.exporters.ScheduledTriggerDefinitionExporter
All Implemented Interfaces:
TriggerDefinitionExporter
public class ScheduledTriggerDefinitionExporter extends Object implements TriggerDefinitionExporter

  • Constructor Summary

    Constructors
    Constructor
    Description
    ScheduledTriggerDefinitionExporter(CachedPlanManager cachedPlanManager, ChainBranchManager chainBranchManager, PlanManager planManager, DeploymentProjectService deploymentProjectService)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    @Nullable com.atlassian.bamboo.specs.api.builders.trigger.Trigger
    fromYaml(@NotNull Node node, @NotNull TaskValidationContext context)
    Parse YAML node to Trigger Specs builder.
    @NotNull com.atlassian.bamboo.specs.api.builders.trigger.Trigger
    toSpecsEntity(@NotNull TriggerDefinition triggerDefinition)
    Create Bamboo Specs object representing this trigger.
    @NotNull com.atlassian.bamboo.specs.api.builders.trigger.Trigger<? extends com.atlassian.bamboo.specs.api.builders.trigger.Trigger<?,com.atlassian.bamboo.specs.model.trigger.ScheduledTriggerProperties>,com.atlassian.bamboo.specs.model.trigger.ScheduledTriggerProperties>
    toSpecsEntity(@NotNull TriggerDefinition triggerDefinition, @NotNull Triggerable triggerable)
    Create Bamboo Specs object representing this trigger.
    @NotNull Map<String,String>
    toTriggerConfiguration(@NotNull com.atlassian.bamboo.specs.api.model.trigger.TriggerProperties triggerProperties, @NotNull Triggerable triggerable)
    Converts properties to Bamboo trigger configuration.
    <T extends com.atlassian.bamboo.specs.api.model.trigger.TriggerProperties>
    @Nullable Node
    toYaml(T triggerProperties)
    Convert trigger definition to YAML node.
    List<com.atlassian.bamboo.specs.api.validators.common.ValidationProblem>
    validate(@NotNull TriggerValidationContext triggerValidationContext, @NotNull com.atlassian.bamboo.specs.api.model.trigger.TriggerProperties triggerProperties)
    Validates trigger properties in context of enclosing plan or deployment properties.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

  • Method Details

    • toTriggerConfiguration

      @NotNull public @NotNull Map<String,String> toTriggerConfiguration(@NotNull @NotNull com.atlassian.bamboo.specs.api.model.trigger.TriggerProperties triggerProperties, @NotNull @NotNull Triggerable triggerable)
      Description copied from interface: TriggerDefinitionExporter
      Converts properties to Bamboo trigger configuration. Can use all Bamboo server side services and can access DB if necessary. Should throw a runtime exception if conversion fails.
      Specified by:
      toTriggerConfiguration in interface TriggerDefinitionExporter
      Returns:
      trigger configuration

    • toSpecsEntity

      @NotNull public @NotNull com.atlassian.bamboo.specs.api.builders.trigger.Trigger toSpecsEntity(@NotNull @NotNull TriggerDefinition triggerDefinition)
      Description copied from interface: TriggerDefinitionExporter
      Create Bamboo Specs object representing this trigger. Implementors don't need to handle common task properties like e.g. enabled/disabled, but must trigger specific configuration.
      Specified by:
      toSpecsEntity in interface TriggerDefinitionExporter

    • toSpecsEntity

      @NotNull public @NotNull com.atlassian.bamboo.specs.api.builders.trigger.Trigger<? extends com.atlassian.bamboo.specs.api.builders.trigger.Trigger<?,com.atlassian.bamboo.specs.model.trigger.ScheduledTriggerProperties>,com.atlassian.bamboo.specs.model.trigger.ScheduledTriggerProperties> toSpecsEntity(@NotNull @NotNull TriggerDefinition triggerDefinition, @NotNull @NotNull Triggerable triggerable)
      Description copied from interface: TriggerDefinitionExporter
      Create Bamboo Specs object representing this trigger. Implementors don't need to handle common task properties like e.g. enabled/disabled, but must trigger specific configuration.
      Specified by:
      toSpecsEntity in interface TriggerDefinitionExporter

    • validate

      public List<com.atlassian.bamboo.specs.api.validators.common.ValidationProblem> validate(@NotNull @NotNull TriggerValidationContext triggerValidationContext, @NotNull @NotNull com.atlassian.bamboo.specs.api.model.trigger.TriggerProperties triggerProperties)
      Description copied from interface: TriggerDefinitionExporter
      Validates trigger properties in context of enclosing plan or deployment properties. Should check for any inconsistencies between trigger definition and the rest of plan or deployment content, as it is provided in the validation context. Returns list of validation errors or empty if everything is ok.

      Should check RSS permissions if necessary.

      Specified by:
      validate in interface TriggerDefinitionExporter

    • toYaml

      @Nullable public <T extends com.atlassian.bamboo.specs.api.model.trigger.TriggerProperties> @Nullable Node toYaml(@NotNull T triggerProperties)
      Description copied from interface: TriggerDefinitionExporter
      Convert trigger definition to YAML node. Bamboo might modify returned node to add information about trigger conditions or other general trigger settings. To make it compatible with future versions returned value should be StringNode or MapNode (String, Map). Structure MapNode (String, String) can't be enriched with additional elements and cause runtime failures for some cases.
      Specified by:
      toYaml in interface TriggerDefinitionExporter
      Returns:
      YAML representation of the trigger.

    • fromYaml

      @Nullable public @Nullable com.atlassian.bamboo.specs.api.builders.trigger.Trigger fromYaml(@NotNull @NotNull Node node, @NotNull @NotNull TaskValidationContext context) throws YamlSpecsValidationException
      Description copied from interface: TriggerDefinitionExporter
      Parse YAML node to Trigger Specs builder.
      Specified by:
      fromYaml in interface TriggerDefinitionExporter
      Parameters:
      node - YAML node from user input. In general case it's same node generated by TriggerDefinitionExporter.toYaml(TriggerProperties) method, but in some cases it might contain additional trigger elements, like conditions. These elements should be ignored by method implementation and will be handled by Bamboo code. In such case MapNode handler should be implemented even if TriggerDefinitionExporter.toYaml(TriggerProperties) produces StringNode.
      context - task validation context
      Throws:
      YamlSpecsValidationException