org.jenkinsci.modules.slave_installer

Class LaunchConfiguration

java.lang.Object

org.jenkinsci.modules.slave_installer.LaunchConfiguration

public abstract class LaunchConfiguration
extends Object

Encapsulates what to launch from the service wrapper.

Author:

Kohsuke Kawaguchi

Constructor Summary

Constructors

Constructor and Description
LaunchConfiguration()

Method Summary

Methods

Modifier and Type	Method and Description
abstract hudson.util.ArgumentListBuilder	buildRunnerArguments() Decides the arguments to the jar file to be started by the service wrapper.
abstract File	getJarFile() Decides the jar file to be launched from the service wrapper.
URL	getLatestJarURL() If the up-to-date copy of the jar file returned from getJarFile() is available on Jenkins, return its URL.
abstract File	getStorage() To install an agent on a system, sometimes the installer needs to place some files (including configuration files, binaries, etc.)

Methods inherited from class java.lang.Object

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

Constructor Detail

LaunchConfiguration

public LaunchConfiguration()

Method Detail

getStorage

public abstract File getStorage()
                         throws IOException

To install an agent on a system, sometimes the installer needs to place some files (including configuration files, binaries, etc.)

Sometimes, the platform has directories designed for services by convention (such as /System/Library/LaunchDaemon for launchd or /etc/default/jenkins-slave on Linux), but in other OSes there's no such conventional location (for example on Windows.)

Because of this, the caller will provide a directory that allows installer to place some files. The installer is encourage to use platform dependent conventional locations over this storage area. Typically, this is the remote file system root of the agent.

Throws:

IOException

getJarFile

public abstract File getJarFile()
                         throws IOException

Decides the jar file to be launched from the service wrapper. The file will be copied into another safe location before getting registered.

Throws:

IOException

getLatestJarURL

public URL getLatestJarURL()
                    throws IOException

If the up-to-date copy of the jar file returned from getJarFile() is available on Jenkins, return its URL. Installed services will try to download this URL and overwrites the local copy before launching it, thereby automating the update.

To allow administrators to pin down specific version of the jar and disable audo-update, SlaveInstallers are encouraged to check File.canWrite() and skip the download process.

Throws:

IOException

Since:

1.4

buildRunnerArguments

public abstract hudson.util.ArgumentListBuilder buildRunnerArguments()

Decides the arguments to the jar file to be started by the service wrapper.