Package org.jvnet.hudson.test

Class InboundAgentRule.Options.Builder

java.lang.Object

org.jvnet.hudson.test.InboundAgentRule.Options.Builder

Enclosing class:

InboundAgentRule.Options

public static final class InboundAgentRule.Options.Builder
extends Object

A builder of InboundAgentRule.Options.

Instances of InboundAgentRule.Options.Builder are created by calling InboundAgentRule.Options.newBuilder().

Method Summary

Modifier and Type	Method	Description
InboundAgentRule.Options	build()	Build and return an InboundAgentRule.Options.
InboundAgentRule.Options.Builder	cert(String cert)	Sets a custom certificate for the agent JVM, passed as the Remoting `-cert` CLI argument.
InboundAgentRule.Options.Builder	color(PrefixedOutputStream.AnsiColor color)	Set a color for agent logs.
InboundAgentRule.Options.Builder	javaOptions(String... opts)
InboundAgentRule.Options.Builder	label(String label)	Set a label for the agent.
InboundAgentRule.Options.Builder	name(String name)	Set the name of the agent.
InboundAgentRule.Options.Builder	noCertificateCheck()	Disables certificate verification for the agent JVM, passed as the Remoting `-noCertificateCheck` CLI argument.
InboundAgentRule.Options.Builder	secret()	Deprecated. secret is used by default when using newer versions of Remoting
InboundAgentRule.Options.Builder	skipStart()	Skip starting the agent.
InboundAgentRule.Options.Builder	trustStore(String path, String password)	Provide a custom truststore for the agent JVM.
InboundAgentRule.Options.Builder	tunnel(String tunnel)	Set a tunnel for the agent
InboundAgentRule.Options.Builder	webSocket()	Use WebSocket when connecting.
InboundAgentRule.Options.Builder	webSocket(boolean websocket)	Configure usage of WebSocket when connecting.
InboundAgentRule.Options.Builder	withLogger(Class<?> clazz, Level level)
InboundAgentRule.Options.Builder	withLogger(String logger, Level level)
InboundAgentRule.Options.Builder	withPackageLogger(Class<?> clazz, Level level)

Methods inherited from class java.lang.Object

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

Method Details

name

public InboundAgentRule.Options.Builder name(String name)

Set the name of the agent.

Parameters:

name - the name

Returns:

this builder

color

public InboundAgentRule.Options.Builder color(PrefixedOutputStream.AnsiColor color)

Set a color for agent logs.

Parameters:

color - the color

Returns:

this builder

secret

@Deprecated
public InboundAgentRule.Options.Builder secret()

Deprecated.

secret is used by default when using newer versions of Remoting

Use secret when connecting.

Returns:

this builder

webSocket

public InboundAgentRule.Options.Builder webSocket()

Use WebSocket when connecting.

Returns:

this builder

webSocket

public InboundAgentRule.Options.Builder webSocket(boolean websocket)

Configure usage of WebSocket when connecting.

Parameters:

websocket - use websocket if true, otherwise use inbound TCP

Returns:

this builder

tunnel

public InboundAgentRule.Options.Builder tunnel(String tunnel)

Set a tunnel for the agent

Returns:

this builder

javaOptions

public InboundAgentRule.Options.Builder javaOptions(String... opts)

trustStore

public InboundAgentRule.Options.Builder trustStore(String path,
 String password)

Provide a custom truststore for the agent JVM. Can be useful when using a setup with a reverse proxy.

Parameters:

path - the path to the truststore

password - the password for the truststore

Returns:

this builder

cert

public InboundAgentRule.Options.Builder cert(String cert)

Sets a custom certificate for the agent JVM, passed as the Remoting `-cert` CLI argument. When using RealJenkinsRule, use RealJenkinsRule.getRootCAPem() to obtain the required value to pass to this method.

Parameters:

cert - the certificate to use

Returns:

this builder

noCertificateCheck

public InboundAgentRule.Options.Builder noCertificateCheck()

Disables certificate verification for the agent JVM, passed as the Remoting `-noCertificateCheck` CLI argument.

Returns:

this builder

skipStart

public InboundAgentRule.Options.Builder skipStart()

Skip starting the agent.

Returns:

this builder

label

public InboundAgentRule.Options.Builder label(String label)

Set a label for the agent.

Returns:

this builder.

withLogger

public InboundAgentRule.Options.Builder withLogger(Class<?> clazz,
 Level level)

withPackageLogger

public InboundAgentRule.Options.Builder withPackageLogger(Class<?> clazz,
 Level level)

withLogger

public InboundAgentRule.Options.Builder withLogger(String logger,
 Level level)

build

public InboundAgentRule.Options build()

Build and return an InboundAgentRule.Options.

Returns:

a new InboundAgentRule.Options