hudson.FileSystemProvisionerDescriptor Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of hudson-core Show documentation
Contains the core Hudson code and view files to render HTML.
The newest version!
/*******************************************************************************
 *
 * Copyright (c) 2004-2009 Oracle Corporation.
 *
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors: 
*
*    Kohsuke Kawaguchi
 *     
 *
 *******************************************************************************/ 

package hudson;

import hudson.model.Descriptor;
import hudson.model.TaskListener;

import java.io.IOException;

/**
 * {@link Descriptor} for {@link FileSystemProvisioner}.
 *
 * @author Kohsuke Kawaguchi
 */
public abstract class FileSystemProvisionerDescriptor extends Descriptor implements ExtensionPoint {
    /**
     * Called to clean up a workspace that may potentially belong to this {@link FileSystemProvisioner}.
     *
     * 
     * Because users may modify the file system behind Hudson, and slaves may come and go when
     * configuration changes hapen, in general case Hudson is unable to keep track of which jobs
     * have workspaces in which slaves.
     *
     * 

     * So instead we rey on a garbage collection mechanism, to look at workspaces left in the file system
     * without the contextual information of the owner project, and try to clean that up.
     *
     * 

     * This method is called to do this, after Hudson determines that the workspace should be deleted
     * to reclaim disk space. The implementation of this method is expected to sniff the contents of
     * the workspace, and if it looks like the one created by {@link FileSystemProvisioner#prepareWorkspace(AbstractBuild, FilePath, TaskListener)},
     * perform the necessary deletion operation, and return true.
     *
     * 
     * If the workspace isn't the one created by this {@link FileSystemProvisioner}, or if the
     * workspace can be simply deleted by {@link FilePath#deleteRecursive()}, then simply
     * return false to give other {@link FileSystemProvisionerDescriptor}s a chance to
     * discard them.
     *
     * @param ws
     *      The workspace directory to be removed.
     * @param listener
     *      The status of the operation, error message, etc., should go here.
     * @return
     *      true if this {@link FileSystemProvisionerDescriptor} is responsible for de-alocating the workspace.
     *      false otherwise, in which case the other {@link FileSystemProvisionerDescriptor}s are asked to
     *      clean up the workspace.
     */
    public abstract boolean discard(FilePath ws, TaskListener listener) throws IOException, InterruptedException;
}