jenkins.slaves

Class JnlpAgentReceiver

java.lang.Object

jenkins.slaves.JnlpAgentReceiver

All Implemented Interfaces:

ExtensionPoint

Direct Known Subclasses:

DefaultJnlpSlaveReceiver

public abstract class JnlpAgentReceiver
extends Object
implements ExtensionPoint

Receives incoming slaves connecting through JnlpSlaveAgentProtocol2.

This is useful to establish the communication with other JVMs and use them for different purposes outside Slaves.

Since:

1.561

Author:

Kohsuke Kawaguchi

Nested Class Summary

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor and Description
JnlpAgentReceiver()

Method Summary

Modifier and Type	Method and Description
static ExtensionList<JnlpAgentReceiver>	all()
abstract boolean	handle(String name, JnlpSlaveHandshake handshake) Called after the client has connected.

Methods inherited from class java.lang.Object

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

Constructor Detail

JnlpAgentReceiver

public JnlpAgentReceiver()

Method Detail

handle

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

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

Parameters:

name - 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:

Exception - Any exception thrown from this method will fatally terminate the connection.

IOException

InterruptedException

all

public static ExtensionList<JnlpAgentReceiver> all()