Merge pull request jenkinsci#2293 from jenkinsci/symbol

Symbol annotations on core
nullin · May 4, 2016 · 31ad770 · 31ad770
2 parents 5e0b737 + 92c81e6
commit 31ad770
Show file tree

Hide file tree

Showing 149 changed files with 481 additions and 178 deletions.
diff --git a/core/pom.xml b/core/pom.xml
@@ -558,6 +558,11 @@ THE SOFTWARE.
       <artifactId>robust-http-client</artifactId>
       <version>1.2</version>
     </dependency>
+    <dependency>
+      <groupId>org.jenkins-ci</groupId>
+      <artifactId>symbol-annotation</artifactId>
+      <version>1.1</version>
+    </dependency>
 
     <dependency><!-- Jenkins doesn't depend on it but some plugin wants the latest version. Bundling 1.6 until we figure out a mechanism to let plugins load its own -->
       <groupId>commons-codec</groupId>

diff --git a/core/src/main/java/hudson/AboutJenkins.java b/core/src/main/java/hudson/AboutJenkins.java
@@ -2,6 +2,8 @@
 
 import hudson.model.ManagementLink;
 import java.net.URL;
+
+import org.jenkinsci.Symbol;
 import org.kohsuke.accmod.Restricted;
 import org.kohsuke.accmod.restrictions.NoExternalUse;
 
@@ -10,7 +12,7 @@
  * 
  * @author Kohsuke Kawaguchi
  */
-@Extension
+@Extension @Symbol("about")
 public class AboutJenkins extends ManagementLink {
     @Override
     public String getIconFileName() {

diff --git a/core/src/main/java/hudson/FileSystemProvisioner.java b/core/src/main/java/hudson/FileSystemProvisioner.java
@@ -34,6 +34,7 @@
 import jenkins.model.Jenkins;
 import hudson.model.listeners.RunListener;
 import hudson.scm.SCM;
+import org.jenkinsci.Symbol;
 
 import java.io.BufferedOutputStream;
 import java.io.File;
@@ -235,7 +236,7 @@ public void restoreTo(AbstractBuild<?,?> owner, FilePath dst, TaskListener liste
             }
         }
 
-        @Extension
+        @Extension @Symbol("standard")
         public static final class DescriptorImpl extends FileSystemProvisionerDescriptor {
             public boolean discard(FilePath ws, TaskListener listener) throws IOException, InterruptedException {
                 // the default provisioner does not do anything special,

diff --git a/core/src/main/java/hudson/PluginManager.java b/core/src/main/java/hudson/PluginManager.java
@@ -66,6 +66,7 @@
 import org.apache.commons.io.IOUtils;
 import org.apache.commons.lang.StringUtils;
 import org.apache.commons.logging.LogFactory;
+import org.jenkinsci.Symbol;
 import org.jenkinsci.bytecode.Transformer;
 import org.jvnet.hudson.reactor.Executable;
 import org.jvnet.hudson.reactor.Reactor;
@@ -1725,7 +1726,7 @@ public String getExceptionString() {
     /**
      * {@link AdministrativeMonitor} that checks if there are any plugins with cycle dependencies.
      */
-    @Extension
+    @Extension @Symbol("pluginCycleDependencies")
     public static final class PluginCycleDependenciesMonitor extends AdministrativeMonitor {
 
         private transient volatile boolean isActive = false;
@@ -1754,7 +1755,7 @@ public List<String> getPluginsWithCycle() {
      * {@link AdministrativeMonitor} that informs the administrator about a required plugin update.
      * @since 1.491
      */
-    @Extension
+    @Extension @Symbol("pluginUpdate")
     public static final class PluginUpdateMonitor extends AdministrativeMonitor {
 
         private Map<String, PluginUpdateInfo> pluginsToBeUpdated = new HashMap<String, PluginManager.PluginUpdateMonitor.PluginUpdateInfo>();

diff --git a/core/src/main/java/hudson/ProxyConfiguration.java b/core/src/main/java/hudson/ProxyConfiguration.java
@@ -55,6 +55,7 @@
 import org.apache.commons.httpclient.UsernamePasswordCredentials;
 import org.apache.commons.httpclient.auth.AuthScope;
 import org.apache.commons.httpclient.methods.GetMethod;
+import org.jenkinsci.Symbol;
 import org.jvnet.robust_http_client.RetryableHttpStream;
 import org.kohsuke.stapler.DataBoundConstructor;
 import org.kohsuke.stapler.QueryParameter;
@@ -306,7 +307,7 @@ private static void decorate(URLConnection con) throws IOException {
         XSTREAM.alias("proxy", ProxyConfiguration.class);
     }
 
-    @Extension
+    @Extension @Symbol("proxy")
     public static class DescriptorImpl extends Descriptor<ProxyConfiguration> {
         @Override
         public String getDisplayName() {

diff --git a/core/src/main/java/hudson/cli/CLIAction.java b/core/src/main/java/hudson/cli/CLIAction.java
@@ -34,6 +34,7 @@
 import hudson.model.UnprotectedRootAction;
 import jenkins.model.Jenkins;
 
+import org.jenkinsci.Symbol;
 import org.kohsuke.accmod.Restricted;
 import org.kohsuke.accmod.restrictions.NoExternalUse;
 import org.kohsuke.stapler.HttpResponses.HttpResponseException;
@@ -51,7 +52,7 @@
  *
  * @author ogondza
  */
-@Extension
+@Extension @Symbol("cli")
 @Restricted(NoExternalUse.class)
 public class CLIAction implements UnprotectedRootAction, StaplerProxy {
 

diff --git a/core/src/main/java/hudson/cli/CliProtocol.java b/core/src/main/java/hudson/cli/CliProtocol.java
@@ -8,6 +8,7 @@
 import jenkins.AgentProtocol;
 import jenkins.model.Jenkins;
 import jenkins.slaves.NioChannelSelector;
+import org.jenkinsci.Symbol;
 import org.jenkinsci.remoting.nio.NioChannelHub;
 
 import javax.inject.Inject;
@@ -25,7 +26,7 @@
  * @author Kohsuke Kawaguchi
  * @since 1.467
  */
-@Extension
+@Extension @Symbol("cli")
 public class CliProtocol extends AgentProtocol {
     @Inject
     NioChannelSelector nio;

diff --git a/core/src/main/java/hudson/cli/CliProtocol2.java b/core/src/main/java/hudson/cli/CliProtocol2.java
@@ -2,6 +2,7 @@
 
 import hudson.Extension;
 import jenkins.model.Jenkins;
+import org.jenkinsci.Symbol;
 import org.jenkinsci.remoting.nio.NioChannelHub;
 
 import javax.crypto.SecretKey;
@@ -20,7 +21,7 @@
  * @author Kohsuke Kawaguchi
  * @since 1.467
  */
-@Extension
+@Extension @Symbol("cli2")
 public class CliProtocol2 extends CliProtocol {
     @Override
     public String getName() {

diff --git a/core/src/main/java/hudson/console/HudsonExceptionNote.java b/core/src/main/java/hudson/console/HudsonExceptionNote.java
@@ -25,6 +25,7 @@
 
 import hudson.Extension;
 import hudson.MarkupText;
+import org.jenkinsci.Symbol;
 
 import java.util.regex.Matcher;
 import java.util.regex.Pattern;
@@ -95,7 +96,7 @@ private String annotateClassName(String className) {
         return "http://stacktrace.jenkins-ci.org/search?query="+className;
     }
 
-    @Extension
+    @Extension @Symbol("stackTrace")
     public static final class DescriptorImpl extends ConsoleAnnotationDescriptor {
         @Override
         public String getDisplayName() {

diff --git a/core/src/main/java/hudson/console/HyperlinkNote.java b/core/src/main/java/hudson/console/HyperlinkNote.java
@@ -26,6 +26,7 @@
 import hudson.Extension;
 import hudson.MarkupText;
 import jenkins.model.Jenkins;
+import org.jenkinsci.Symbol;
 import org.kohsuke.stapler.Stapler;
 import org.kohsuke.stapler.StaplerRequest;
 
@@ -83,7 +84,7 @@ public static String encodeTo(String url, String text) {
         }
     }
 
-    @Extension
+    @Extension @Symbol("hyperlink")
     public static class DescriptorImpl extends ConsoleAnnotationDescriptor {
         public String getDisplayName() {
             return "Hyperlinks";

diff --git a/core/src/main/java/hudson/console/ModelHyperlinkNote.java b/core/src/main/java/hudson/console/ModelHyperlinkNote.java
@@ -3,6 +3,7 @@
 import hudson.Extension;
 import hudson.model.*;
 import jenkins.model.Jenkins;
+import org.jenkinsci.Symbol;
 
 import java.io.IOException;
 import java.util.logging.Level;
@@ -64,7 +65,7 @@ public static String encodeTo(String url, String text) {
         }
     }
 
-    @Extension
+    @Extension @Symbol("hyperlinkToModels")
     public static class DescriptorImpl extends HyperlinkNote.DescriptorImpl {
         public String getDisplayName() {
             return "Hyperlinks to models";

diff --git a/core/src/main/java/hudson/console/UrlAnnotator.java b/core/src/main/java/hudson/console/UrlAnnotator.java
@@ -3,6 +3,7 @@
 import hudson.Extension;
 import hudson.MarkupText;
 import hudson.MarkupText.SubText;
+import org.jenkinsci.Symbol;
 
 import java.util.regex.Pattern;
 
@@ -11,7 +12,7 @@
  *
  * @author Kohsuke Kawaguchi
  */
-@Extension
+@Extension @Symbol("url")
 public class UrlAnnotator extends ConsoleAnnotatorFactory<Object> {
     @Override
     public ConsoleAnnotator newInstance(Object context) {

diff --git a/core/src/main/java/hudson/diagnosis/HudsonHomeDiskUsageChecker.java b/core/src/main/java/hudson/diagnosis/HudsonHomeDiskUsageChecker.java
@@ -26,6 +26,7 @@
 import hudson.Extension;
 import jenkins.model.Jenkins;
 import hudson.model.PeriodicWork;
+import org.jenkinsci.Symbol;
 
 import java.util.logging.Logger;
 
@@ -35,7 +36,7 @@
  *
  * @author Kohsuke Kawaguchi
  */
-@Extension
+@Extension @Symbol("diskUsageCheck")
 public class HudsonHomeDiskUsageChecker extends PeriodicWork {
     public long getRecurrencePeriod() {
         return HOUR;

diff --git a/core/src/main/java/hudson/diagnosis/HudsonHomeDiskUsageMonitor.java b/core/src/main/java/hudson/diagnosis/HudsonHomeDiskUsageMonitor.java
@@ -28,6 +28,7 @@
 import hudson.Extension;
 import hudson.ExtensionPoint;
 import hudson.ExtensionList;
+import org.jenkinsci.Symbol;
 import org.kohsuke.stapler.HttpResponse;
 import org.kohsuke.stapler.HttpResponses;
 import org.kohsuke.stapler.QueryParameter;
@@ -40,7 +41,7 @@
  *
  * @author Kohsuke Kawaguchi
  */
-@Extension
+@Extension @Symbol("diskUsageCheck")
 public final class HudsonHomeDiskUsageMonitor extends AdministrativeMonitor {
     /**
      * Value updated by {@link HudsonHomeDiskUsageChecker}.

diff --git a/core/src/main/java/hudson/diagnosis/MemoryUsageMonitor.java b/core/src/main/java/hudson/diagnosis/MemoryUsageMonitor.java
@@ -39,14 +39,15 @@
 import java.util.ArrayList;
 import java.io.IOException;
 
+import org.jenkinsci.Symbol;
 import org.kohsuke.stapler.QueryParameter;
 
 /**
  * Monitors the memory usage of the system in OS specific way.
  *
  * @author Kohsuke Kawaguchi
  */
-@Extension
+@Extension @Symbol("memoryUsage")
 public final class MemoryUsageMonitor extends PeriodicWork {
     /**
      * A memory group is conceptually a set of memory pools. 

diff --git a/core/src/main/java/hudson/diagnosis/NullIdDescriptorMonitor.java b/core/src/main/java/hudson/diagnosis/NullIdDescriptorMonitor.java
@@ -29,6 +29,7 @@
 import hudson.model.AdministrativeMonitor;
 import hudson.model.Descriptor;
 import jenkins.model.Jenkins;
+import org.jenkinsci.Symbol;
 
 import java.text.MessageFormat;
 import java.util.ArrayList;
@@ -46,7 +47,7 @@
  * @author Kohsuke Kawaguchi
  * @since 1.402
  */
-@Extension
+@Extension @Symbol("nullId")
 public class NullIdDescriptorMonitor extends AdministrativeMonitor {
 
     private final List<Descriptor> problems = new ArrayList<Descriptor>();

diff --git a/core/src/main/java/hudson/diagnosis/OldDataMonitor.java b/core/src/main/java/hudson/diagnosis/OldDataMonitor.java
@@ -55,6 +55,7 @@
 import jenkins.model.Jenkins;
 import org.acegisecurity.context.SecurityContext;
 import org.acegisecurity.context.SecurityContextHolder;
+import org.jenkinsci.Symbol;
 import org.kohsuke.accmod.Restricted;
 import org.kohsuke.accmod.restrictions.NoExternalUse;
 import org.kohsuke.stapler.HttpRedirect;
@@ -70,7 +71,7 @@
  *
  * @author Alan.Harder@Sun.Com
  */
-@Extension
+@Extension @Symbol("oldData")
 public class OldDataMonitor extends AdministrativeMonitor {
     private static final Logger LOGGER = Logger.getLogger(OldDataMonitor.class.getName());
 
@@ -430,7 +431,7 @@ private static final class RunSaveableReference implements SaveableReference {
         }
     }
 
-    @Extension
+    @Extension @Symbol("oldData")
     public static class ManagementLinkImpl extends ManagementLink {
         @Override
         public String getIconFileName() {

diff --git a/core/src/main/java/hudson/diagnosis/ReverseProxySetupMonitor.java b/core/src/main/java/hudson/diagnosis/ReverseProxySetupMonitor.java
@@ -26,6 +26,7 @@
 import hudson.Extension;
 import hudson.Util;
 import hudson.model.AdministrativeMonitor;
+import org.jenkinsci.Symbol;
 import org.kohsuke.stapler.HttpRedirect;
 import org.kohsuke.stapler.HttpResponse;
 import org.kohsuke.stapler.HttpResponses;
@@ -48,7 +49,7 @@
  *
  * @author Kohsuke Kawaguchi
  */
-@Extension
+@Extension @Symbol("reverseProxy")
 public class ReverseProxySetupMonitor extends AdministrativeMonitor {
 
     private static final Logger LOGGER = Logger.getLogger(ReverseProxySetupMonitor.class.getName());

diff --git a/core/src/main/java/hudson/diagnosis/TooManyJobsButNoView.java b/core/src/main/java/hudson/diagnosis/TooManyJobsButNoView.java
@@ -26,6 +26,7 @@
 import hudson.model.AdministrativeMonitor;
 import jenkins.model.Jenkins;
 import hudson.Extension;
+import org.jenkinsci.Symbol;
 import org.kohsuke.stapler.StaplerRequest;
 import org.kohsuke.stapler.StaplerResponse;
 
@@ -39,7 +40,7 @@
  *
  * @author Kohsuke Kawaguchi
  */
-@Extension
+@Extension @Symbol("tooManyJobsButNoView")
 public class TooManyJobsButNoView extends AdministrativeMonitor {
     public boolean isActivated() {
         Jenkins h = Jenkins.getInstance();

diff --git a/core/src/main/java/hudson/markup/EscapedMarkupFormatter.java b/core/src/main/java/hudson/markup/EscapedMarkupFormatter.java
@@ -29,10 +29,12 @@
 import hudson.markup.MarkupFormatterDescriptor;
 import java.io.IOException;
 import java.io.Writer;
+
+import org.jenkinsci.Symbol;
 import org.kohsuke.stapler.DataBoundConstructor;
 
 /**
- * @link MarkupFormatter} that treats the input as the escaped html.
+ * {@link MarkupFormatter} that treats the input as the escaped html.
  *
  * @author Seiji Sogabe
  * @since 1.553
@@ -48,7 +50,7 @@ public void translate(String markup, Writer output) throws IOException {
         output.write(Util.escape(markup));
     }
 
-    @Extension
+    @Extension @Symbol("plainText")
     public static class DescriptorImpl extends MarkupFormatterDescriptor {
 
         @Override

diff --git a/core/src/main/java/hudson/model/AllView.java b/core/src/main/java/hudson/model/AllView.java
@@ -23,6 +23,7 @@
  */
 package hudson.model;
 
+import org.jenkinsci.Symbol;
 import org.kohsuke.stapler.DataBoundConstructor;
 import org.kohsuke.stapler.Stapler;
 import org.kohsuke.stapler.StaplerRequest;
@@ -88,7 +89,7 @@ protected void submit(StaplerRequest req) throws IOException, ServletException,
         // noop
     }
 
-    @Extension
+    @Extension @Symbol("all")
     public static final class DescriptorImpl extends ViewDescriptor {
         @Override
         public boolean isInstantiable() {

diff --git a/core/src/main/java/hudson/model/BooleanParameterDefinition.java b/core/src/main/java/hudson/model/BooleanParameterDefinition.java
@@ -23,6 +23,7 @@
  */
 package hudson.model;
 
+import org.jenkinsci.Symbol;
 import org.kohsuke.stapler.StaplerRequest;
 import org.kohsuke.stapler.DataBoundConstructor;
 import net.sf.json.JSONObject;
@@ -72,7 +73,9 @@ public BooleanParameterValue getDefaultParameterValue() {
         return new BooleanParameterValue(getName(), defaultValue, getDescription());
     }
 
-    @Extension
+    // unlike all the other ParameterDescriptors, using 'booleanParam' as the primary
+    // to avoid picking the Java reserved word "boolean" as the primary identifier
+    @Extension @Symbol({"booleanParam"})
     public static class DescriptorImpl extends ParameterDescriptor {
         @Override
         public String getDisplayName() {