diff --git a/core/src/main/java/hudson/model/Hudson.java b/core/src/main/java/hudson/model/Hudson.java index 2a1ad5f4a2..349cfda702 100644 --- a/core/src/main/java/hudson/model/Hudson.java +++ b/core/src/main/java/hudson/model/Hudson.java @@ -25,16 +25,48 @@ */ package hudson.model; +import hudson.ExtensionListView; +import hudson.Functions; +import hudson.Platform; import hudson.PluginManager; import hudson.cli.declarative.CLIResolver; +import hudson.model.listeners.ItemListener; +import hudson.slaves.ComputerListener; +import hudson.util.CopyOnWriteList; +import hudson.util.FormValidation; import org.jvnet.hudson.reactor.ReactorException; +import org.kohsuke.stapler.QueryParameter; +import org.kohsuke.stapler.Stapler; +import org.kohsuke.stapler.StaplerRequest; +import org.kohsuke.stapler.StaplerResponse; import javax.servlet.ServletContext; +import javax.servlet.ServletException; import java.io.File; import java.io.IOException; +import java.text.NumberFormat; +import java.text.ParseException; +import java.util.Collections; +import java.util.List; +import java.util.Map; + +import static hudson.Util.fixEmpty; public class Hudson extends Jenkins { + /** + * List of registered {@link hudson.model.listeners.ItemListener}s. + * @deprecated as of 1.286 + */ + private transient final CopyOnWriteList itemListeners = ExtensionListView.createCopyOnWriteList(ItemListener.class); + + /** + * List of registered {@link hudson.slaves.ComputerListener}s. + * @deprecated as of 1.286 + */ + private transient final CopyOnWriteList computerListeners = ExtensionListView.createCopyOnWriteList(ComputerListener.class); + + @CLIResolver public static Hudson getInstance() { return (Hudson)Jenkins.getInstance(); @@ -48,6 +80,230 @@ public class Hudson extends Jenkins { super(root, context, pluginManager); } + /** + * Gets all the installed {@link ItemListener}s. + * + * @deprecated as of 1.286. + * Use {@link ItemListener#all()}. + */ + public CopyOnWriteList getJobListeners() { + return itemListeners; + } + + /** + * Gets all the installed {@link ComputerListener}s. + * + * @deprecated as of 1.286. + * Use {@link ComputerListener#all()}. + */ + public CopyOnWriteList getComputerListeners() { + return computerListeners; + } + + /** + * @deprecated + * UI method. Not meant to be used programatically. + */ + public ComputerSet getComputer() { + return new ComputerSet(); + } + + /** + * Gets the slave node of the give name, hooked under this Hudson. + * + * @deprecated + * Use {@link #getNode(String)}. Since 1.252. + */ + public Slave getSlave(String name) { + Node n = getNode(name); + if (n instanceof Slave) + return (Slave)n; + return null; + } + + /** + * @deprecated + * Use {@link #getNodes()}. Since 1.252. + */ + public List getSlaves() { + return (List) Collections.unmodifiableList(slaves); + } + + /** + * Updates the slave list. + * + * @deprecated + * Use {@link #setNodes(List)}. Since 1.252. + */ + public void setSlaves(List slaves) throws IOException { + setNodes(slaves); + } + + /** + * @deprecated + * Left only for the compatibility of URLs. + * Should not be invoked for any other purpose. + */ + public TopLevelItem getJob(String name) { + return getItem(name); + } + + /** + * @deprecated + * Used only for mapping jobs to URL in a case-insensitive fashion. + */ + public TopLevelItem getJobCaseInsensitive(String name) { + String match = Functions.toEmailSafeString(name); + for (Map.Entry e : items.entrySet()) { + if(Functions.toEmailSafeString(e.getKey()).equalsIgnoreCase(match)) { + TopLevelItem item = e.getValue(); + return item.hasPermission(Item.READ) ? item : null; + } + } + return null; + } + + /** + * @deprecated as of 1.317 + * Use {@link #doQuietDown()} instead. + */ + public synchronized void doQuietDown(StaplerResponse rsp) throws IOException, ServletException { + doQuietDown().generateResponse(null, rsp, this); + } + + /** + * RSS feed for log entries. + * + * @deprecated + * As on 1.267, moved to "/log/rss..." + */ + public void doLogRss( StaplerRequest req, StaplerResponse rsp ) throws IOException, ServletException { + String qs = req.getQueryString(); + rsp.sendRedirect2("./log/rss"+(qs==null?"":'?'+qs)); + } + + /** + * @deprecated as of 1.294 + * Define your own check method, instead of relying on this generic one. + */ + public void doFieldCheck(StaplerRequest req, StaplerResponse rsp) throws IOException, ServletException { + doFieldCheck( + fixEmpty(req.getParameter("value")), + fixEmpty(req.getParameter("type")), + fixEmpty(req.getParameter("errorText")), + fixEmpty(req.getParameter("warningText"))).generateResponse(req,rsp,this); + } + + /** + * Checks if the value for a field is set; if not an error or warning text is displayed. + * If the parameter "value" is not set then the parameter "errorText" is displayed + * as an error text. If the parameter "errorText" is not set, then the parameter "warningText" + * is displayed as a warning text. + *

+ * If the text is set and the parameter "type" is set, it will validate that the value is of the + * correct type. Supported types are "number, "number-positive" and "number-negative". + * + * @deprecated as of 1.324 + * Either use client-side validation (e.g. class="required number") + * or define your own check method, instead of relying on this generic one. + */ + public FormValidation doFieldCheck(@QueryParameter(fixEmpty=true) String value, + @QueryParameter(fixEmpty=true) String type, + @QueryParameter(fixEmpty=true) String errorText, + @QueryParameter(fixEmpty=true) String warningText) { + if (value == null) { + if (errorText != null) + return FormValidation.error(errorText); + if (warningText != null) + return FormValidation.warning(warningText); + return FormValidation.error("No error or warning text was set for fieldCheck()."); + } + + if (type != null) { + try { + if (type.equalsIgnoreCase("number")) { + NumberFormat.getInstance().parse(value); + } else if (type.equalsIgnoreCase("number-positive")) { + if (NumberFormat.getInstance().parse(value).floatValue() <= 0) + return FormValidation.error(Messages.Hudson_NotAPositiveNumber()); + } else if (type.equalsIgnoreCase("number-negative")) { + if (NumberFormat.getInstance().parse(value).floatValue() >= 0) + return FormValidation.error(Messages.Hudson_NotANegativeNumber()); + } + } catch (ParseException e) { + return FormValidation.error(Messages.Hudson_NotANumber()); + } + } + + return FormValidation.ok(); + } + + /** + * @deprecated + * Use {@link Functions#isWindows()}. + */ + public static boolean isWindows() { + return File.pathSeparatorChar==';'; + } + + /** + * @deprecated + * Use {@link hudson.Platform#isDarwin()} + */ + public static boolean isDarwin() { + return Platform.isDarwin(); + } + + /** + * @deprecated since 2007-12-18. + * Use {@link #checkPermission(hudson.security.Permission)} + */ + public static boolean adminCheck() throws IOException { + return adminCheck(Stapler.getCurrentRequest(), Stapler.getCurrentResponse()); + } + + /** + * @deprecated since 2007-12-18. + * Use {@link #checkPermission(hudson.security.Permission)} + */ + public static boolean adminCheck(StaplerRequest req,StaplerResponse rsp) throws IOException { + if (isAdmin(req)) return true; + + rsp.sendError(StaplerResponse.SC_FORBIDDEN); + return false; + } + + /** + * Checks if the current user (for which we are processing the current request) + * has the admin access. + * + * @deprecated since 2007-12-18. + * This method is deprecated when Hudson moved from simple Unix root-like model + * of "admin gets to do everything, and others don't have any privilege" to more + * complex {@link hudson.security.ACL} and {@link hudson.security.Permission} based scheme. + * + *

+ * For a quick migration, use {@code Hudson.getInstance().getACL().hasPermission(Hudson.ADMINISTER)} + * To check if the user has the 'administer' role in Hudson. + * + *

+ * But ideally, your plugin should first identify a suitable {@link hudson.security.Permission} (or create one, + * if appropriate), then identify a suitable {@link hudson.security.AccessControlled} object to check its permission + * against. + */ + public static boolean isAdmin() { + return Jenkins.getInstance().getACL().hasPermission(ADMINISTER); + } + + /** + * @deprecated since 2007-12-18. + * Define a custom {@link hudson.security.Permission} and check against ACL. + * See {@link #isAdmin()} for more instructions. + */ + public static boolean isAdmin(StaplerRequest req) { + return isAdmin(); + } + static { XSTREAM.alias("hudson",Hudson.class); } diff --git a/core/src/main/java/hudson/model/Jenkins.java b/core/src/main/java/hudson/model/Jenkins.java index efe4059901..228a55eb33 100644 --- a/core/src/main/java/hudson/model/Jenkins.java +++ b/core/src/main/java/hudson/model/Jenkins.java @@ -413,7 +413,7 @@ public class Jenkins extends Node implements ItemGroup, StaplerPro * The field name should be really {@code nodes}, but again the backward compatibility * prevents us from renaming. */ - private volatile NodeList slaves; + protected volatile NodeList slaves; /** * Quiet period. @@ -453,23 +453,11 @@ public class Jenkins extends Node implements ItemGroup, StaplerPro private transient DNSMultiCast dnsMultiCast; - /** - * List of registered {@link ItemListener}s. - * @deprecated as of 1.286 - */ - private transient final CopyOnWriteList itemListeners = ExtensionListView.createCopyOnWriteList(ItemListener.class); - /** * List of registered {@link SCMListener}s. */ private transient final CopyOnWriteList scmListeners = new CopyOnWriteList(); - /** - * List of registered {@link ComputerListener}s. - * @deprecated as of 1.286 - */ - private transient final CopyOnWriteList computerListeners = ExtensionListView.createCopyOnWriteList(ComputerListener.class); - /** * TCP slave agent port. * 0 for random, -1 to disable. @@ -602,7 +590,7 @@ public class Jenkins extends Node implements ItemGroup, StaplerPro */ private transient final LogRecorderManager log = new LogRecorderManager(); - public Jenkins(File root, ServletContext context) throws IOException, InterruptedException, ReactorException { + protected Jenkins(File root, ServletContext context) throws IOException, InterruptedException, ReactorException { this(root,context,null); } @@ -610,7 +598,7 @@ public class Jenkins extends Node implements ItemGroup, StaplerPro * @param pluginManager * If non-null, use existing plugin manager. create a new one. */ - public Jenkins(File root, ServletContext context, PluginManager pluginManager) throws IOException, InterruptedException, ReactorException { + protected Jenkins(File root, ServletContext context, PluginManager pluginManager) throws IOException, InterruptedException, ReactorException { // As hudson is starting, grant this process full control SecurityContextHolder.getContext().setAuthentication(ACL.SYSTEM); try { @@ -1025,16 +1013,6 @@ public class Jenkins extends Node implements ItemGroup, StaplerPro return null; } - /** - * Gets all the installed {@link ItemListener}s. - * - * @deprecated as of 1.286. - * Use {@link ItemListener#all()}. - */ - public CopyOnWriteList getJobListeners() { - return itemListeners; - } - /** * Gets all the installed {@link SCMListener}s. */ @@ -1042,16 +1020,6 @@ public class Jenkins extends Node implements ItemGroup, StaplerPro return scmListeners; } - /** - * Gets all the installed {@link ComputerListener}s. - * - * @deprecated as of 1.286. - * Use {@link ComputerListener#all()}. - */ - public CopyOnWriteList getComputerListeners() { - return computerListeners; - } - /** * Gets the plugin object from its short name. * @@ -1153,7 +1121,7 @@ public class Jenkins extends Node implements ItemGroup, StaplerPro private final transient Object updateComputerLock = new Object(); /** - * Updates {@link #computers} by using {@link #getSlaves()}. + * Updates {@link #computers}. * *

* This method tries to reuse existing {@link Computer} objects @@ -1456,15 +1424,6 @@ public class Jenkins extends Node implements ItemGroup, StaplerPro return null; } - /** - * @deprecated - * UI method. Not meant to be used programatically. - */ - public ComputerSet getComputer() { - return new ComputerSet(); - } - - /** * Gets the label that exists on this system by the name. * @@ -1559,18 +1518,7 @@ public class Jenkins extends Node implements ItemGroup, StaplerPro return null; } - /** - * Gets the slave node of the give name, hooked under this Hudson. - * - * @deprecated - * Use {@link #getNode(String)}. Since 1.252. - */ - public Slave getSlave(String name) { - Node n = getNode(name); - if (n instanceof Slave) - return (Slave)n; - return null; - } + /** * Gets the slave node of the give name, hooked under this Hudson. @@ -1590,14 +1538,6 @@ public class Jenkins extends Node implements ItemGroup, StaplerPro return clouds.getByName(name); } - /** - * @deprecated - * Use {@link #getNodes()}. Since 1.252. - */ - public List getSlaves() { - return (List)Collections.unmodifiableList(slaves); - } - /** * Returns all {@link Node}s in the system, excluding {@link Jenkins} instance itself which * represents the master. @@ -1606,16 +1546,6 @@ public class Jenkins extends Node implements ItemGroup, StaplerPro return Collections.unmodifiableList(slaves); } - /** - * Updates the slave list. - * - * @deprecated - * Use {@link #setNodes(List)}. Since 1.252. - */ - public void setSlaves(List slaves) throws IOException { - setNodes(slaves); - } - /** * Adds one more {@link Node} to Hudson. */ @@ -1723,8 +1653,6 @@ public class Jenkins extends Node implements ItemGroup, StaplerPro return scmCheckoutRetryCount; } - - /** * @deprecated * Why are you calling a method that always returns ""? @@ -2024,29 +1952,7 @@ public class Jenkins extends Node implements ItemGroup, StaplerPro save(); } - /** - * @deprecated - * Left only for the compatibility of URLs. - * Should not be invoked for any other purpose. - */ - public TopLevelItem getJob(String name) { - return getItem(name); - } - /** - * @deprecated - * Used only for mapping jobs to URL in a case-insensitive fashion. - */ - public TopLevelItem getJobCaseInsensitive(String name) { - String match = Functions.toEmailSafeString(name); - for (Entry e : items.entrySet()) { - if(Functions.toEmailSafeString(e.getKey()).equalsIgnoreCase(match)) { - TopLevelItem item = e.getValue(); - return item.hasPermission(Item.READ) ? item : null; - } - } - return null; - } /** * {@inheritDoc}. @@ -2672,14 +2578,6 @@ public class Jenkins extends Node implements ItemGroup, StaplerPro getPrimaryView().doSubmitDescription(req, rsp); } - /** - * @deprecated as of 1.317 - * Use {@link #doQuietDown()} instead. - */ - public synchronized void doQuietDown(StaplerResponse rsp) throws IOException, ServletException { - doQuietDown().generateResponse(null, rsp, this); - } - public synchronized HttpRedirect doQuietDown() throws IOException { try { return doQuietDown(false,0); @@ -2906,17 +2804,6 @@ public class Jenkins extends Node implements ItemGroup, StaplerPro return new Slave.JnlpJar(req.getRestOfPath()); } - /** - * RSS feed for log entries. - * - * @deprecated - * As on 1.267, moved to "/log/rss..." - */ - public void doLogRss( StaplerRequest req, StaplerResponse rsp ) throws IOException, ServletException { - String qs = req.getQueryString(); - rsp.sendRedirect2("./log/rss"+(qs==null?"":'?'+qs)); - } - /** * Reloads the configuration. */ @@ -3367,62 +3254,6 @@ public class Jenkins extends Node implements ItemGroup, StaplerPro return FormValidation.error(Messages.Hudson_ViewAlreadyExists(view)); } - /** - * @deprecated as of 1.294 - * Define your own check method, instead of relying on this generic one. - */ - public void doFieldCheck(StaplerRequest req, StaplerResponse rsp) throws IOException, ServletException { - doFieldCheck( - fixEmpty(req.getParameter("value")), - fixEmpty(req.getParameter("type")), - fixEmpty(req.getParameter("errorText")), - fixEmpty(req.getParameter("warningText"))).generateResponse(req,rsp,this); - } - - /** - * Checks if the value for a field is set; if not an error or warning text is displayed. - * If the parameter "value" is not set then the parameter "errorText" is displayed - * as an error text. If the parameter "errorText" is not set, then the parameter "warningText" - * is displayed as a warning text. - *

- * If the text is set and the parameter "type" is set, it will validate that the value is of the - * correct type. Supported types are "number, "number-positive" and "number-negative". - * - * @deprecated as of 1.324 - * Either use client-side validation (e.g. class="required number") - * or define your own check method, instead of relying on this generic one. - */ - public FormValidation doFieldCheck(@QueryParameter(fixEmpty=true) String value, - @QueryParameter(fixEmpty=true) String type, - @QueryParameter(fixEmpty=true) String errorText, - @QueryParameter(fixEmpty=true) String warningText) { - if (value == null) { - if (errorText != null) - return FormValidation.error(errorText); - if (warningText != null) - return FormValidation.warning(warningText); - return FormValidation.error("No error or warning text was set for fieldCheck()."); - } - - if (type != null) { - try { - if (type.equalsIgnoreCase("number")) { - NumberFormat.getInstance().parse(value); - } else if (type.equalsIgnoreCase("number-positive")) { - if (NumberFormat.getInstance().parse(value).floatValue() <= 0) - return FormValidation.error(Messages.Hudson_NotAPositiveNumber()); - } else if (type.equalsIgnoreCase("number-negative")) { - if (NumberFormat.getInstance().parse(value).floatValue() >= 0) - return FormValidation.error(Messages.Hudson_NotANegativeNumber()); - } - } catch (ParseException e) { - return FormValidation.error(Messages.Hudson_NotANumber()); - } - } - - return FormValidation.ok(); - } - /** * Serves static resources placed along with Jelly view files. *

@@ -3479,22 +3310,6 @@ public class Jenkins extends Node implements ItemGroup, StaplerPro return !"ISO-8859-1".equalsIgnoreCase(System.getProperty("file.encoding")); } - /** - * @deprecated - * Use {@link Functions#isWindows()}. - */ - public static boolean isWindows() { - return File.pathSeparatorChar==';'; - } - - /** - * @deprecated - * Use {@link Platform#isDarwin()} - */ - public static boolean isDarwin() { - return Platform.isDarwin(); - } - /** * Rebuilds the dependency map. */ @@ -3674,56 +3489,6 @@ public class Jenkins extends Node implements ItemGroup, StaplerPro return Jenkins.getInstance().lookup.get(type); } - /** - * @deprecated since 2007-12-18. - * Use {@link #checkPermission(Permission)} - */ - public static boolean adminCheck() throws IOException { - return adminCheck(Stapler.getCurrentRequest(), Stapler.getCurrentResponse()); - } - - /** - * @deprecated since 2007-12-18. - * Use {@link #checkPermission(Permission)} - */ - public static boolean adminCheck(StaplerRequest req,StaplerResponse rsp) throws IOException { - if (isAdmin(req)) return true; - - rsp.sendError(StaplerResponse.SC_FORBIDDEN); - return false; - } - - /** - * Checks if the current user (for which we are processing the current request) - * has the admin access. - * - * @deprecated since 2007-12-18. - * This method is deprecated when Hudson moved from simple Unix root-like model - * of "admin gets to do everything, and others don't have any privilege" to more - * complex {@link ACL} and {@link Permission} based scheme. - * - *

- * For a quick migration, use {@code Hudson.getInstance().getACL().hasPermission(Hudson.ADMINISTER)} - * To check if the user has the 'administer' role in Hudson. - * - *

- * But ideally, your plugin should first identify a suitable {@link Permission} (or create one, - * if appropriate), then identify a suitable {@link AccessControlled} object to check its permission - * against. - */ - public static boolean isAdmin() { - return Jenkins.getInstance().getACL().hasPermission(ADMINISTER); - } - - /** - * @deprecated since 2007-12-18. - * Define a custom {@link Permission} and check against ACL. - * See {@link #isAdmin()} for more instructions. - */ - public static boolean isAdmin(StaplerRequest req) { - return isAdmin(); - } - /** * Live view of recent {@link LogRecord}s produced by Hudson. */