hudson.scm.IntegrityDeleteNonMembersAction Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of integrity-plugin Show documentation
PTC Integrity - Hudson Plugin
The newest version!
package hudson.scm;

import hudson.Extension;
import hudson.Launcher;
import hudson.model.BuildListener;
import hudson.model.AbstractBuild;
import hudson.model.AbstractProject;
import hudson.model.Hudson;
import hudson.tasks.BuildStepDescriptor;
import hudson.tasks.BuildStepMonitor;
import hudson.tasks.Notifier;
import hudson.tasks.Publisher;

import java.io.IOException;
import java.io.Serializable;

import net.sf.json.JSONObject;

import org.kohsuke.stapler.StaplerRequest;

public class IntegrityDeleteNonMembersAction extends Notifier implements Serializable
{
	private static final long serialVersionUID = 654691931521381720L;
	
	@Extension
    public static final IntegrityDeleteNonMembersDescriptorImpl DELETENONMEMBERS_DESCRIPTOR = new IntegrityDeleteNonMembersDescriptorImpl();


    /**
     * Obtains the root project for the build
     * @param abstractProject
     * @return
     */
    private AbstractProject getRootProject(AbstractProject abstractProject)
    {
        if (abstractProject.getParent() instanceof Hudson)
        {
            return abstractProject;
        }
        else
        {
            return getRootProject((AbstractProject) abstractProject.getParent());
        }
    }
    
    /**
     * Executes the actual Integrity Delete Non Members operation
     */
    public boolean perform(AbstractBuild build, Launcher launcher, BuildListener listener) throws InterruptedException, IOException
    {
        AbstractProject rootProject = getRootProject(build.getProject());

        if (!(rootProject.getScm() instanceof IntegritySCM))
        {
            listener.getLogger().println("Integrity DeleteNonMembers is being executed for an invalid context!  Current SCM is " + rootProject.getScm() + "!");
            return true;
        }

        IntegritySCM scm = IntegritySCM.class.cast(rootProject.getScm());
        IntegrityDeleteNonMembersTask deleteNonMembers = new IntegrityDeleteNonMembersTask(build, listener,  scm.getAlternateWorkspace(), scm.getIntegrityProject());
        if (!build.getWorkspace().act(deleteNonMembers))
        {
            return false;
        }

        return true;
    }

    /**
     * Returns the build step we're monitoring
     */
    public BuildStepMonitor getRequiredMonitorService()
    {
        return BuildStepMonitor.BUILD;
    }

    @Override
    public BuildStepDescriptor getDescriptor()
    {
        return DELETENONMEMBERS_DESCRIPTOR;
    }

    @Override
    public boolean needsToRunAfterFinalized()
    {
        return false;
    }

    /**
     * The relationship of Descriptor and IntegrityDeleteNonMembersAction (the describable) is akin to class and object.
     * This means the descriptor is used to create instances of the describable.
     * Usually the Descriptor is an internal class in the IntegrityDeleteNonMembersAction class named DescriptorImpl. 
     */
    public static class IntegrityDeleteNonMembersDescriptorImpl extends BuildStepDescriptor 
    {

        @Override
        public boolean isApplicable(@SuppressWarnings("rawtypes") Class jobType)
        {
            return true;
        }

        @Override
        public String getDisplayName()
        {
            return "Integrity - Delete Non Members";
        }
        
        @Override
        public Publisher newInstance(StaplerRequest req, JSONObject formData) throws FormException
        {
            return new IntegrityDeleteNonMembersAction();
        }
    }
}