Package hudson.scm

Class IntegrityCheckinAction

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

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static class 
    IntegrityCheckinAction.IntegrityCheckinDescriptorImpl
    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 IntegrityCheckinAction.IntegrityCheckinDescriptorImpl
    CHECKIN_DESCRIPTOR
     

    Fields inherited from interface hudson.tasks.BuildStep

    BUILDERS, PUBLISHERS

  • Constructor Summary

    Constructors
    Constructor
    Description
    IntegrityCheckinAction(String ciConfigPath, String ciWorkspaceDir, String includes, String excludes, String serverConfig, String configurationName)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getCiConfigPath()
    Returns the configuration path for the project to check-in artifacts after the build
    String
    getCiWorkspaceDir()
    Returns the workspace directory containing the check-in artifacts created as a result of the build
    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
    String
    getExcludes()
    Returns the Ant-style excludes filter for the check-in workspace folder
    String
    getIncludes()
    Returns the Ant-style includes filter for the check-in workspace folder
    hudson.tasks.BuildStepMonitor
    getRequiredMonitorService()
    Returns the build step we're monitoring
    String
    getServerConfig()
    Returns the simple server configuration name
    boolean
    needsToRunAfterFinalized()
    Toggles whether or not this needs to run after build is finalized Returning false, so that a check-in failure will cause a failed build
    boolean
    perform(hudson.model.AbstractBuild<?,?> build, hudson.Launcher launcher, hudson.model.BuildListener listener)
    Executes the actual Integrity Checkpoint operation
    void
    setCiConfigPath(String ciConfigPath)
    Sets the configuration path for the project to check-in artifacts after the build
    void
    setCiWorkspaceDir(String ciWorkspaceDir)
    Sets the workspace directory containing the check-in artifacts created as a result of the build
    void
    setConfigurationName(String configurationName)
    Sets the build configuration name for this project
    void
    setExcludes(String excludes)
    Sets the Ant-style excludes filter for the check-in workspace folder
    void
    setIncludes(String includes)
    Sets the Ant-style includes filter for the check-in workspace folder
    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

    • IntegrityCheckinAction

      @DataBoundConstructor public IntegrityCheckinAction(String ciConfigPath, String ciWorkspaceDir, String includes, String excludes, String serverConfig, String configurationName)

  • Method Details

    • getCiConfigPath

      public String getCiConfigPath()
      Returns the configuration path for the project to check-in artifacts after the build
      Returns:

    • getCiWorkspaceDir

      public String getCiWorkspaceDir()
      Returns the workspace directory containing the check-in artifacts created as a result of the build
      Returns:

    • getIncludes

      public String getIncludes()
      Returns the Ant-style includes filter for the check-in workspace folder
      Returns:

    • getExcludes

      public String getExcludes()
      Returns the Ant-style excludes filter for the check-in workspace folder
      Returns:

    • getServerConfig

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

    • getConfigurationName

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

    • setCiConfigPath

      public void setCiConfigPath(String ciConfigPath)
      Sets the configuration path for the project to check-in artifacts after the build
      Parameters:
      ciConfigPath -

    • setCiWorkspaceDir

      public void setCiWorkspaceDir(String ciWorkspaceDir)
      Sets the workspace directory containing the check-in artifacts created as a result of the build
      Parameters:
      ciWorkspaceDir -

    • setIncludes

      public void setIncludes(String includes)
      Sets the Ant-style includes filter for the check-in workspace folder
      Parameters:
      includes -

    • setExcludes

      public void setExcludes(String excludes)
      Sets the Ant-style excludes filter for the check-in workspace folder
      Parameters:
      excludes -

    • setServerConfig

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

    • setConfigurationName

      public void setConfigurationName(String configurationName)
      Sets the build configuration name for this project
      Parameters:
      configurationName -

    • 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 Returning false, so that a check-in failure will cause a failed build
      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