Package hudson.remoting

Class Launcher

java.lang.Object

hudson.remoting.Launcher

public class Launcher
extends Object

Entry point for running a Channel. This is the main method of the agent JVM.

This class also defines several methods for starting a channel on a fresh JVM.

Author:

Kohsuke Kawaguchi

Field Summary

Fields

Modifier and Type	Field	Description
String	agentJnlpCredentials
URL	agentJnlpURL
File	agentLog	Specifies a destination for error logs.
String	auth
List<String>	candidateCertificates
InetSocketAddress	connectionTarget
boolean	failIfWorkDirIsMissing	Fail the initialization if the workDir or internalDir are missing.
String	internalDir	Specifies a directory within workDir, which stores all the remoting-internal files.
File	jarCache
File	loggingConfigFilePath	Specified location of the property file with JUL settings.
Channel.Mode	mode
boolean	noKeepAlive
boolean	noReconnect
boolean	ping
String	proxyCredentials
String	secret
boolean	showHelp	Shows help message and then exits
boolean	showVersion	Shows version information and then exits
File	tcpPortFile
static String	VERSION	Version number of Hudson this agent.jar is from.
File	workDir	Specifies a default working directory of the remoting instance.

Constructor Summary

Constructors

Constructor	Description
Launcher()

Method Summary

Modifier and Type	Method	Description
void	addClasspath(String pathList)
static String	getCommunicationProtocolName()	Get the name of the communication protocol used in the Launcher.
static boolean	isWindows()
static void	main(InputStream is, OutputStream os)
static void	main(InputStream is, OutputStream os, Channel.Mode mode)
static void	main(InputStream is, OutputStream os, Channel.Mode mode, boolean performPing)	Deprecated. Use main(InputStream, OutputStream, Mode, boolean, JarCache)
static void	main(InputStream is, OutputStream os, Channel.Mode mode, boolean performPing, JarCache cache)
static void	main(String... args)
List<String>	parseJnlpArguments()	Parses the connection arguments from JNLP file given in the URL.
void	run()
void	setConnectTo(String target)
void	setNoCertificateCheck(boolean ignored)	Bypass HTTPS security check by using free-for-all trust manager.
void	setTextMode(boolean b)

Methods inherited from class java.lang.Object

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

Field Detail

mode

public Channel.Mode mode

ping

public boolean ping

agentLog

@CheckForNull
public File agentLog

Specifies a destination for error logs. If specified, this option overrides the default destination within workDir. If both this options and workDir is not set, the log will not be generated.

agentJnlpURL

public URL agentJnlpURL

agentJnlpCredentials

public String agentJnlpCredentials

secret

public String secret

proxyCredentials

public String proxyCredentials

tcpPortFile

public File tcpPortFile

auth

public String auth

jarCache

@CheckForNull
public File jarCache

Since:

2.24

loggingConfigFilePath

@CheckForNull
public File loggingConfigFilePath

Specified location of the property file with JUL settings.

Since:

3.8

candidateCertificates

public List<String> candidateCertificates

connectionTarget

public InetSocketAddress connectionTarget

noReconnect

public boolean noReconnect

noKeepAlive

public boolean noKeepAlive

workDir

@CheckForNull
public File workDir

Specifies a default working directory of the remoting instance. If specified, this directory will be used to store logs, JAR cache, etc.

In order to retain compatibility, the option is disabled by default.

Jenkins specifics: This working directory is expected to be equal to the agent root specified in Jenkins configuration.

Since:

3.8

internalDir

@NonNull
public String internalDir

Specifies a directory within workDir, which stores all the remoting-internal files.

This option is not expected to be used frequently, but it allows remoting users to specify a custom storage directory if the default remoting directory is consumed by other stuff.

Since:

3.8

failIfWorkDirIsMissing

public boolean failIfWorkDirIsMissing

Fail the initialization if the workDir or internalDir are missing. This option presumes that the workspace structure gets initialized previously in order to ensure that we do not start up with a borked instance (e.g. if a filesystem mount gets disconnected).

Since:

3.8

showHelp

public boolean showHelp

Shows help message and then exits

Since:

3.36

showVersion

public boolean showVersion

Shows version information and then exits

Since:

3.36

VERSION

public static final String VERSION

Version number of Hudson this agent.jar is from.

Constructor Detail

Launcher

public Launcher()

Method Detail

setTextMode

public void setTextMode(boolean b)

addClasspath

public void addClasspath(String pathList)
                  throws Exception

Throws:

Exception

setConnectTo

public void setConnectTo(String target)

setNoCertificateCheck

public void setNoCertificateCheck(boolean ignored)
                           throws NoSuchAlgorithmException,
                                  KeyManagementException

Bypass HTTPS security check by using free-for-all trust manager.

Parameters:

ignored - This is ignored.

Throws:

NoSuchAlgorithmException

KeyManagementException

main

public static void main(String... args)
                 throws Exception

Throws:

Exception

run

public void run()
         throws Exception

Throws:

Exception

parseJnlpArguments

public List<String> parseJnlpArguments()
                                throws ParserConfigurationException,
                                       SAXException,
                                       IOException,
                                       InterruptedException

Parses the connection arguments from JNLP file given in the URL.

Throws:

ParserConfigurationException

SAXException

IOException

InterruptedException

main

public static void main(InputStream is,
                        OutputStream os)
                 throws IOException,
                        InterruptedException

Throws:

IOException

InterruptedException

main

public static void main(InputStream is,
                        OutputStream os,
                        Channel.Mode mode)
                 throws IOException,
                        InterruptedException

Throws:

IOException

InterruptedException

main

@Deprecated
public static void main(InputStream is,
                        OutputStream os,
                        Channel.Mode mode,
                        boolean performPing)
                 throws IOException,
                        InterruptedException

Deprecated.

Use main(InputStream, OutputStream, Mode, boolean, JarCache)

Throws:

IOException

InterruptedException

main

public static void main(InputStream is,
                        OutputStream os,
                        Channel.Mode mode,
                        boolean performPing,
                        @CheckForNull
                        JarCache cache)
                 throws IOException,
                        InterruptedException

Parameters:

cache - JAR cache to be used. If null, a default value will be used.

Throws:

IOException

InterruptedException

Since:

2.24

isWindows

public static boolean isWindows()

getCommunicationProtocolName

public static String getCommunicationProtocolName()

Get the name of the communication protocol used in the Launcher. When the channel is established by an Engine instance (that is, using JNLP), use Engine.getProtocolName() instead.

Returns:

the communication protocol name.

Since:

4.8