hudson.slaves.ComputerLauncher 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, Stephen Connolly
 *
 *
 *******************************************************************************/ 

package hudson.slaves;

import hudson.ExtensionPoint;
import hudson.Extension;
import hudson.model.*;
import hudson.util.DescriptorList;
import hudson.util.StreamTaskListener;

import java.io.IOException;

/**
 * Extension point to allow control over how {@link Computer}s are "launched",
 * meaning how they get connected to their slave agent program.
 *
 * Associated View
  main.jelly
  This page will be
 * rendered into the top page of the computer (/computer/NAME/) Useful for
 * showing launch related commands and status reports. 
 *
 * @author Stephen Connolly
 * @since 24-Apr-2008 22:12:35
 * @see ComputerConnector
 */
public abstract class ComputerLauncher extends AbstractDescribableImpl implements ExtensionPoint {

    /**
     * Returns true if this {@link ComputerLauncher} supports programatic launch
     * of the slave agent in the target {@link Computer}.
     */
    public boolean isLaunchSupported() {
        return true;
    }

    /**
     * Launches the slave agent for the given {@link Computer}.
     *
     *  If the slave agent is launched successfully,
     * {@link SlaveComputer#setChannel(java.io.InputStream, java.io.OutputStream, TaskListener, hudson.remoting.Channel.Listener)}
     * should be invoked in the end to notify Hudson of the established
     * connection. The operation could also fail, in which case there's no need
     * to make any callback notification, (except to notify the user of the
     * failure through {@link StreamTaskListener}.)
     *
     * 
 This method must operate synchronously. Asynchrony is provided by
     * {@link Computer#connect(boolean)} and its correct operation depends on
     * this.
     *
     * @param listener The progress of the launch, as well as any error, should
     * be sent to this listener.
     *
     * @throws IOException if the method throws an {@link IOException} or
     * {@link InterruptedException}, the launch was considered a failure and the
     * stack trace is reported into the listener. This handling is just so that
     * the implementation of this method doesn't have to dilligently catch those
     * exceptions.
     */
    public void launch(SlaveComputer computer, TaskListener listener) throws IOException, InterruptedException {
        // to remain compatible with the legacy implementation that overrides the old signature
        launch(computer, cast(listener));
    }

    /**
     * @deprecated as of 1.304 Use {@link #launch(SlaveComputer, TaskListener)}
     */
    public void launch(SlaveComputer computer, StreamTaskListener listener) throws IOException, InterruptedException {
        throw new UnsupportedOperationException(getClass() + " must implement the launch method");
    }

    /**
     * Allows the {@link ComputerLauncher} to tidy-up after a disconnect.
     *
     * 
 This method is invoked after the {@link Channel} to this computer is
     * terminated.
     *
     * 
 Disconnect operation is performed asynchronously, so there's no
     * guarantee that the corresponding {@link SlaveComputer} exists for the
     * duration of the operation.
     */
    public void afterDisconnect(SlaveComputer computer, TaskListener listener) {
        // to remain compatible with the legacy implementation that overrides the old signature
        afterDisconnect(computer, cast(listener));
    }

    /**
     * @deprecated as of 1.304 Use
     * {@link #afterDisconnect(SlaveComputer, TaskListener)}
     */
    public void afterDisconnect(SlaveComputer computer, StreamTaskListener listener) {
    }

    /**
     * Allows the {@link ComputerLauncher} to prepare for a disconnect.
     *
     * 
 This method is invoked before the {@link Channel} to this computer is
     * terminated, thus the channel is still accessible from
     * {@link SlaveComputer#getChannel()}. If the channel is terminated
     * unexpectedly, this method will not be invoked, as the channel is already
     * gone.
     *
     *  Disconnect operation is performed asynchronously, so there's no
     * guarantee that the corresponding {@link SlaveComputer} exists for the
     * duration of the operation.
     */
    public void beforeDisconnect(SlaveComputer computer, TaskListener listener) {
        // to remain compatible with the legacy implementation that overrides the old signature
        beforeDisconnect(computer, cast(listener));
    }

    /**
     * @deprecated as of 1.304 Use
     * {@link #beforeDisconnect(SlaveComputer, TaskListener)}
     */
    public void beforeDisconnect(SlaveComputer computer, StreamTaskListener listener) {
    }

    private StreamTaskListener cast(TaskListener listener) {
        if (listener instanceof StreamTaskListener) {
            return (StreamTaskListener) listener;
        }
        return new StreamTaskListener(listener.getLogger());
    }
    /**
     * All registered {@link ComputerLauncher} implementations.
     *
     * @deprecated as of 1.281 Use {@link Extension} for registration, and use
     * {@link Hudson#getDescriptorList(Class)} for read access.
     */
    public static final DescriptorList LIST = new DescriptorList(ComputerLauncher.class);
}