File D:\maven-qcr-plugin-testsunitaires\qcr4java\jenkins-master\target\site\qc\core\src\main\java\hudson\WorkspaceSnapshot.java.html

1 /*
2 * The MIT License
3 *
4 * Copyright (c) 2004-2009, Sun Microsystems, Inc., Kohsuke Kawaguchi
5 *
6 * Permission is hereby granted, free of charge, to any person obtaining a copy
7 * of this software and associated documentation files (the "Software"), to deal
8 * in the Software without restriction, including without limitation the rights
9 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10 * copies of the Software, and to permit persons to whom the Software is
11 * furnished to do so, subject to the following conditions:
12 *
13 * The above copyright notice and this permission notice shall be included in
14 * all copies or substantial portions of the Software.
15 *
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
22 * THE SOFTWARE.
23 */
24 package hudson;
25
26 import hudson.model.Action;
27 import hudson.model.TaskListener;
28 import hudson.model.AbstractBuild;
29
30 import java.io.IOException;
31
32 /**
33 * Represents a workspace snapshot created by {@link FileSystemProvisioner}.
34 *
35 * <p>
36 * This class encapsulates a logic to use the snapshot elsewhere.
37 * The instance will be persisted with the {@link AbstractBuild} object
38 * as an {@link Action}.
39 *
40 * <p>
41 * TODO: how to garbage-collect this object, especially for zfs?
42 * perhaps when a new build is started?
43 *
44 * @see FileSystemProvisioner
45 * @author Kohsuke Kawaguchi
46 */
47 public abstract class WorkspaceSnapshot implements Action {
48 /**
49 * Restores the snapshot to the given file system location.
50 *
51 * @param owner
52 * The build that owns this action. It's always the same value for any given {@link WorkspaceSnapshot},
53 * but passed in separately so that implementations don't need to keep them in fields.
54 * @param dst
55 * The file path to which the snapshot shall be restored to.
56 * @param listener
57 * Send the progress of the restoration to this listener. Never null.
58 */
59 public abstract void restoreTo(AbstractBuild<?,?> owner, FilePath dst, TaskListener listener) throws IOException, InterruptedException;
60
61 public String getIconFileName() {
62 // by default, hide from the UI
63 return null;
64 }
65
66 public String getDisplayName() {
67 return "Workspace";
68 }
69
70 public String getUrlName() {
71 return "workspace";
72 }
73 }
74