jenkins.slaves

Class DefaultJnlpSlaveReceiver

java.lang.Object

jenkins.slaves.JnlpAgentReceiver

jenkins.slaves.DefaultJnlpSlaveReceiver

All Implemented Interfaces:

ExtensionPoint

@Extension
public class DefaultJnlpSlaveReceiver
extends JnlpAgentReceiver

Match the name against the slave name and route the incoming JNLP agent as Slave.

Since:

1.561, 1.614 handle() returns true on handshake error as it required in JnlpAgentReceiver.

Author:

Kohsuke Kawaguchi

Nested Class Summary

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor and Description
DefaultJnlpSlaveReceiver()

Method Summary

Modifier and Type	Method and Description
boolean	handle(String nodeName, JnlpSlaveHandshake handshake) Called after the client has connected.

Methods inherited from class jenkins.slaves.JnlpAgentReceiver

all

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultJnlpSlaveReceiver

public DefaultJnlpSlaveReceiver()

Method Detail

handle

public boolean handle(String nodeName,
                      JnlpSlaveHandshake handshake)
               throws IOException,
                      InterruptedException

Description copied from class: JnlpAgentReceiver

Called after the client has connected.

The implementation must do the following in the order:

1. Check if the implementation recognizes and claims the given name. If not, return false to let other JnlpAgentReceiver have a chance to take this connection.
2. If you claim the name but the connection is refused, call JnlpSlaveHandshake.error(String) to refuse the client, and return true. The connection will be shut down and the client will report this error to the user.
3. If you claim the name and the connection is OK, call JnlpSlaveHandshake.success(Properties) to accept the client.
4. Proceed to build a channel with JnlpSlaveHandshake.createChannelBuilder(String) and return true

Specified by:

handle in class JnlpAgentReceiver

Parameters:

nodeName - Name of the incoming JNLP agent. All JnlpAgentReceiver shares a single namespace of names. The implementation needs to be able to tell which name belongs to them.

handshake - Encapsulation of the interaction with the incoming JNLP agent.

Returns:

true if the name was claimed and the handshake was completed (either successfully or unsuccessfully) false if the name was not claimed. Other JnlpAgentReceivers will be called to see if they take this connection.

Throws:

IOException

InterruptedException