Package jenkins

Class AgentProtocol

java.lang.Object

jenkins.AgentProtocol

All Implemented Interfaces:

ExtensionPoint

Direct Known Subclasses:

JnlpSlaveAgentProtocol4, TcpSlaveAgentListener.PingAgentProtocol

public abstract class AgentProtocol
extends Object
implements ExtensionPoint

Pluggable Jenkins TCP agent protocol handler called from TcpSlaveAgentListener.

To register your extension, put Extension annotation on your subtype. Implementations of this extension point is singleton, and its handle(Socket) method gets invoked concurrently whenever a new connection comes in.

Since:

1.467

Author:

Kohsuke Kawaguchi

See Also:

• TcpSlaveAgentListener

Nested Class Summary

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor	Description
AgentProtocol()

Method Summary

Modifier and Type	Method	Description
static ExtensionList<AgentProtocol>	all()	Returns all the registered AgentProtocols.
String	getDisplayName()	Deprecated. no longer used
abstract String	getName()	Protocol name.
abstract void	handle(Socket socket)	Called by the connection handling thread to execute the protocol.
boolean	isDeprecated()	Deprecated. no longer used
boolean	isOptIn()	Deprecated. no longer used
boolean	isRequired()	Deprecated. no longer used
static AgentProtocol	of(String protocolName)

Methods inherited from class java.lang.Object

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

Constructor Details

AgentProtocol

public AgentProtocol()

Method Details

isOptIn

@Deprecated
public boolean isOptIn()

Deprecated.

no longer used

isRequired

@Deprecated
public boolean isRequired()

Deprecated.

no longer used

isDeprecated

@Deprecated
public boolean isDeprecated()

Deprecated.

no longer used

getName

@CheckForNull
public abstract String getName()

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

Returns:

null to be disabled

getDisplayName

@Deprecated
public String getDisplayName()

Deprecated.

no longer used

handle

public abstract void handle(Socket socket)
                     throws IOException,
InterruptedException

Called by the connection handling thread to execute the protocol.

Throws:

IOException

InterruptedException

all

public static ExtensionList<AgentProtocol> all()

Returns all the registered AgentProtocols.

of

@CheckForNull
public static AgentProtocol of(String protocolName)