[JENKINS-37032] Add display names and optional descriptions

core/src/main/java/hudson/TcpSlaveAgentListener.java

@@ -265,7 +265,7 @@ public final class TcpSlaveAgentListener extends Thread {
          * Allow essential {@link AgentProtocol} implementations (basically {@link PingAgentProtocol})
          * to be always enabled.
          *
-         * @return {@code true} if the protocol can never be disbaled.
+         * @return {@code true} if the protocol can never be disabled.
          * @since FIXME
          */
         @Override
@@ -278,6 +278,14 @@ public final class TcpSlaveAgentListener extends Thread {
             return "Ping";
         }
 
+        /**
+         * {@inheritDoc}
+         */
+        @Override
+        public String getDisplayName() {
+            return Messages.TcpSlaveAgentListener_PingAgentProtocol_displayName();
+        }
+
         @Override
         public void handle(Socket socket) throws IOException, InterruptedException {
             try {

core/src/main/java/hudson/cli/CliProtocol.java

@@ -36,6 +36,14 @@ public class CliProtocol extends AgentProtocol {
         return "CLI-connect";
     }
 
+    /**
+     * {@inheritDoc}
+     */
+    @Override
+    public String getDisplayName() {
+        return "Jenkins CLI Protocol/1";
+    }
+
     @Override
     public void handle(Socket socket) throws IOException, InterruptedException {
         new Handler(nio.getHub(),socket).run();

core/src/main/java/hudson/cli/CliProtocol2.java

@@ -28,6 +28,14 @@ public class CliProtocol2 extends CliProtocol {
         return "CLI2-connect";
     }
 
+    /**
+     * {@inheritDoc}
+     */
+    @Override
+    public String getDisplayName() {
+        return "Jenkins CLI Protocol/2";
+    }
+
     @Override
     public void handle(Socket socket) throws IOException, InterruptedException {
         new Handler2(nio.getHub(), socket).run();

core/src/main/java/jenkins/AgentProtocol.java

@@ -33,7 +33,7 @@ public abstract class AgentProtocol implements ExtensionPoint {
      * Allow essential {@link AgentProtocol} implementations (basically {@link TcpSlaveAgentListener.PingAgentProtocol})
      * to be always enabled.
      *
-     * @return {@code true} if the protocol can never be disbaled.
+     * @return {@code true} if the protocol can never be disabled.
      * @since FIXME
      */
     public boolean isRequired() {
@@ -50,6 +50,16 @@ public abstract class AgentProtocol implements ExtensionPoint {
      */
     public abstract String getName();
 
+    /**
+     * Returns the human readable protocol display name.
+     *
+     * @return the human readable protocol display name.
+     * @since FIXME
+     */
+    public String getDisplayName() {
+        return getName();
+    }
+
     /**
      * Called by the connection handling thread to execute the protocol.
      */

core/src/main/java/jenkins/slaves/JnlpSlaveAgentProtocol.java

@@ -65,6 +65,14 @@ public class JnlpSlaveAgentProtocol extends AgentProtocol {
         return "JNLP-connect";
     }
 
+    /**
+     * {@inheritDoc}
+     */
+    @Override
+    public String getDisplayName() {
+        return Messages.JnlpSlaveAgentProtocol_displayName();
+    }
+
     @Override
     public void handle(Socket socket) throws IOException, InterruptedException {
         new Handler(hub.getHub(),socket).run();

core/src/main/java/jenkins/slaves/JnlpSlaveAgentProtocol2.java

@@ -27,6 +27,14 @@ public class JnlpSlaveAgentProtocol2 extends JnlpSlaveAgentProtocol {
         return "JNLP2-connect";
     }
 
+    /**
+     * {@inheritDoc}
+     */
+    @Override
+    public String getDisplayName() {
+        return Messages.JnlpSlaveAgentProtocol2_displayName();
+    }
+
     @Override
     public void handle(Socket socket) throws IOException, InterruptedException {
         new Handler2(hub.getHub(),socket).run();

core/src/main/java/jenkins/slaves/JnlpSlaveAgentProtocol3.java

@@ -42,6 +42,14 @@ public class JnlpSlaveAgentProtocol3 extends AgentProtocol {
         return ENABLED ? "JNLP3-connect" : null;
     }
 
+    /**
+     * {@inheritDoc}
+     */
+    @Override
+    public String getDisplayName() {
+        return Messages.JnlpSlaveAgentProtocol3_displayName();
+    }
+
     @Override
     public void handle(Socket socket) throws IOException, InterruptedException {
         new Handler(hub.getHub(), socket).run();

core/src/main/resources/hudson/Messages.properties

@@ -72,3 +72,5 @@ ProxyConfiguration.FailedToConnect=Failed to connect to {0} (code {1}).
 ProxyConfiguration.Success=Success
 
 Functions.NoExceptionDetails=No Exception details
+
+TcpSlaveAgentListener.PingAgentProtocol.displayName=Ping protocol

core/src/main/resources/hudson/cli/CliProtocol/description.jelly

+<?jelly escape-by-default='true'?>
+<j:jelly xmlns:j="jelly:core">
+  ${%Accepts connections from CLI clients}
+</j:jelly>

core/src/main/resources/hudson/cli/CliProtocol2/description.jelly

+<?jelly escape-by-default='true'?>
+<j:jelly xmlns:j="jelly:core">
+  ${%Extends the version 1 protocol by adding transport encryption}
+</j:jelly>

core/src/main/resources/hudson/cli/Messages.properties

@@ -94,3 +94,5 @@ OfflineNodeCommand.ShortDescription=Stop using a node for performing builds temp
 WaitNodeOnlineCommand.ShortDescription=Wait for a node to become online.
 WaitNodeOfflineCommand.ShortDescription=Wait for a node to become offline.
 
+CliProtocol.displayName=Jenkins CLI Protocol/1
+CliProtocol2.displayName=Jenkins CLI Protocol/2

core/src/main/resources/hudson/security/GlobalSecurityConfiguration/index.groovy

@@ -32,13 +32,23 @@ l.layout(norefresh:true, permission:app.ADMINISTER, title:my.displayName, csscla
                 f.advanced(title: _("Agent protocols"), align:"left") {
                     f.entry(title: _("Agent protocols")) {
                         def agentProtocols = my.agentProtocols;
-                        for (AgentProtocol p: AgentProtocol.all()) {
+                        table(width:"100%") {
+                            for (AgentProtocol p : AgentProtocol.all()) {
                                 if (p.name != null && !p.required) {
+                                    f.block() {
                                         f.checkbox(name: "agentProtocol",
-                                        title: p.name,
-                                        checked:agentProtocols.contains(p.name),
+                                                title: p.displayName,
+                                                checked: agentProtocols.contains(p.name),
                                                 json: p.name);
-                                br();
+                                    }
+                                    tr() {
+                                        td(colspan:"2");
+                                        td(class:"setting-description"){
+                                            st.include(from:p, page: "description", optional:true);
+                                        }
+                                        td();
+                                    }
+                                }
                             }
                         }
                     }

core/src/main/resources/jenkins/slaves/JnlpSlaveAgentProtocol/description.jelly

+<?jelly escape-by-default='true'?>
+<j:jelly xmlns:j="jelly:core">
+  ${%Accepts connections from remote clients so that they can be used as additional build agents}
+</j:jelly>

core/src/main/resources/jenkins/slaves/JnlpSlaveAgentProtocol2/description.jelly

+<?jelly escape-by-default='true'?>
+<j:jelly xmlns:j="jelly:core">
+  ${%Extends the version 1 protocol by adding a per-client cookie, so that we can detect a reconnection from the agent and take appropriate action}
+</j:jelly>

core/src/main/resources/jenkins/slaves/JnlpSlaveAgentProtocol3/description.jelly

+<?jelly escape-by-default='true'?>
+<j:jelly xmlns:j="jelly:core">
+  ${%Extends the version 2 protocol by adding basic encryption but requires a thread per client}
+</j:jelly>

core/src/main/resources/jenkins/slaves/Messages.properties

+# The MIT License
+#
+# Copyright 2016 Stephen Connolly
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+JnlpSlaveAgentProtocol.displayName=Java Web Start Agent Protocol/1
+JnlpSlaveAgentProtocol2.displayName=Java Web Start Agent Protocol/2
+JnlpSlaveAgentProtocol3.displayName=Java Web Start Agent Protocol/3