Package org.jenkinsci.remoting.engine

Class JnlpProtocolHandlerFactory

java.lang.Object

org.jenkinsci.remoting.engine.JnlpProtocolHandlerFactory

public class JnlpProtocolHandlerFactory
extends Object

Builds a set of JnlpProtocolHandler instances from the supplied preconditions.

Since:

3.0

Constructor Summary

Constructors

Constructor	Description
JnlpProtocolHandlerFactory(ExecutorService threadPool)	Constructor.

Method Summary

Modifier and Type	Method	Description
List<JnlpProtocolHandler<? extends JnlpConnectionState>>	handlers()	Creates the list of JnlpProtocolHandler instances that are available with the current configuration.
JnlpProtocolHandlerFactory	withClientDatabase(JnlpClientDatabase clientDatabase)	Add a JnlpClientDatabase.
JnlpProtocolHandlerFactory	withIOHub(IOHub ioHub)	Add a IOHub.
JnlpProtocolHandlerFactory	withNioChannelHub(NioChannelHub nioChannelHub)	Add a NioChannelHub.
JnlpProtocolHandlerFactory	withPreferNonBlockingIO(boolean preferNio)	Set the I/O blocking mode preferences
JnlpProtocolHandlerFactory	withSSLClientAuthRequired(boolean needClientAuth)	Set the policy on client authentication certificates to use for JnlpProtocolHandler.handle(Socket, Map, List) calls.
JnlpProtocolHandlerFactory	withSSLContext(SSLContext context)	Add a SSLContext.

Methods inherited from class java.lang.Object

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

Constructor Details

JnlpProtocolHandlerFactory

public JnlpProtocolHandlerFactory(@NonNull
 ExecutorService threadPool)

Constructor.

Parameters:

threadPool - the thread pool to use.

Method Details

withNioChannelHub

public JnlpProtocolHandlerFactory withNioChannelHub(@CheckForNull
 NioChannelHub nioChannelHub)

Add a NioChannelHub.

Parameters:

nioChannelHub - the NioChannelHub.

Returns:

this for method chaining.

withIOHub

public JnlpProtocolHandlerFactory withIOHub(@CheckForNull
 IOHub ioHub)

Add a IOHub.

Parameters:

ioHub - the IOHub.

Returns:

this for method chaining.

withSSLContext

public JnlpProtocolHandlerFactory withSSLContext(@CheckForNull
 SSLContext context)

Add a SSLContext.

Parameters:

context - the SSLContext.

Returns:

this for method chaining.

withSSLClientAuthRequired

public JnlpProtocolHandlerFactory withSSLClientAuthRequired(boolean needClientAuth)

Set the policy on client authentication certificates to use for JnlpProtocolHandler.handle(Socket, Map, List) calls.

Parameters:

needClientAuth - true to reject connections over TLS where the client does not present a client certificate.

Returns:

this for method chaining.

withPreferNonBlockingIO

public JnlpProtocolHandlerFactory withPreferNonBlockingIO(boolean preferNio)

Set the I/O blocking mode preferences

Parameters:

preferNio - true to prefer using Non-Blocking I/O techniques, false to prefer thread-per-connection Blocking I/O.

Returns:

this for method chaining.

withClientDatabase

public JnlpProtocolHandlerFactory withClientDatabase(@CheckForNull
 JnlpClientDatabase clientDatabase)

Add a JnlpClientDatabase.

Parameters:

clientDatabase - the JnlpClientDatabase.

Returns:

this for method chaining.

handlers

@NonNull
public List<JnlpProtocolHandler<? extends JnlpConnectionState>> handlers()

Creates the list of JnlpProtocolHandler instances that are available with the current configuration.

Returns:

the JnlpProtocolHandler instances, may be empty, never null