jenkins.slaves

Class JnlpSlaveAgentProtocol4

java.lang.Object

jenkins.AgentProtocol

jenkins.slaves.JnlpSlaveAgentProtocol4

All Implemented Interfaces:

ExtensionPoint

@Extension
 @Symbol(value="jnlp4")
public class JnlpSlaveAgentProtocol4
extends AgentProtocol

Master-side implementation for JNLP4-connect protocol.

@see JnlpProtocol4Handler for more details.

Since:

2.27 available as experimental protocol, 2.41 enabled by default

Nested Class Summary

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor and Description
JnlpSlaveAgentProtocol4() Constructor.

Method Summary

Modifier and Type	Method and Description
String	getDisplayName() Returns the human readable protocol display name.
String	getName() Protocol name.
void	handle(Socket socket) Called by the connection handling thread to execute the protocol.
boolean	isOptIn() Allow experimental AgentProtocol implementations to declare being opt-in.
void	setHub(IOHubProvider hub) Inject the IOHubProvider

Methods inherited from class jenkins.AgentProtocol

all, isDeprecated, isRequired, of

Methods inherited from class java.lang.Object

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

Constructor Detail

JnlpSlaveAgentProtocol4

public JnlpSlaveAgentProtocol4()
                        throws KeyStoreException,
                               KeyManagementException,
                               IOException

Constructor.

Throws:

KeyStoreException - if things go wrong.

KeyManagementException - if things go wrong.

IOException - if things go wrong.

Method Detail

setHub

@Inject
public void setHub(IOHubProvider hub)

Inject the IOHubProvider

Parameters:

hub - the hub provider.

isOptIn

public boolean isOptIn()

Allow experimental AgentProtocol implementations to declare being opt-in. Note that Jenkins.setAgentProtocols(Set) only records the protocols where the admin has made a conscious decision thus:

• if a protocol is opt-in, it records the admin enabling it
• if a protocol is opt-out, it records the admin disabling it

Implementations should not transition rapidly from opt-in -> opt-out -> opt-in. Implementations should never flip-flop: opt-in -> opt-out -> opt-in -> opt-out as that will basically clear any preference that an admin has set. This latter restriction should be ok as we only ever will be adding new protocols and retiring old ones.

Overrides:

isOptIn in class AgentProtocol

Returns:

true if the protocol requires explicit opt-in.

See Also:

Jenkins.setAgentProtocols(Set)

getDisplayName

public String getDisplayName()

Returns the human readable protocol display name.

Overrides:

getDisplayName in class AgentProtocol

Returns:

the human readable protocol display name.

getName

public String getName()

Protocol name. This is a short string that consists of printable ASCII chars. Sent by the client to select the protocol.

Specified by:

getName in class AgentProtocol

Returns:

null to be disabled. This is useful for avoiding getting used until the protocol is properly configured.

handle

public void handle(Socket socket)
            throws IOException,
                   InterruptedException

Called by the connection handling thread to execute the protocol.

Specified by:

handle in class AgentProtocol

Throws:

IOException

InterruptedException