| <html> |
| <!-- |
| |
| NO NO NO NO NO! |
| |
| ==============> DO NOT EDIT ME! <============== |
| |
| AUTOMATICALLY GENERATED FROM APICHANGES.XML, DO NOT EDIT |
| |
| SEE projects/projectapi/apichanges.xml |
| |
| --> |
| |
| <head> |
| <META http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| |
| <title>Change History for the Autoupdate Services API</title> |
| |
| <link rel="stylesheet" href="prose.css" type="text/css"> |
| |
| </head> |
| |
| <body> |
| |
| |
| <p class="overviewlink"> |
| <a href="overview-summary.html" shape="rect">Overview</a> |
| </p> |
| |
| |
| <h1>Introduction</h1> |
| |
| |
| <p>This document lists changes made to the <a href="../org-netbeans-modules-autoupdate-services/index.html" shape="rect">Autoupdate Services API</a>.</p> |
| |
| <!-- The actual lists of changes, as summaries and details: --> |
| |
| <hr> |
| |
| <h1> |
| <a name="list-all-apis">Index of APIs</a> |
| </h1> |
| <ul> |
| <li> |
| <a href="#general">Autoupdate Services API</a> |
| </li> |
| </ul> |
| <h1> |
| <a name="incompat-by-date">Incompatible changes by date</a> |
| </h1> |
| <p>Fuller descriptions of all changes can be found below (follow links).</p> |
| <p>Not all deprecations are listed here, assuming that the deprecated |
| APIs continue to essentially work. For a full deprecation list, please |
| consult the |
| <a href="deprecated-list.html">Javadoc</a>.</p> |
| <ul> |
| <li>(Apr 15 '09) <a href="#source-group-modifier">Feature enabled only when all its dependencies are enabled</a> |
| </li> |
| </ul> |
| <h1> |
| <a name="all-by-date">All changes by date</a> |
| </h1> |
| <ul> |
| <li>(Oct 31 '12) <a href="#visible-ancestor">Find a visible ancestor of UpdateUnit</a> |
| </li> |
| <li>(May 16 '12) <a href="#preffered-update">Mark an update as preferred just if needed</a> |
| </li> |
| <li>(May 16 '12) <a href="#content-description">Added a method to get a descprition of content of Upadate Center</a> |
| </li> |
| <li>(May 16 '12) <a href="#get-license-id">Added a method to get ID of license agreement</a> |
| </li> |
| <li>(May 16 '12) <a href="#check-write-permission">Check write permissions to installation directory</a> |
| </li> |
| <li>(May 14 '12) <a href="#nbm-external-size">Allowing to specify external NBM content size</a> |
| </li> |
| <li>(Feb 10 '11) <a href="#nbm-external">External NBM contents</a> |
| </li> |
| <li>(Jan 10 '11) <a href="#custom-icons">Icons for update centers</a> |
| </li> |
| <li>(Aug 19 '09) <a href="#new-operation-container">New operation type introduced together with method for create appropriate container</a> |
| </li> |
| <li>(Apr 15 '09) <a href="#source-group-modifier">Feature enabled only when all its dependencies are enabled</a> |
| </li> |
| </ul> |
| <h1> |
| <a name="all-by-version">Changes by version</a> |
| </h1> |
| <p> |
| These API specification versions may be used to indicate that a module |
| requires a certain API feature in order to function. For example, if you |
| see here a feature you need which is labelled <samp>1.20</samp>, your |
| manifest should contain in its main attributes the line: |
| </p> |
| <pre>OpenIDE-Module-Module-Dependencies: org.netbeans.modules.autoupdate.services > 1.20</pre> |
| <ul> |
| <li> |
| (1.37) <a href="#visible-ancestor">Find a visible ancestor of UpdateUnit</a> |
| </li> |
| <li> |
| (1.33) <a href="#preffered-update">Mark an update as preferred just if needed</a> |
| </li> |
| <li> |
| (1.33) <a href="#content-description">Added a method to get a descprition of content of Upadate Center</a> |
| </li> |
| <li> |
| (1.33) <a href="#get-license-id">Added a method to get ID of license agreement</a> |
| </li> |
| <li> |
| (1.33) <a href="#check-write-permission">Check write permissions to installation directory</a> |
| </li> |
| <li> |
| (1.32) <a href="#nbm-external-size">Allowing to specify external NBM content size</a> |
| </li> |
| <li> |
| (1.24) <a href="#nbm-external">External NBM contents</a> |
| </li> |
| <li> |
| (1.23) <a href="#custom-icons">Icons for update centers</a> |
| </li> |
| <li> |
| (1.11) <a href="#new-operation-container">New operation type introduced together with method for create appropriate container</a> |
| </li> |
| <li> |
| (1.8) <a href="#source-group-modifier">Feature enabled only when all its dependencies are enabled</a> |
| </li> |
| </ul> |
| <h1> |
| <a name="all-by-class">Changes by affected class</a> |
| </h1> |
| <h2> |
| <a name="org.netbeans.api.autoupdate.InstallSupport"><code><span style="color:gray">org.netbeans.api.autoupdate.</span>InstallSupport</code></a> |
| </h2><ul><li>(May 16 '12) <a href="#check-write-permission">Check write permissions to installation directory</a> |
| </li></ul><h2> |
| <a name="org.netbeans.api.autoupdate.OperationContainer"><code><span style="color:gray">org.netbeans.api.autoupdate.</span>OperationContainer</code></a> |
| </h2><ul><li>(Aug 19 '09) <a href="#new-operation-container">New operation type introduced together with method for create appropriate container</a> |
| </li></ul><h2> |
| <a name="org.netbeans.api.autoupdate.OperationException"><code><span style="color:gray">org.netbeans.api.autoupdate.</span>OperationException</code></a> |
| </h2><ul><li>(May 16 '12) <a href="#check-write-permission">Check write permissions to installation directory</a> |
| </li></ul><h2> |
| <a name="org.netbeans.api.autoupdate.OperationSupport"><code><span style="color:gray">org.netbeans.api.autoupdate.</span>OperationSupport</code></a> |
| </h2><ul><li>(Aug 19 '09) <a href="#new-operation-container">New operation type introduced together with method for create appropriate container</a> |
| </li></ul><h2> |
| <a name="org.netbeans.api.autoupdate.UpdateElement"><code><span style="color:gray">org.netbeans.api.autoupdate.</span>UpdateElement</code></a> |
| </h2><ul><li>(May 16 '12) <a href="#get-license-id">Added a method to get ID of license agreement</a> |
| </li> |
| <li>(Jan 10 '11) <a href="#custom-icons">Icons for update centers</a> |
| </li></ul><h2> |
| <a name="org.netbeans.spi.autoupdate.UpdateItem"><code><span style="color:gray">org.netbeans.spi.autoupdate.</span>UpdateItem</code></a> |
| </h2><ul><li>(May 16 '12) <a href="#preffered-update">Mark an update as preferred just if needed</a> |
| </li> |
| <li>(Apr 15 '09) <a href="#source-group-modifier">Feature enabled only when all its dependencies are enabled</a> |
| </li></ul><h2> |
| <a name="org.netbeans.api.autoupdate.UpdateUnit"><code><span style="color:gray">org.netbeans.api.autoupdate.</span>UpdateUnit</code></a> |
| </h2><ul><li>(Oct 31 '12) <a href="#visible-ancestor">Find a visible ancestor of UpdateUnit</a> |
| </li></ul><h2> |
| <a name="org.netbeans.api.autoupdate.UpdateUnitProvider"><code><span style="color:gray">org.netbeans.api.autoupdate.</span>UpdateUnitProvider</code></a> |
| </h2><ul><li>(May 16 '12) <a href="#content-description">Added a method to get a descprition of content of Upadate Center</a> |
| </li> |
| <li>(Jan 10 '11) <a href="#custom-icons">Icons for update centers</a> |
| </li></ul><hr> |
| <h1> |
| <a name="details-by-api">Details of all changes by API and date</a> |
| </h1> |
| <hr style="width:50%"> |
| <h2> |
| <a name="general">Autoupdate Services API</a> |
| </h2> |
| <!-- AUTOMATICALLY GENERATED - DO NOT EDIT ME! --> |
| <h3> |
| <a name="visible-ancestor">Find a visible ancestor of UpdateUnit</a> |
| </h3> |
| <em>Oct 31 '12; API spec. version: 1.37; affected top-level classes: <a href="./org/netbeans/api/autoupdate/UpdateUnit.html"><code>UpdateUnit</code></a>; made by: jrechtacek; issues: <a href="https://netbeans.org/bugzilla/show_bug.cgi?id=190246"> |
| #190246</a></em> |
| <br> |
| |
| <p> |
| Added a method {@link org.netbeans.api.autoupdate.UpdateUnit#getVisibleAncestor} which returns a visible plugin |
| which depending upon this unit. Returns a unit if this unit is installed in the system and some of visible |
| units depending upon this one, otherwise returns null. |
| </p> |
| <!-- AUTOMATICALLY GENERATED - DO NOT EDIT ME! --> |
| <h3> |
| <a name="preffered-update">Mark an update as preferred just if needed</a> |
| </h3> |
| <em>May 16 '12; API spec. version: 1.33; affected top-level classes: <a href="./org/netbeans/spi/autoupdate/UpdateItem.html"><code>UpdateItem</code></a>; made by: jrechtacek; issues: <a href="https://netbeans.org/bugzilla/show_bug.cgi?id=211734"> |
| #211734</a></em> |
| <br> |
| |
| <p> |
| Added a <code>preferredupdate</code> attribute into <code>Update Center Descriptor</code> |
| to specify if an update has to be installed before other updates or not. This flag is <b>off</b> as default. |
| </p> |
| <!-- AUTOMATICALLY GENERATED - DO NOT EDIT ME! --> |
| <h3> |
| <a name="content-description">Added a method to get a descprition of content of Upadate Center</a> |
| </h3> |
| <em>May 16 '12; API spec. version: 1.33; affected top-level classes: <a href="./org/netbeans/api/autoupdate/UpdateUnitProvider.html"><code>UpdateUnitProvider</code></a>; made by: jrechtacek; issues: <a href="https://netbeans.org/bugzilla/show_bug.cgi?id=211741"> |
| #211741</a></em> |
| <br> |
| |
| <p> |
| {@link org.netbeans.api.autoupdate.UpdateUnitProvider#getContentDescription} returns |
| a description of content staging by this provider. The description might contains HTML tags e.g. HTML Links. |
| </p> |
| <!-- AUTOMATICALLY GENERATED - DO NOT EDIT ME! --> |
| <h3> |
| <a name="get-license-id">Added a method to get ID of license agreement</a> |
| </h3> |
| <em>May 16 '12; API spec. version: 1.33; affected top-level classes: <a href="./org/netbeans/api/autoupdate/UpdateElement.html"><code>UpdateElement</code></a>; made by: jrechtacek; issues: <a href="https://netbeans.org/bugzilla/show_bug.cgi?id=211736"> |
| #211736</a></em> |
| <br> |
| |
| <p> |
| Added a method {@link org.netbeans.api.autoupdate.UpdateElement#getLicenseId} |
| to get ID of license agreement if the <code>UpdateElement</code> has a copyright. |
| </p> |
| |
| <p> |
| This ID could be stored somewhere once an user approves the license and |
| will not be asked for approval again the same license ID. |
| </p> |
| <!-- AUTOMATICALLY GENERATED - DO NOT EDIT ME! --> |
| <h3> |
| <a name="check-write-permission">Check write permissions to installation directory</a> |
| </h3> |
| <em>May 16 '12; API spec. version: 1.33; affected top-level classes: <a href="./org/netbeans/api/autoupdate/InstallSupport.html"><code>InstallSupport</code></a> <a href="./org/netbeans/api/autoupdate/OperationException.html"><code>OperationException</code></a>; made by: jrechtacek; issues: <a href="https://netbeans.org/bugzilla/show_bug.cgi?id=211777"> |
| #211777</a></em> |
| <br> |
| |
| <p> |
| |
| <code>InstallSupport</code> find out the right directory where a plugin |
| should be installed. After that it checks if an user has privilege to write there. |
| In the case a lack of write permission, throws |
| {@link org.netbeans.api.autoupdate.OperationException.WRITE_PERMISSION}. |
| </p> |
| |
| <p> |
| Beside this it allows to write into |
| <code>userdir</code> as a fallback in the case of insufficient privilege. |
| </p> |
| <!-- AUTOMATICALLY GENERATED - DO NOT EDIT ME! --> |
| <h3> |
| <a name="nbm-external-size">Allowing to specify external NBM content size</a> |
| </h3> |
| <em>May 14 '12; API spec. version: 1.32; made by: jlahoda; issues: <a href="https://netbeans.org/bugzilla/show_bug.cgi?id=212068"> |
| #212068</a></em> |
| <br> |
| |
| <p> |
| You can now specify the size of the external NBM content in the <code>.external</code> file |
| by using <code>SIZE:</code> property (e.g. <code>SIZE:42</code>). The size will then be incorporated |
| in the download size of the NBM. |
| </p> |
| <!-- AUTOMATICALLY GENERATED - DO NOT EDIT ME! --> |
| <h3> |
| <a name="nbm-external">External NBM contents</a> |
| </h3> |
| <em>Feb 10 '11; API spec. version: 1.24; made by: jtulach; issues: <a href="https://netbeans.org/bugzilla/show_bug.cgi?id=195041"> |
| #195041</a></em> |
| <br> |
| |
| <p> |
| You can now ask that publicly downloadable files be included in an NBM. |
| Just replace <code>netbeans/file</code> with a text file <code>netbeans/file.external</code> |
| with lines: |
| </p> |
| |
| <ol> |
| |
| <li> |
| <code>CRC:123456789</code> to specify an expected CRC-32 checksum (nonnegative decimal format)</li> |
| |
| <li> |
| <code>URL:http://.../...</code> to specify a download location (may be repeated to offer alternatives)</li> |
| |
| </ol> |
| |
| <p> |
| You can embed system properties in a URL using Ant-like syntax: <samp>http://.../feature-for-${java.specification.version}.nbm</samp> |
| |
| </p> |
| |
| <p> |
| The <code><makenbm></code> Ant task will automatically |
| avoid packing the actual file if the <code>*.external</code> |
| variant is also in the input cluster. |
| </p> |
| |
| <p> |
| For convenience, the <code>org.netbeans.modules.maven.embedder</code> |
| module (if present) can also handle URLs of the forms |
| <code>m2:/org.grp:art:1.0:jar</code> or <code>m2:/org.grp:art:1.0:jar:javadoc</code> |
| which can take advantage of the local repository as a cache. |
| </p> |
| <!-- AUTOMATICALLY GENERATED - DO NOT EDIT ME! --> |
| <h3> |
| <a name="custom-icons">Icons for update centers</a> |
| </h3> |
| <em>Jan 10 '11; API spec. version: 1.23; affected top-level classes: <a href="./org/netbeans/api/autoupdate/UpdateElement.html"><code>UpdateElement</code></a> <a href="./org/netbeans/api/autoupdate/UpdateUnitProvider.html"><code>UpdateUnitProvider</code></a>; made by: jtulach; issues: <a href="https://netbeans.org/bugzilla/show_bug.cgi?id=183778"> |
| #183778</a></em> |
| <br> |
| |
| <p> |
| Define icon when specifying an update center using |
| <code>categoryIconBase</code> attribute. |
| </p> |
| <!-- AUTOMATICALLY GENERATED - DO NOT EDIT ME! --> |
| <h3> |
| <a name="new-operation-container">New operation type introduced together with method for create appropriate container</a> |
| </h3> |
| <em>Aug 19 '09; API spec. version: 1.11; affected top-level classes: <a href="./org/netbeans/api/autoupdate/OperationSupport.html"><code>OperationSupport</code></a> <a href="./org/netbeans/api/autoupdate/OperationContainer.html"><code>OperationContainer</code></a>; made by: dlipin; issues: <a href="https://netbeans.org/bugzilla/show_bug.cgi?id=141714"> |
| #141714</a></em> |
| <br> |
| |
| <p> |
| New operation type - <code>OperationSupport.OperationType.INTERNAL_UPDATE</code> is introduced. |
| This operation can be used to find out elements which have updates and |
| which the particular element has the dependency on. |
| </p> |
| <!-- AUTOMATICALLY GENERATED - DO NOT EDIT ME! --> |
| <h3> |
| <a name="source-group-modifier">Feature enabled only when all its dependencies are enabled</a> |
| </h3> |
| <em>Apr 15 '09; API spec. version: 1.8; affected top-level classes: <a href="./org/netbeans/spi/autoupdate/UpdateItem.html"><code>UpdateItem</code></a>; made by: jtulach; issues: <a href="https://netbeans.org/bugzilla/show_bug.cgi?id=162673"> |
| #162673</a></em> |
| <br> |
| |
| <p> |
| The behaviour of <code>UpdateItem.createFeature().getInstalled().isEnabled()</code> |
| has been changed. Now it returns <code>true</code> only if |
| all dependencies are enabled. |
| </p> |
| |
| |
| |
| <hr> |
| <p><span class="footnote">Built on September 14 2018. | Copyright © 2017-2018 Apache Software Foundation. All Rights Reserved.</span></p> |
| |
| |
| </body> |
| |
| </html> |
