Package org.jenkinsci.remoting.engine

Class JnlpProtocol4ProxyHandler

java.lang.Object

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

org.jenkinsci.remoting.engine.JnlpProtocol4ProxyHandler

public final class JnlpProtocol4ProxyHandler
extends JnlpProtocolHandler<JnlpConnectionState>

Passes JnlpConnectionState.CLIENT_NAME_KEY using an HTTP-style header and lets the server decide how to handle that.

Field Summary

Fields

Modifier and Type	Field	Description
static String	NAME

Constructor Summary

Constructors

Constructor	Description
JnlpProtocol4ProxyHandler(JnlpProtocol4Handler delegate)

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.
protected JnlpConnectionState	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

Field Detail

NAME

public static final String NAME

See Also:

Constant Field Values

Constructor Detail

JnlpProtocol4ProxyHandler

public JnlpProtocol4ProxyHandler(JnlpProtocol4Handler delegate)

Method Detail

getName

public String getName()

Description copied from class: JnlpProtocolHandler

Get the name of the protocol.

Specified by:

getName in class JnlpProtocolHandler<JnlpConnectionState>

connect

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

Description copied from class: JnlpProtocolHandler

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

Specified by:

connect in class JnlpProtocolHandler<JnlpConnectionState>

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.

handle

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

Description copied from class: JnlpProtocolHandler

Handles an incoming client connection on the supplied socket.

Specified by:

handle in class JnlpProtocolHandler<JnlpConnectionState>

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.

createConnectionState

@NonNull
protected JnlpConnectionState createConnectionState(@NonNull
                                                    Socket socket,
                                                    @NonNull
                                                    List<? extends JnlpConnectionStateListener> listeners)
                                             throws IOException

Description copied from class: JnlpProtocolHandler

Creates the JnlpConnectionState instance for this JnlpProtocolHandler.

Specified by:

createConnectionState in class JnlpProtocolHandler<JnlpConnectionState>

Parameters:

socket - the Socket

listeners - the initial JnlpConnectionStateListener instances.

Returns:

the JnlpConnectionState for this connection.

Throws:

IOException - if something goes wrong.