org.jenkinsci.remoting.engine

Class JnlpProtocol

java.lang.Object

org.jenkinsci.remoting.engine.JnlpProtocol

public abstract class JnlpProtocol
extends Object

Handshake protocol used by JNLP slave when initiating a connection to master. Protocols may be stateful.

Author:

Akshay Dayal

Field Summary

Fields

Modifier and Type	Field and Description
protected EngineListener	events Listener to send updates to.
static String	GREETING_SUCCESS
protected String	slaveName
protected String	slaveSecret

Method Summary

Methods

Modifier and Type	Method and Description
Channel	establishChannel(Socket socket, ChannelBuilder channelBuilder) Performs a handshake with the master and establishes a Channel.
abstract String	getName() Get the name of the protocol.

Methods inherited from class java.lang.Object

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

Field Detail

slaveName

protected final String slaveName

slaveSecret

protected final String slaveSecret

events

protected final EngineListener events

Listener to send updates to.

GREETING_SUCCESS

public static final String GREETING_SUCCESS

See Also:

Constant Field Values

Method Detail

getName

public abstract String getName()

Get the name of the protocol.

establishChannel

@Nullable
public Channel establishChannel(Socket socket,
                                ChannelBuilder channelBuilder)
                         throws IOException

Performs a handshake with the master and establishes a Channel.

Parameters:

socket - The established Socket connection to the master.

channelBuilder - The ChannelBuilder to use.

Returns:

The established channel if successful, else null.

Throws:

IOException