Package hudson.tasks

Class BuildWrapper

  • All Implemented Interfaces:
    ExtensionPoint, Describable<BuildWrapper>
    Direct Known Subclasses:
    SimpleBuildWrapper

    public abstract class BuildWrapper
    extends AbstractDescribableImpl<BuildWrapper>
    implements ExtensionPoint
    Pluggability point for performing pre/post actions for the build process.

    This extension point enables a plugin to set up / tear down additional services needed to perform a build, such as setting up local X display, or launching and stopping application servers for testing.

    An instance of BuildWrapper is associated with a Project with configuration information as its state. An instance is persisted along with Project.

    BuildWrappers are instantiated when the user saves the job configuration, and sticks around in memory until the job configuration is overwritten.

    The setUp(Build,Launcher,BuildListener) method is invoked for each build.

    BuildWrapper requires an user consent (in terms of a checkbox) to work. If this is not desirable, see Environment for other ways to inject Environments to builds.

    Author:
    Kohsuke Kawaguchi