org.jenkinsci.modules.slave_installer

Class SlaveInstaller

java.lang.Object

org.jenkinsci.modules.slave_installer.SlaveInstaller

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

AbstractUnixSlaveInstaller

public abstract class SlaveInstaller
extends Object
implements Serializable

Represents platform-specific agent installation process. E.g. this class is being used in windows-slave-installer module to install an agent to the service wrapper

Author:

Kohsuke Kawaguchi

See Also:

SlaveInstallerFactory, Serialized Form

Constructor Summary

Constructors

Constructor and Description
SlaveInstaller()

Method Summary

Modifier and Type	Method and Description
abstract org.jvnet.localizer.Localizable	getConfirmationText() Possibly multi-line text that explains in more details what install(LaunchConfiguration,Prompter) would do.
String	getDisplayName() Short one-line human readable name of what this agent installer does.
abstract void	install(LaunchConfiguration params, Prompter prompter) Installs the agent as a service, quit the current JVM, and let the newly installed service spawns and connects as a Jenkins agent.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SlaveInstaller

public SlaveInstaller()

Method Detail

getDisplayName

public String getDisplayName()

Short one-line human readable name of what this agent installer does. This can be used as a GUI menu item, text in the button, etc, to have the user initiate the install(LaunchConfiguration,Prompter) call.

getConfirmationText

public abstract org.jvnet.localizer.Localizable getConfirmationText()

Possibly multi-line text that explains in more details what install(LaunchConfiguration,Prompter) would do. This message should be used by the caller to confirm the user's intention before actually executing install(LaunchConfiguration,Prompter). The text needs to be wrapped around 72 chars. No HTML is allowed.

install

public abstract void install(LaunchConfiguration params,
                             Prompter prompter)
                      throws InstallationException,
                             IOException,
                             InterruptedException

Installs the agent as a service, quit the current JVM, and let the newly installed service spawns and connects as a Jenkins agent. The JVM termination is tied to the installation as some service wrappers (such as launchd) cannot distinguish the service installation and launch.

Throws:

InstallationException

IOException

InterruptedException