1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
|
Want to add a feature or automate something in your [NetBeans IDE](https://netbeans.org/)? Follow along as we write your first plugin for NetBeans.
Let's go beyond the simple [Toolbar Example](https://platform.netbeans.org/tutorials/nbm-google.html) and create a plugin which can auto-update itself.
This code is based on the [WakaTime plugin for NetBeans](https://github.com/wakatime/netbeans-wakatime). Our example plugin will simply print a Hello World statement and update to new versions if available... just enough to get you started.
## Create a new Plugin Project
Choose `File` -> `New Project` then `NetBeans Modules` -> `Module` as the project type.
Name your project
Choose a namespace or code name for your plugin
## Add a Java File
## Plugin Starting Point
After creating the new Java Class file, make it extend [ModuleInstall](http://bits.netbeans.org/7.4/javadoc/org-openide-modules/org/openide/modules/ModuleInstall.html) and wrap it with [@OnShowing](http://bits.netbeans.org/dev/javadoc/org-openide-windows/org/openide/windows/OnShowing.html) so it only runs after the GUI has loaded.
```java
@OnShowing
public class MyPlugin extends ModuleInstall implements Runnable {
}
```
Press <kbd>ALT</kbd> + <kbd>ENTER</kbd> with your cursor over `OnShowing` then select `Search Module Dependency for OnShowing` to import the Window System API into the project. This will add a new dependency to your project as well as add the necessary import statements to the top of your file. Also do this for `ModuleInstall`.
Sometimes NetBeans misses the `org.openide.util` dependency, so you might have to add that one manually. To do that, right click on <keyword>MyPlugin</keyword> then select `Properties`.
Choose category `Libraries` then click `Add...`. Type `org.openide.util` then click `OK`. This will add the dependency to your `project.xml` file.
Press <kbd>ALT</kbd> + <kbd>ENTER</kbd> on your <keyword>MyPlugin</keyword> class, then choose `Implement all abstract methods`.
One last thing, add this line to your `manifest.mf` file.
`OpenIDE-Module-Install: org/myorg/myplugin/MyPlugin.class`
Now the `run()` method will execute after your plugin has loaded.
## Logging
Let's make that `println` output to the NetBeans IDE log. First, setup the logger as an attribute of your <keyword>MyPlugin</keyword> class.
```java
public static final Logger log = Logger.getLogger("MyPlugin");
```
Press <kbd>ALT</kbd> + <kbd>ENTER</kbd> to import [java.util.logging.Logger](https://encrypted.google.com/search?q=java.util.logging.Logger+site%3Ahttps%3A%2F%2Fdocs.oracle.com).
Replace `println` with `log.info("MyPlugin has loaded.");`.
## Updating Your Plugin Automatically
Create a new Java file `UpdateHandler.java` inside your <keyword>MyPlugin</keyword> package.
Replace the contents of this file with [UpdateHandler.java](https://gist.github.com/alanhamlett/2a57ffb51f0850272d0d). Search the module dependency and add any missing dependencies by pressing <kbd>ALT</kbd> + <kbd>ENTER</kbd> over each import statement.
Add these lines to your `manifest.mf` file.
```java
OpenIDE-Module-Layer: org/myorg/myplugin/layer.xml
OpenIDE-Module-Implementation-Version: 201501010101
```
Create a new XML document in your <keyword>MyPlugin</keyword> package.
```java
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE filesystem PUBLIC "-//NetBeans//DTD Filesystem 1.2//EN" "http://www.netbeans.org/dtds/filesystem-1_2.dtd">
<filesystem>
<folder name="Services">
<folder name="AutoupdateType">
<file name="org_myorg_myplugin_update_center.instance">
<attr name="displayName" bundlevalue="org.myorg.myplugin.Bundle#Services/AutoupdateType/org_myorg_myplugin_update_center.instance"/>
<attr name="enabled" boolvalue="true"/>
<attr name="instanceCreate" methodvalue="org.netbeans.modules.autoupdate.updateprovider.AutoupdateCatalogFactory.createUpdateProvider"/>
<attr name="instanceOf" stringvalue="org.netbeans.spi.autoupdate.UpdateProvider"/>
<attr name="url" bundlevalue="org.myorg.myplugin.Bundle#org_myorg_myplugin_update_center"/>
</file>
</folder>
</folder>
</filesystem>
```
Add this code to your <keyword>MyPlugin</keyword> class inside the `run()` method.
```java
WindowManager.getDefault().invokeWhenUIReady(new Runnable () {
@Override
public void run() {
UpdateHandler.checkAndHandleUpdates();
}
});
```
Add these lines to your `Bundle.properties` file:
```java
Services/AutoupdateType/org_myorg_myplugin_update_center.instance=MyPlugin
UpdateHandler.NewModules=false
org_myorg_myplugin_update_center=https\://example.com/updates.xml
```
Now every time NetBeans restarts and launches your plugin, it will check for updates by downloading `updates.xml` from example.com.
Your updates.xml file tells NetBeans where to get the new NBM of your plugin.
To create an NBM for publishing your plugin, right click on your <keyword>MyPlugin</keyword> project and select `Create NBM`. The NBM file is what you will publish to the [NetBeans Plugin Portal](http://plugins.netbeans.org/).
For an example of hosting `updates.xml` on GitHub, look at [update.xml](https://github.com/wakatime/netbeans-wakatime/blob/master/updates.xml) and corrosponding [Bundle.properties](https://github.com/wakatime/netbeans-wakatime/blob/master/src/org/wakatime/netbeans/plugin/Bundle.properties) from the [WakaTime NetBeans plugin](https://github.com/wakatime/netbeans-wakatime/).
|
