- All Implemented Interfaces:
public class Fingerprinter extends Recorder implements Serializable, DependencyDeclarer, SimpleBuildStepRecords fingerprints of the specified files.
- Kohsuke Kawaguchi
- See Also:
- Serialized Form
Nested Class Summary
Nested Classes Modifier and Type Class Description
Fingerprinter.FingerprintActionAction for displaying fingerprints.
Nested classes/interfaces inherited from class hudson.tasks.Publisher
Nested classes/interfaces inherited from interface hudson.ExtensionPoint
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description
buildDependencyGraph(AbstractProject owner, DependencyGraph graph)Invoked from
getRequiredMonitorService()Declares the scope of the synchronization monitor this
BuildStepexpects from outside.
perform(Run<?,?> build, FilePath workspace, EnvVars environment, Launcher launcher, TaskListener listener)Run this step.
Methods inherited from class hudson.tasks.Publisher
all, getProjectAction, needsToRunAfterFinalized, prebuild
Methods inherited from class hudson.tasks.BuildStepCompatibilityLayer
getProjectAction, getProjectActions, perform, perform, prebuild
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface hudson.tasks.BuildStep
getProjectAction, getProjectActions, perform, prebuild
@DataBoundSetter public void setExcludes(String excludes)
@DataBoundSetter public void setDefaultExcludes(boolean defaultExcludes)
@DataBoundSetter public void setCaseSensitive(boolean caseSensitive)
public String getTargets()
public String getExcludes()
public boolean getDefaultExcludes()
public boolean getCaseSensitive()
@Deprecated public boolean getRecordBuildArtifacts()Deprecated.
public void perform(Run<?,?> build, FilePath workspace, EnvVars environment, Launcher launcher, TaskListener listener) throws InterruptedExceptionDescription copied from interface:
SimpleBuildStepRun this step.
This method must be overridden when this step requires a workspace context. If such a context is not required, it does not need to be overridden; it will then forward to
SimpleBuildStep.perform(Run, EnvVars, TaskListener).
- Specified by:
build- a build this is running as a part of
workspace- a workspace to use for any file operations
environment- environment variables applicable to this step
launcher- a way to start processes
listener- a place to send output
InterruptedException- if the step is interrupted
public BuildStepMonitor getRequiredMonitorService()Description copied from interface:
BuildStepDeclares the scope of the synchronization monitor this
BuildStepexpects from outside.
This method is introduced for preserving compatibility with plugins written for earlier versions of Hudson, which never run multiple builds of the same job in parallel. Such plugins often assume that the outcome of the previous build is completely available, which is no longer true when we do concurrent builds.
To minimize the necessary code change for such plugins,
BuildStepimplementations can request Hudson to externally perform synchronization before executing them. This behavior is as follows:
BuildStepis only executed after the previous build is fully completed (thus fully restoring the earlier semantics of one build at a time.)
BuildStepis only executed after the same step in the previous build is completed. For build steps that use a weaker assumption and only rely on the output from the same build step of the early builds, this improves the concurrency.
No external synchronization is performed on this build step. This is the most efficient, and thus
the recommended value for newer plugins. Wherever necessary, you can directly use
CheckPoints to perform necessary synchronizations.
Migrating Older Implementations: If you are migrating
BuildStepimplementations written for earlier versions of Hudson, here's what you can do:
- To demand the backward compatible behavior from Jenkins, leave this method unoverridden, and make no other changes to the code. This will prevent users from reaping the benefits of concurrent builds, but at least your plugin will work correctly, and therefore this is a good easy first step.
If your build step doesn't use anything from a previous build (for example, if you don't even call
Run.getPreviousBuild()), then you can return
BuildStepMonitor.NONEwithout making further code changes and you are done with migration.
If your build step only depends on
Actions that you added in the previous build by yourself, then you only need
BuildStepMonitor.STEPscope synchronization. Return it from this method ,and you are done with migration without any further code changes.
If your build step makes more complex assumptions, return
CheckPoints directly in your code. The general idea is to call
CheckPoint.block()before you try to access the state from the previous build.
public void buildDependencyGraph(AbstractProject owner, DependencyGraph graph)Description copied from interface:
- Specified by:
owner- The project that owns the publishers, builders, etc. This information is conceptually redundant, as those objects are only configured against the single owner, but this information is nevertheless passed in since often owner information is not recorded. Never null.
graph- The dependency graph being built. Never null.