org.jenkinsci.remoting.engine

Class JnlpProtocolHandler<STATE extends JnlpConnectionState>

java.lang.Object

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

Type Parameters:

STATE - State class for connection events

Direct Known Subclasses:

JnlpProtocol1Handler, JnlpProtocol2Handler, JnlpProtocol3Handler, JnlpProtocol4Handler, JnlpProtocol4PlainHandler

public abstract class JnlpProtocolHandler<STATE extends JnlpConnectionState>
extends Object

Consolidates the protocol handling for both the server and the client ends of the connection.

Since:

3.0

Method Summary

Modifier and Type	Method and Description
Future<Channel>	connect(Socket socket, Map<String,String> headers, JnlpConnectionStateListener... listeners) Handles an outgoing connection to the server on the supplied socket.
abstract 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 abstract STATE	createConnectionState(Socket socket, List<? extends JnlpConnectionStateListener> listeners) Creates the JnlpConnectionState instance for this JnlpProtocolHandler.
JnlpClientDatabase	getClientDatabase() Gets the JnlpClientDatabase.
abstract String	getName() Get the name of the protocol.
Future<Channel>	handle(Socket socket, Map<String,String> headers, JnlpConnectionStateListener... listeners) Handles an incoming client connection on the supplied socket.
abstract Future<Channel>	handle(Socket socket, Map<String,String> headers, List<? extends JnlpConnectionStateListener> listeners) Handles an incoming client connection on the supplied socket.
boolean	isEnabled() Whether this protocol is enabled for connecting.
boolean	isPreferNio() Gets the preference for Non-Blocking I/O

Methods inherited from class java.lang.Object

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

Method Detail

getClientDatabase

@CheckForNull
public JnlpClientDatabase getClientDatabase()

Gets the JnlpClientDatabase.

Returns:

the JnlpClientDatabase or null.

isPreferNio

public boolean isPreferNio()

Gets the preference for Non-Blocking I/O

Returns:

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

getName

public abstract String getName()

Get the name of the protocol.

isEnabled

public boolean isEnabled()

Whether this protocol is enabled for connecting.

Returns:

true if this protocol is enabled.

createConnectionState

@Nonnull
protected abstract STATE createConnectionState(@Nonnull
                                                        Socket socket,
                                                        @Nonnull
                                                        List<? extends JnlpConnectionStateListener> listeners)
                                                 throws IOException

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 final Future<Channel> handle(@Nonnull
                                             Socket socket,
                                             @Nonnull
                                             Map<String,String> headers,
                                             @Nonnull
                                             JnlpConnectionStateListener... listeners)
                                      throws IOException

Handles an incoming client connection on the supplied socket.

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 abstract 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.

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 final Future<Channel> connect(@Nonnull
                                              Socket socket,
                                              @Nonnull
                                              Map<String,String> headers,
                                              @Nonnull
                                              JnlpConnectionStateListener... listeners)
                                       throws IOException

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

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 abstract 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.

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.