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

1 /*
2 * The MIT License
3 *
4 * Copyright (c) 2010, InfraDNA, 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.slaves;
25
26 import hudson.ExtensionPoint;
27 import hudson.model.AbstractDescribableImpl;
28 import hudson.model.TaskListener;
29
30 import java.io.IOException;
31 import javax.annotation.Nonnull;
32
33 /**
34 * Factory of {@link ComputerLauncher}.
35 *
36 * When writing a {@link Cloud} implementation, one needs to dynamically create {@link ComputerLauncher}
37 * by supplying a host name. This is the abstraction for that.
38 *
39 * @author Kohsuke Kawaguchi
40 * @since 1.383
41 * @see ComputerLauncher
42 */
43 public abstract class ComputerConnector extends AbstractDescribableImpl<ComputerConnector> implements ExtensionPoint {
44 /**
45 * Creates a {@link ComputerLauncher} for connecting to the given host.
46 *
47 * @param host
48 * The host name / IP address of the machine to connect to.
49 * @param listener
50 * If
51 */
52 public abstract ComputerLauncher launch(@Nonnull String host, TaskListener listener) throws IOException, InterruptedException;
53
54 @Override
55 public ComputerConnectorDescriptor getDescriptor() {
56 return (ComputerConnectorDescriptor)super.getDescriptor();
57 }
58 }
59