Package org.jenkinsci.remoting.engine

Class JnlpProtocol4Handler

java.lang.Object

org.jenkinsci.remoting.engine.JnlpProtocolHandler<Jnlp4ConnectionState>

org.jenkinsci.remoting.engine.JnlpProtocol4Handler

public class JnlpProtocol4Handler
extends JnlpProtocolHandler<Jnlp4ConnectionState>

Implements the JNLP4-connect protocol. This protocol uses SSLEngine to perform a TLS upgrade of the plaintext connection before any connection secrets are exchanged. The subsequent connection is then secured using TLS. The implementation uses the IOHub for non-blocking I/O wherever possible which removes the bottleneck of the selector thread being used for linearization and I/O that creates a throughput limit with NioChannelHub.

Since:

3.0

Constructor Summary

Constructors

Constructor	Description
JnlpProtocol4Handler(JnlpClientDatabase clientDatabase, ExecutorService threadPool, IOHub ioHub, SSLContext context, boolean needClientAuth, boolean preferNio)	Constructor.

Method Summary

Modifier and Type	Method	Description
Future<Channel>	connect(Socket socket, Map<String,String> headers, List<? extends JnlpConnectionStateListener> listeners)	Handles an outgoing connection to the server on the supplied socket.
Jnlp4ConnectionState	createConnectionState(Socket socket, List<? extends JnlpConnectionStateListener> listeners)	Creates the JnlpConnectionState instance for this JnlpProtocolHandler.
String	getName()	Get the name of the protocol.
Future<Channel>	handle(Socket socket, Map<String,String> headers, List<? extends JnlpConnectionStateListener> listeners)	Handles an incoming client connection on the supplied socket.

Methods inherited from class org.jenkinsci.remoting.engine.JnlpProtocolHandler

connect, getClientDatabase, handle, isEnabled, isPreferNio

Methods inherited from class java.lang.Object

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

Constructor Detail

JnlpProtocol4Handler

public JnlpProtocol4Handler(@Nullable
                            JnlpClientDatabase clientDatabase,
                            @NonNull
                            ExecutorService threadPool,
                            @NonNull
                            IOHub ioHub,
                            @NonNull
                            SSLContext context,
                            boolean needClientAuth,
                            boolean preferNio)

Constructor.

Parameters:

clientDatabase - the client database.

threadPool - the thread pool.

ioHub - the IOHub.

context - the SSLContext.

needClientAuth - to force all clients to have a client certificate in order to connect.

preferNio - true means that the protocol should attempt to use NIO if possible.

Method Detail

getName

public String getName()

Get the name of the protocol.

Specified by:

getName in class JnlpProtocolHandler<Jnlp4ConnectionState>

createConnectionState

@NonNull
public Jnlp4ConnectionState createConnectionState(@NonNull
                                                  Socket socket,
                                                  @NonNull
                                                  List<? extends JnlpConnectionStateListener> listeners)

Description copied from class: JnlpProtocolHandler

Creates the JnlpConnectionState instance for this JnlpProtocolHandler.

Specified by:

createConnectionState in class JnlpProtocolHandler<Jnlp4ConnectionState>

Parameters:

socket - the Socket

listeners - the initial JnlpConnectionStateListener instances.

Returns:

the JnlpConnectionState for this connection.

handle

@NonNull
public Future<Channel> handle(@NonNull
                              Socket socket,
                              @NonNull
                              Map<String,String> headers,
                              @NonNull
                              List<? extends JnlpConnectionStateListener> listeners)
                       throws IOException

Handles an incoming client connection on the supplied socket.

Specified by:

handle in class JnlpProtocolHandler<Jnlp4ConnectionState>

Parameters:

socket - the socket.

headers - the headers to send to the client.

listeners - the listeners to process the connection.

Returns:

a Future for the Channel to the server.

Throws:

IOException - if the protocol cannot be initiated.

connect

@NonNull
public Future<Channel> connect(@NonNull
                               Socket socket,
                               @NonNull
                               Map<String,String> headers,
                               @NonNull
                               List<? extends JnlpConnectionStateListener> listeners)
                        throws IOException

Handles an outgoing connection to the server on the supplied socket.

Specified by:

connect in class JnlpProtocolHandler<Jnlp4ConnectionState>

Parameters:

socket - the socket.

headers - the headers to send to the server.

listeners - the listeners to process the connection.

Returns:

a Future for the Channel to the server.

Throws:

IOException - if the protocol cannot be initiated.