org.jenkinsci.remoting.engine

Class JnlpProtocol1Handler

java.lang.Object

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

org.jenkinsci.remoting.engine.JnlpProtocol1Handler

Deprecated.

Replaced by JNLP4

@Deprecated
public class JnlpProtocol1Handler
extends JnlpProtocolHandler<STATE>

Implementation of the JNLP-connect protocol. The slave sends the master the slave name it wants to register as and the computed HMAC of the slave name. If accepted the master will reply with a confirmation response. This was the first protocol supported by Jenkins. JNLP slaves will use this as a last resort when connecting to old versions of Jenkins masters.

Since:

3.0

See Also:

JnlpProtocol4Handler

Field Summary

Fields

Modifier and Type	Field and Description
static String	GREETING_SUCCESS The expected response from the master on successful completion of the handshake.

Constructor Summary

Constructors

Constructor and Description
JnlpProtocol1Handler(JnlpClientDatabase clientDatabase, ExecutorService threadPool, NioChannelHub hub, boolean preferNio) Deprecated. Constructor.

Method Summary

Modifier and Type	Method and 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.
LegacyJnlpConnectionState	createConnectionState(Socket socket, List<? extends JnlpConnectionStateListener> listeners) Deprecated. Creates the JnlpConnectionState instance for this JnlpProtocolHandler.
String	getName() Deprecated. 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

Field Detail

GREETING_SUCCESS

public static final String GREETING_SUCCESS

The expected response from the master on successful completion of the handshake.

See Also:

Constant Field Values

Constructor Detail

JnlpProtocol1Handler

public JnlpProtocol1Handler(@Nullable
                            JnlpClientDatabase clientDatabase,
                            @Nonnull
                            ExecutorService threadPool,
                            @Nullable
                            NioChannelHub hub,
                            boolean preferNio)

Deprecated.

Constructor.

Parameters:

clientDatabase - the client database to use or null if client connections will not be required.

threadPool - the ExecutorService to run tasks on.

hub - the NioChannelHub to use or null to use blocking I/O.

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

Method Detail

getName

public String getName()

Deprecated.

Get the name of the protocol.

Specified by:

getName in class JnlpProtocolHandler<LegacyJnlpConnectionState>

createConnectionState

@Nonnull
public LegacyJnlpConnectionState createConnectionState(@Nonnull
                                                                Socket socket,
                                                                @Nonnull
                                                                List<? extends JnlpConnectionStateListener> listeners)
                                                         throws IOException

Deprecated.

Creates the JnlpConnectionState instance for this JnlpProtocolHandler.

Parameters:

socket - the Socket

listeners - the initial JnlpConnectionStateListener instances.

Returns:

the JnlpConnectionState for this connection.

Throws:

IOException - if something goes wrong.

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<STATE extends LegacyJnlpConnectionState>

Parameters:

socket - the socket.

headers - the headers to send.

listeners - the listeners to approve and receive 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<STATE extends LegacyJnlpConnectionState>

Parameters:

socket - the socket.

headers - the headers to send.

listeners - the listeners to approve and receive the connection.

Returns:

a Future for the Channel to the server.

Throws:

IOException - if the protocol cannot be initiated.