Package hudson.scm

Class IntegrityCheckpointAction

java.lang.Object
hudson.tasks.BuildStepCompatibilityLayer
hudson.tasks.Publisher
hudson.tasks.Notifier
hudson.scm.IntegrityCheckpointAction
All Implemented Interfaces:
hudson.ExtensionPoint, hudson.model.Describable<hudson.tasks.Publisher>, hudson.tasks.BuildStep, Serializable
public class IntegrityCheckpointAction extends hudson.tasks.Notifier implements Serializable
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static class 
    IntegrityCheckpointAction.IntegrityCheckpointDescriptorImpl
    The relationship of Descriptor and IntegrityCheckpointAction (the describable) is akin to class and object.

    Nested classes/interfaces inherited from class hudson.tasks.Publisher

    hudson.tasks.Publisher.DescriptorExtensionListImpl

    Nested classes/interfaces inherited from interface hudson.tasks.BuildStep

    hudson.tasks.BuildStep.PublisherList

    Nested classes/interfaces inherited from interface hudson.ExtensionPoint

    hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final IntegrityCheckpointAction.IntegrityCheckpointDescriptorImpl
    CHECKPOINT_DESCRIPTOR
     

    Fields inherited from interface hudson.tasks.BuildStep

    BUILDERS, PUBLISHERS

  • Constructor Summary

    Constructors
    Constructor
    Description
    IntegrityCheckpointAction(String serverConfig, String checkpointLabel)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    static String
    evalGroovyExpression(Map<String,String> env, String expression)
    Utility function to convert a groovy expression to a string
    String
    getCheckpointLabel()
    Returns the label pattern for the Checkpoint
    String
    getConfigurationName()
    Returns the build configuration name for this project
    hudson.tasks.BuildStepDescriptor<hudson.tasks.Publisher>
    getDescriptor()
    Return the instance of DescriptorImpl object for this class
    hudson.tasks.BuildStepMonitor
    getRequiredMonitorService()
    Returns the build step we're monitoring
    String
    getServerConfig()
    Returns the simple server configuration name
    static String
    isInvalidTag(String checkpointLabel)
    Checks if the given value is a valid Integrity Label.
    boolean
    needsToRunAfterFinalized()
    Toggles whether or not this needs to run after build is finalized
    boolean
    perform(hudson.model.AbstractBuild<?,?> build, hudson.Launcher launcher, hudson.model.BuildListener listener)
    Executes the actual Integrity Checkpoint operation
    void
    setCheckpointLabel(String checkpointLabel)
    Sets the label for the Checkpoint
    void
    setServerConfig(String serverConfig)
    Sets the simple server configuration name

    Methods inherited from class hudson.tasks.Publisher

    all, getProjectAction, prebuild

    Methods inherited from class hudson.tasks.BuildStepCompatibilityLayer

    getProjectAction, getProjectActions, perform, prebuild

    Methods inherited from class java.lang.Object

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

  • Field Details

  • Constructor Details

    • IntegrityCheckpointAction

      @DataBoundConstructor public IntegrityCheckpointAction(String serverConfig, String checkpointLabel)

  • Method Details

    • evalGroovyExpression

      public static String evalGroovyExpression(Map<String,String> env, String expression) throws Exception
      Utility function to convert a groovy expression to a string
      Parameters:
      env - Environment containing the name/value pairs for substitution
      expression - Groovy expression string
      Returns:
      Resolved string
      Throws:
      Exception

    • isInvalidTag

      public static String isInvalidTag(String checkpointLabel)
      Checks if the given value is a valid Integrity Label. If it's invalid, this method gives you the reason as string.
      Parameters:
      checkpointLabel - The checkpoint label name
      Returns:
      the error message, or null if label is valid

    • getCheckpointLabel

      public String getCheckpointLabel()
      Returns the label pattern for the Checkpoint
      Returns:
      Checkpoint Label

    • setCheckpointLabel

      public void setCheckpointLabel(String checkpointLabel)
      Sets the label for the Checkpoint
      Parameters:
      checkpointLabel - The Checkpoint Label

    • getServerConfig

      public String getServerConfig()
      Returns the simple server configuration name
      Returns:

    • setServerConfig

      public void setServerConfig(String serverConfig)
      Sets the simple server configuration name
      Parameters:
      serverConfig -

    • getConfigurationName

      public String getConfigurationName()
      Returns the build configuration name for this project
      Returns:

    • perform

      public boolean perform(hudson.model.AbstractBuild<?,?> build, hudson.Launcher launcher, hudson.model.BuildListener listener) throws InterruptedException, IOException
      Executes the actual Integrity Checkpoint operation
      Specified by:
      perform in interface hudson.tasks.BuildStep
      Overrides:
      perform in class hudson.tasks.BuildStepCompatibilityLayer
      Throws:
      InterruptedException
      IOException

    • needsToRunAfterFinalized

      public boolean needsToRunAfterFinalized()
      Toggles whether or not this needs to run after build is finalized
      Overrides:
      needsToRunAfterFinalized in class hudson.tasks.Publisher

    • getRequiredMonitorService

      public hudson.tasks.BuildStepMonitor getRequiredMonitorService()
      Returns the build step we're monitoring
      Specified by:
      getRequiredMonitorService in interface hudson.tasks.BuildStep

    • getDescriptor

      public hudson.tasks.BuildStepDescriptor<hudson.tasks.Publisher> getDescriptor()
      Return the instance of DescriptorImpl object for this class
      Specified by:
      getDescriptor in interface hudson.model.Describable<hudson.tasks.Publisher>
      Overrides:
      getDescriptor in class hudson.tasks.Notifier