org.jenkinsci.modules.windows_slave_installer

Class WindowsSlaveInstaller

java.lang.Object

org.jenkinsci.modules.slave_installer.SlaveInstaller

org.jenkinsci.modules.windows_slave_installer.WindowsSlaveInstaller

All Implemented Interfaces:

Serializable

public class WindowsSlaveInstaller
extends org.jenkinsci.modules.slave_installer.SlaveInstaller

Installs agent as a Windows service. The installer uses WinSW as a service wrapper.

Author:

Kohsuke Kawaguchi

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
WindowsSlaveInstaller()

Method Summary

Modifier and Type	Method and Description
static String	generateServiceId(String slaveRoot)
static String	generateSlaveXml(String id, String java, String vmargs, String args) Deprecated. Use generateSlaveXml(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.util.Map)
static String	generateSlaveXml(String id, String java, String vmargs, String args, Map<String,String> extraMacroValues) Generates WinSW configuration for the agent.
org.jvnet.localizer.Localizable	getConfirmationText()
void	install(org.jenkinsci.modules.slave_installer.LaunchConfiguration params, org.jenkinsci.modules.slave_installer.Prompter prompter)

Methods inherited from class org.jenkinsci.modules.slave_installer.SlaveInstaller

getDisplayName

Methods inherited from class java.lang.Object

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

Constructor Detail

WindowsSlaveInstaller

public WindowsSlaveInstaller()

Method Detail

getConfirmationText

public org.jvnet.localizer.Localizable getConfirmationText()

Specified by:

getConfirmationText in class org.jenkinsci.modules.slave_installer.SlaveInstaller

install

public void install(org.jenkinsci.modules.slave_installer.LaunchConfiguration params,
                    org.jenkinsci.modules.slave_installer.Prompter prompter)
             throws org.jenkinsci.modules.slave_installer.InstallationException,
                    IOException,
                    InterruptedException

Specified by:

install in class org.jenkinsci.modules.slave_installer.SlaveInstaller

Throws:

org.jenkinsci.modules.slave_installer.InstallationException

IOException

InterruptedException

generateServiceId

public static String generateServiceId(String slaveRoot)
                                throws IOException

Throws:

IOException

generateSlaveXml

@Deprecated
public static String generateSlaveXml(String id,
                                                   String java,
                                                   String vmargs,
                                                   String args)
                                            throws IOException

Deprecated. Use generateSlaveXml(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.util.Map)

Throws:

IOException

generateSlaveXml

public static String generateSlaveXml(String id,
                                      String java,
                                      String vmargs,
                                      String args,
                                      @Nonnull
                                      Map<String,String> extraMacroValues)
                               throws IOException

Generates WinSW configuration for the agent. This method takes a template from the resources and injects macro values there. Macro values can be contributed by extraMacroValues or by MacroValueProviders.

Parameters:

id - Service Id

java - Path to Java

vmargs - JVM args arguments to be passed

args - slave.jar arguments to be passed

extraMacroValues - Additional macro values to be injected. The list of required macros is provided in ADDITIONAL_REQUIRED_MACROS. If the macro value is not provided, the implementation will look up for the default value in available MacroValueProviders.

Returns:

Generated WinSW configuration file.

Throws:

IOException - The file cannot be generated or if not all macro variables can be resolved

Since:

TODO