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

1 /*
2 * The MIT License
3 *
4 * Copyright (c) 2004-2009, Sun Microsystems, Inc.
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.model;
25
26 import hudson.Extension;
27 import hudson.ExtensionList;
28 import hudson.ExtensionPoint;
29 import hudson.tasks.BuildStep;
30 import jenkins.model.Jenkins;
31
32 import java.util.Collection;
33
34 /**
35 * Extension point for inserting transient {@link Action}s into {@link AbstractProject}s.
36 *
37 * <p>
38 * Actions of projects are primarily determined by {@link BuildStep}s that are associated by configurations,
39 * but sometimes it's convenient to be able to add actions across all or many projects, without being invoked
40 * through configuration. This extension point provides such a mechanism.
41 *
42 * Actions of {@link AbstractProject}s are transient &mdash; they will not be persisted, and each time Hudson starts
43 * or the configuration of the job changes, they'll be recreated. Therefore, to maintain persistent data
44 * per project, you'll need to do data serialization by yourself. Do so by storing a file
45 * under {@link AbstractProject#getRootDir()}.
46 *
47 * <p>
48 * To register your implementation, put {@link Extension} on your subtype.
49 *
50 * @author Kohsuke Kawaguchi
51 * @since 1.327
52 * @see Action
53 */
54 public abstract class TransientProjectActionFactory implements ExtensionPoint {
55 /**
56 * Creates actions for the given project.
57 *
58 * @param target
59 * The project for which the action objects are requested. Never null.
60 * @return
61 * Can be empty but must not be null.
62 */
63 public abstract Collection<? extends Action> createFor(AbstractProject target);
64
65 /**
66 * Returns all the registered {@link TransientProjectActionFactory}s.
67 */
68 public static ExtensionList<TransientProjectActionFactory> all() {
69 return Jenkins.getInstance().getExtensionList(TransientProjectActionFactory.class);
70 }
71 }
72