Last modified by Pascal Robert on 2023/08/10 22:21

From version 177.1
edited by Marc Guenther
on 2023/08/10 15:46
Change comment: wotaskd does not propagate its changes to Monitor
To version 172.1
edited by Pascal Robert
on 2012/08/09 11:42
Change comment: There is no comment for this version

Summary

Details

Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.marc
1 +XWiki.probert
Content
... ... @@ -1,9 +1,7 @@
1 -[[image:attach:WonderJavaMonitor.png]]
1 +[[image:WonderJavaMonitor.png||border="1"]]
2 2  
3 +{{toc}}{{/toc}}
3 3  
4 -
5 -{{toc/}}
6 -
7 7  === Introduction ===
8 8  
9 9  JavaMonitor is a web-based tool used to configure and maintain deployed WebObjects applications. It is capable of handling multiple WebObjects applications, multiple instances of each application, and multiple WebObjects Applications Servers. In most cases you'll have one instance of JavaMonitor controlling all instances of your applications, even if they are spread across multiple Application Servers.
... ... @@ -10,26 +10,25 @@
10 10  
11 11  wotaskd (WebObjects task daemon) is the WebObjects Deployment tool that manages the instances on an Application Server. It's used by Monitor to propagate site configuration changes throughout the site's application hosts.
12 12  
13 -Apple released the original wotaskd and JavaMonitor to the community as open source in WebObjects 5.4. The source was then quickly modified and included in Project Wonder. Substantial improvements in both functionality and look-and-feel have been made over the years. These improved versions of **wotaskd.woa** and **JavaMonitor.woa** are available as standard Wonder applications.
11 +Apple released the original wotaskd and JavaMonitor to the community as open source in WebObjects 5.4. The source was then quickly modified and included in Project Wonder. Substantial improvements in both functionality and look-and-feel have been made over the years. These improved versions of **wotaskd.woa** and **JavaMonitor.woa** are available as standard Wonder applications.
14 14  
15 15  === Where To Get Them ===
16 16  
17 -You can either download them pre-built from [[Wonder's Jenkins build server>>url:http://jenkins.wocommunity.org/job/Wonder7/lastSuccessfulBuild/||shape="rect"]] or build them from the source code.
15 +You can either download them pre-built from [[Wonder's Jenkins build server>>http://jenkins.wocommunity.org/job/Wonder/lastSuccessfulBuild/]] or build them from the source code.
18 18  
19 -To build them from the [[Wonder source code>>doc:WEB.Getting the Wonder Source Code]], simply run the following command from the Wonder directory at the root of the Wonder source.
17 +To build them from the [[Wonder source code>>Getting the Wonder Source Code]], simply run the following command from the Wonder directory at the root of the Wonder source.
20 20  
21 21  {{code}}
22 22  ant frameworks deployment.tools -Ddeployment.standalone=true
23 23  {{/code}}
24 24  
25 -(% class="auto-cursor-target" %)
26 -\\
27 -
28 28  {{info title="What this command does:"}}
29 -* **ant**: calls Apache Ant. It is assumed that you have this already installed.
30 -* **frameworks**: tells Ant to build the "frameworks" target. This may not be needed if you already have Wonder built and installed in a location Ant can find automatically.
31 -* **deployment.tools**: tells Ant to build the "deployment.tools" target. This is the target that builds both wotaskd.woa and JavaMonitor.woa. You absolutely need this one.
32 -* **-Ddeployment.standalone=true**: argument will embed the required Wonder and WebObjects frameworks in built applications. You need this to ensure that the required frameworks are embedded in the built applications.
24 +
25 +* *ant*: calls Apache Ant. It is assumed that you have this already installed.
26 +* *frameworks*: tells Ant to build the "frameworks" target. This may not be needed if you already have Wonder built and installed in a location Ant can find automatically.
27 +* *deployment.tools*: tells Ant to build the "deployment.tools" target. This is the target that builds both wotaskd.woa and JavaMonitor.woa. You absolutely need this one.
28 +* *\-Ddeployment.standalone=true*: argument will embed the required Wonder and WebObjects frameworks in built applications. You need this to ensure that the required frameworks are embedded in the built applications.
29 +
33 33  {{/info}}
34 34  
35 35  === Bug Fixes to Apple's Versions ===
... ... @@ -54,17 +54,19 @@
54 54  * Stop the active instances that are refusing new sessions when the minimum session count is reached
55 55  * Restart all but one of the instances that were just stopped and turn on "Auto-Recover"
56 56  
57 -This feature, from Pascal's understanding, allows you to upload new versions of your application, start up the new version and refuse sessions for the instances running on the older version. This is designed to work so that you always have just **one** inactive instance that is only used while the bounce is performed. While waiting for the existing sessions to end you will have only one instance of your app accepting new sessions; you need to determine if this is acceptable for your app or not.
54 +This feature, from Pascal's understanding, allows you to upload new versions of your application, start up the new version and refuse sessions for the instances running on the older version.  This is designed to work so that you always have just **one** inactive instance that is only used while the bounce is performed.  While waiting for the existing sessions to end you will have only one instance of your app accepting new sessions; you need to determine if this is acceptable for your app or not.
58 58  
59 59  {{warning title="Database Changes"}}
60 -It is uncertain what will happen if the new version of your application makes changes to your database schema (e.g., uses [[ERXMigrations>>doc:WO.Project WONDER-Frameworks-ERXMigration]]). The old instances may raise exceptions before they can gracefully shut down because the schema no longer matches what the old application's EOF expects. **Try it out on a test server first and then update this page so everyone knows!**
57 +
58 +It is uncertain what will happen if the new version of your application makes changes to your database schema (e.g., uses [ERXMigrations|WO:Project WONDER-Frameworks-ERXMigration]). The old instances may raise exceptions before they can gracefully shut down because the schema no longer matches what the old application's EOF expects. *Try it out on a test server first and then update this page so everyone knows\!*
59 +
61 61  {{/warning}}
62 62  
63 63  ==== Statistics ====
64 64  
65 -If you call [[http:~~/~~/monitorhost:port/cgi-bin/WebObjects/JavaMonitor.woa/wa/statistics>>url:http://monitorhostport||shape="rect"]]{{code language="none"}}{{/code}}, JavaMonitor will send you back statistics, in serialized Property List format, about instances, per application.
64 +If you call ##[[http://monitorhost:port/cgi-bin/WebObjects/JavaMonitor.woa/wa/statistics]]##, JavaMonitor will send you back statistics, in JSON format, about instances, per application.
66 66  
67 -{{code title="Statistics Example Results" 0="none"}}
66 +{{code title="Statistics Example Results"}}
68 68  
69 69  (
70 70   {
... ... @@ -103,167 +103,140 @@
103 103  
104 104  {{/code}}
105 105  
106 -(% class="auto-cursor-target" %)
107 -\\
108 -
109 109  {{info}}
110 -If JavaMonitor is configured with a password, and I hope you do, pass //pw=monitorpassword// as a argument to the query :
111 111  
112 -(% class="auto-cursor-target" %)
113 -\\
107 +If JavaMonitor is configured with a password, and I hope you do, pass _pw=monitorpassword_ as a argument to the query :
114 114  
115 -{{code}}
116 -
109 +{code}
117 117  http://monitorhost:port/cgi-bin/WebObjects/JavaMonitor.woa/wa/statistics?pw=monitorpassword
118 118  
119 119  wget http://monitorhost:56789/cgi-bin/WebObjects/JavaMonitor.woa/admin/stop?type=app&name=InstanceName&pw=yourPassword
113 +{code}
120 120  
121 -{{/code}}
122 -
123 -(% class="auto-cursor-target" %)
124 -\\
125 125  {{/info}}
126 126  
127 -==== Direct Actions in JavaMonitor for Management Tasks ====
117 +==== Direct Actions for Management Tasks ====
128 128  
129 -You can do most of the standard management tasks you'd normally do in JavaMonitor's web UI by calling standard WebObjects Direct Actions. Instead of using the {{code language="none"}}/wa/{{/code}} request handler though, these management tasks use a new {{code language="none"}}/admin/{{/code}} request handler. These Direct Actions can be very useful, especially if you need to restart instances or other do tasks from the command line, from within Ant or other build or deployment systems.
119 +You can do most of the standard management tasks you'd normally do in JavaMonitor's web UI by calling standard WebObjects Direct Actions. Instead of using the ##/wa/## request handler though, these management tasks use a new ##/admin/## request handler. These Direct Actions can be very useful, especially if you need to restart instances or other do tasks from the command line, from within Ant or other build or deployment systems.
130 130  
131 131  List of available direct actions :
132 132  
133 -* **info**{{code language="none"}}{{/code}} : Returns details (number of deaths, state, etc.), in JavaScript Object Notation (JSON) as specified
134 -{{code language="none"}}info?{{/code}}**type=all**{{code language="none"}}{{/code}}
135 -{{code language="none"}}info?{{/code}}**type=app&name=**{{code language="none"}}{{/code}}(% style="color: maroon;" %)**AppName**{{code language="none"}}{{/code}}(%%)
136 -{{code language="none"}}info?{{/code}}**type=ins&name=**{{code language="none"}}{{/code}}(% style="color: maroon;" %)**AppName**{{code language="none"}}{{/code}}(%%)**-**{{code language="none"}}{{/code}}(% style="color: maroon;" %)**InstanceNumber**{{code language="none"}}{{/code}}
123 +* {{{*}info{*}}} : Returns details (number of deaths, state, etc.), in JavaScript Object Notation (JSON) as specified
124 +##info?##{{{}{*}type=all{*}}}
125 +##info?##{{{}{*}type=app&name=*{}}}{{color value="maroon"}}{{{}{*}AppName{*}{}}}{{/color}}
126 +##info?##{{{}{*}type=ins&name=*{}}}{{color value="maroon"}}{{{}{*}AppName{*}{}}}{{/color}}{{{}*\-*{}}}{{color value="maroon"}}{{{}{*}InstanceNumber{*}{}}}{{/color}}
137 137  
138 -* **running**{{code language="none"}}{{/code}} : Returns **YES**{{code language="none"}}{{/code}} if **all** of the specified are running, {{code language="none"}}NO{{/code}} if not
139 -{{code language="none"}}running?{{/code}}**type=all**{{code language="none"}}{{/code}}
140 -{{code language="none"}}running?{{/code}}**type=app&name=**{{code language="none"}}{{/code}}(% style="color: maroon;" %)**AppName**{{code language="none"}}{{/code}}(%%)
141 -{{code language="none"}}running?{{/code}}**type=ins&name=**{{code language="none"}}{{/code}}(% style="color: maroon;" %)**AppName**{{code language="none"}}{{/code}}(%%)**-**{{code language="none"}}{{/code}}(% style="color: maroon;" %)**InstanceNumber**{{code language="none"}}{{/code}}
128 +* {{{*}running{*}}} : Returns {{{*}YES{*}}} if **all** of the specified are running, ##NO## if not
129 +##running?##{{{}{*}type=all{*}}}
130 +##running?##{{{}{*}type=app&name=*{}}}{{color value="maroon"}}{{{}{*}AppName{*}{}}}{{/color}}
131 +##running?##{{{}{*}type=ins&name=*{}}}{{color value="maroon"}}{{{}{*}AppName{*}{}}}{{/color}}{{{}*\-*{}}}{{color value="maroon"}}{{{}{*}InstanceNumber{*}{}}}{{/color}}
142 142  
143 -* **stopped**{{code language="none"}}{{/code}} : Returns **YES**{{code language="none"}}{{/code}} if **all** the specified is running, **NO**{{code language="none"}}{{/code}} if not.
144 -{{code language="none"}}stopped?{{/code}}**type=all**{{code language="none"}}{{/code}}
145 -{{code language="none"}}stopped?{{/code}}**type=app&name=**{{code language="none"}}{{/code}}(% style="color: maroon;" %)**AppName**{{code language="none"}}{{/code}}(%%)
146 -{{code language="none"}}stopped?{{/code}}**type=ins&name=**{{code language="none"}}{{/code}}(% style="color: maroon;" %)**AppName**{{code language="none"}}{{/code}}(%%)**-**{{code language="none"}}{{/code}}(% style="color: maroon;" %)**InstanceNumber**{{code language="none"}}{{/code}}
133 +* {{{*}stopped{*}}} : Returns {{{*}YES{*}}} if **all** the specified is running, {{{*}NO{*}}} if not.
134 +##stopped?##{{{}{*}type=all{*}}}
135 +##stopped?##{{{}{*}type=app&name=*{}}}{{color value="maroon"}}{{{}{*}AppName{*}{}}}{{/color}}
136 +##stopped?##{{{}{*}type=ins&name=*{}}}{{color value="maroon"}}{{{}{*}AppName{*}{}}}{{/color}}{{{}*\-*{}}}{{color value="maroon"}}{{{}{*}InstanceNumber{*}{}}}{{/color}}
147 147  
148 -* **bounce**{{code language="none"}}{{/code}} : Returns **OK**{{code language="none"}}{{/code}} after Bouncing (see description above) as specified
149 -{{code language="none"}}bounce?{{/code}}**type=all**{{code language="none"}}{{/code}}
150 -{{code language="none"}}bounce?{{/code}}**type=app&name=**{{code language="none"}}{{/code}}(% style="color: maroon;" %)**AppName**{{code language="none"}}{{/code}}
138 +* {{{*}bounce{*}}} : Returns {{{*}OK{*}}} after Bouncing (see description above) as specified
139 +##bounce?##{{{}{*}type=all{*}}}
140 +##bounce?##{{{}{*}type=app&name=*{}}}{{color value="maroon"}}{{{}{*}AppName{*}{}}}{{/color}}
151 151  
152 -* **clearDeaths**{{code language="none"}}{{/code}} : Returns **OK**{{code language="none"}}{{/code}} after clearing deaths as specified
153 -{{code language="none"}}clearDeaths?{{/code}}**type=all**{{code language="none"}}{{/code}}
154 -{{code language="none"}}clearDeaths?{{/code}}**type=app&name=**{{code language="none"}}{{/code}}(% style="color: maroon;" %)**AppName**{{code language="none"}}{{/code}}
142 +* {{{*}clearDeaths{*}}} : Returns {{{*}OK{*}}} after clearing deaths as specified
143 +##clearDeaths?##{{{}{*}type=all{*}}}
144 +##clearDeaths?##{{{}{*}type=app&name=*{}}}{{color value="maroon"}}{{{}{*}AppName{*}{}}}{{/color}}
155 155  
156 -* **turnScheduledOn**{{code language="none"}}{{/code}} : Returns **OK**{{code language="none"}}{{/code}} after turning on scheduling as specified. Call ///turnScheduledOff// to do the opposite.
157 -{{code language="none"}}turnScheduledOn?{{/code}}**type=all**{{code language="none"}}{{/code}}
158 -{{code language="none"}}turnScheduledOn?{{/code}}**type=app&name=**{{code language="none"}}{{/code}}(% style="color: maroon;" %)**AppName**{{code language="none"}}{{/code}}(%%)
159 -{{code language="none"}}turnScheduledOn?{{/code}}**type=ins&name=**{{code language="none"}}{{/code}}(% style="color: maroon;" %)**AppName**{{code language="none"}}{{/code}}(%%)**-**{{code language="none"}}{{/code}}(% style="color: maroon;" %)**InstanceNumber**{{code language="none"}}{{/code}}
146 +* {{{*}turnScheduledOn{*}}} : Returns {{{*}OK{*}}} after turning on scheduling as specified. Call ///turnScheduledOff// to do the opposite.
147 +##turnScheduledOn?##{{{}{*}type=all{*}}}
148 +##turnScheduledOn?##{{{}{*}type=app&name=*{}}}{{color value="maroon"}}{{{}{*}AppName{*}{}}}{{/color}}
149 +##turnScheduledOn?##{{{}{*}type=ins&name=*{}}}{{color value="maroon"}}{{{}{*}AppName{*}{}}}{{/color}}{{{}*\-*{}}}{{color value="maroon"}}{{{}{*}InstanceNumber{*}{}}}{{/color}}
160 160  
161 -* **turnRefuseNewSessionsOn**{{code language="none"}}{{/code}} : Returns **OK**{{code language="none"}}{{/code}} after turning on "Refuse new sessions" as specified
162 -{{code language="none"}}turnRefuseNewSessionsOn?{{/code}}**type=all**{{code language="none"}}{{/code}}
163 -{{code language="none"}}turnRefuseNewSessionsOn?{{/code}}**type=app&name=**{{code language="none"}}{{/code}}(% style="color: maroon;" %)**AppName**{{code language="none"}}{{/code}}(%%)
164 -{{code language="none"}}turnRefuseNewSessionsOn?{{/code}}**type=ins&name=**{{code language="none"}}{{/code}}(% style="color: maroon;" %)**AppName**{{code language="none"}}{{/code}}(%%)**-**{{code language="none"}}{{/code}}(% style="color: maroon;" %)**InstanceNumber**{{code language="none"}}{{/code}}
151 +* {{{*}turnRefuseNewSessionsOn{*}}} : Returns {{{*}OK{*}}} after turning on "Refuse new sessions" as specified
152 +##turnRefuseNewSessionsOn?##{{{}{*}type=all{*}}}
153 +##turnRefuseNewSessionsOn?##{{{}{*}type=app&name=*{}}}{{color value="maroon"}}{{{}{*}AppName{*}{}}}{{/color}}
154 +##turnRefuseNewSessionsOn?##{{{}{*}type=ins&name=*{}}}{{color value="maroon"}}{{{}{*}AppName{*}{}}}{{/color}}{{{}*\-*{}}}{{color value="maroon"}}{{{}{*}InstanceNumber{*}{}}}{{/color}}
165 165  
166 -* **turnRefuseNewSessionsOff**{{code language="none"}}{{/code}} : Returns **OK**{{code language="none"}}{{/code}} after turning off "Refuse new sessions" as specified
167 -{{code language="none"}}turnRefuseNewSessionsOff?{{/code}}**type=all**{{code language="none"}}{{/code}}
168 -{{code language="none"}}turnRefuseNewSessionsOff?{{/code}}**type=app&name=**{{code language="none"}}{{/code}}(% style="color: maroon;" %)**AppName**{{code language="none"}}{{/code}}(%%)
169 -{{code language="none"}}turnRefuseNewSessionsOff?{{/code}}**type=ins&name=**{{code language="none"}}{{/code}}(% style="color: maroon;" %)**AppName**{{code language="none"}}{{/code}}(%%)**-**{{code language="none"}}{{/code}}(% style="color: maroon;" %)**InstanceNumber**{{code language="none"}}{{/code}}
156 +* {{{*}turnRefuseNewSessionsOff{*}}} : Returns {{{*}OK{*}}} after turning off "Refuse new sessions" as specified
157 +##turnRefuseNewSessionsOn?##{{{}{*}type=all{*}}}
158 +##turnRefuseNewSessionsOn?##{{{}{*}type=app&name=*{}}}{{color value="maroon"}}{{{}{*}AppName{*}{}}}{{/color}}
159 +##turnRefuseNewSessionsOn?##{{{}{*}type=ins&name=*{}}}{{color value="maroon"}}{{{}{*}AppName{*}{}}}{{/color}}{{{}*\-*{}}}{{color value="maroon"}}{{{}{*}InstanceNumber{*}{}}}{{/color}}
170 170  
171 -* **turnAutoRecoverOn**{{code language="none"}}{{/code}} : Returns **OK**{{code language="none"}}{{/code}} after turning on "Auto Recover" as specified
172 -{{code language="none"}}turnAutoRecoverOn?{{/code}}**type=all**{{code language="none"}}{{/code}}
173 -{{code language="none"}}turnAutoRecoverOn?{{/code}}**type=app&name=**{{code language="none"}}{{/code}}(% style="color: maroon;" %)**AppName**{{code language="none"}}{{/code}}(%%)
174 -{{code language="none"}}turnAutoRecoverOn?{{/code}}**type=ins&name=**{{code language="none"}}{{/code}}(% style="color: maroon;" %)**AppName**{{code language="none"}}{{/code}}(%%)**-**{{code language="none"}}{{/code}}(% style="color: maroon;" %)**InstanceNumber**{{code language="none"}}{{/code}}
161 +* {{{*}turnAutoRecoverOn{*}}} : Returns {{{*}OK{*}}} after turning on "Auto Recover" as specified
162 +##turnAutoRecoverOn?##{{{}{*}type=all{*}}}
163 +##turnAutoRecoverOn?##{{{}{*}type=app&name=*{}}}{{color value="maroon"}}{{{}{*}AppName{*}{}}}{{/color}}
164 +##turnAutoRecoverOn?##{{{}{*}type=ins&name=*{}}}{{color value="maroon"}}{{{}{*}AppName{*}{}}}{{/color}}{{{}*\-*{}}}{{color value="maroon"}}{{{}{*}InstanceNumber{*}{}}}{{/color}}
175 175  
176 -* **turnAutoRecoverOff**{{code language="none"}}{{/code}} : Returns **OK**{{code language="none"}}{{/code}} after turning off "Auto Recover" as specified
177 -{{code language="none"}}turnAutoRecoverOn?{{/code}}**type=all**{{code language="none"}}{{/code}}
178 -{{code language="none"}}turnAutoRecoverOn?{{/code}}**type=app&name=**{{code language="none"}}{{/code}}(% style="color: maroon;" %)**AppName**{{code language="none"}}{{/code}}(%%)
179 -{{code language="none"}}turnAutoRecoverOn?{{/code}}**type=ins&name=**{{code language="none"}}{{/code}}(% style="color: maroon;" %)**AppName**{{code language="none"}}{{/code}}(%%)**-**{{code language="none"}}{{/code}}(% style="color: maroon;" %)**InstanceNumber**{{code language="none"}}{{/code}}
166 +* {{{*}turnAutoRecoverOff{*}}} : Returns {{{*}OK{*}}} after turning off "Auto Recover" as specified
167 +##turnAutoRecoverOn?##{{{}{*}type=all{*}}}
168 +##turnAutoRecoverOn?##{{{}{*}type=app&name=*{}}}{{color value="maroon"}}{{{}{*}AppName{*}{}}}{{/color}}
169 +##turnAutoRecoverOn?##{{{}{*}type=ins&name=*{}}}{{color value="maroon"}}{{{}{*}AppName{*}{}}}{{/color}}{{{}*\-*{}}}{{color value="maroon"}}{{{}{*}InstanceNumber{*}{}}}{{/color}}
180 180  
181 -* **forceQuit**{{code language="none"}}{{/code}} : Returns **OK**{{code language="none"}}{{/code}} after force quitting as specified. This could be useful to call from a monitoring system.
182 -{{code language="none"}}forceQuit?{{/code}}**type=all**{{code language="none"}}{{/code}}
183 -{{code language="none"}}forceQuit?{{/code}}**type=app&name=**{{code language="none"}}{{/code}}(% style="color: maroon;" %)**AppName**{{code language="none"}}{{/code}}(%%)
184 -{{code language="none"}}forceQuit?{{/code}}**type=ins&name=**{{code language="none"}}{{/code}}(% style="color: maroon;" %)**AppName**{{code language="none"}}{{/code}}(%%)**-**{{code language="none"}}{{/code}}(% style="color: maroon;" %)**InstanceNumber**{{code language="none"}}{{/code}}
171 +* {{{*}forceQuit{*}}} : Returns {{{*}OK{*}}} after force quitting as specified. This could be useful to call from a monitoring system.
172 +##forceQuit?##{{{}{*}type=all{*}}}
173 +##forceQuit?##{{{}{*}type=app&name=*{}}}{{color value="maroon"}}{{{}{*}AppName{*}{}}}{{/color}}
174 +##forceQuit?##{{{}{*}type=ins&name=*{}}}{{color value="maroon"}}{{{}{*}AppName{*}{}}}{{/color}}{{{}*\-*{}}}{{color value="maroon"}}{{{}{*}InstanceNumber{*}{}}}{{/color}}
185 185  
186 -* **stop**{{code language="none"}}{{/code}} : Returns **OK**{{code language="none"}}{{/code}} after calling "Stop" as specified
187 -{{code language="none"}}stop?{{/code}}**type=all**{{code language="none"}}{{/code}}
188 -{{code language="none"}}stop?{{/code}}**type=app&name=**{{code language="none"}}{{/code}}(% style="color: maroon;" %)**AppName**{{code language="none"}}{{/code}}(%%)
189 -{{code language="none"}}stop?{{/code}}**type=ins&name=**{{code language="none"}}{{/code}}(% style="color: maroon;" %)**AppName**{{code language="none"}}{{/code}}(%%)**-**{{code language="none"}}{{/code}}(% style="color: maroon;" %)**InstanceNumber**{{code language="none"}}{{/code}}
176 +* {{{*}stop{*}}} : Returns {{{*}OK{*}}} after calling "Stop" as specified
177 +##stop?##{{{}{*}type=all{*}}}
178 +##stop?##{{{}{*}type=app&name=*{}}}{{color value="maroon"}}{{{}{*}AppName{*}{}}}{{/color}}
179 +##stop?##{{{}{*}type=ins&name=*{}}}{{color value="maroon"}}{{{}{*}AppName{*}{}}}{{/color}}{{{}*\-*{}}}{{color value="maroon"}}{{{}{*}InstanceNumber{*}{}}}{{/color}}
190 190  
191 -* **start**{{code language="none"}}{{/code}} : Returns **OK**{{code language="none"}}{{/code}} after calling "Start" as specified
192 -{{code language="none"}}start?{{/code}}**type=all**{{code language="none"}}{{/code}}
193 -{{code language="none"}}start?{{/code}}**type=app&name=**{{code language="none"}}{{/code}}(% style="color: maroon;" %)**AppName**{{code language="none"}}{{/code}}(%%)
194 -{{code language="none"}}start?{{/code}}**type=ins&name=**{{code language="none"}}{{/code}}(% style="color: maroon;" %)**AppName**{{code language="none"}}{{/code}}(%%)**-**{{code language="none"}}{{/code}}(% style="color: maroon;" %)**InstanceNumber**{{code language="none"}}{{/code}}
181 +* {{{*}start{*}}} : Returns {{{*}OK{*}}} after calling "Start" as specified
182 +##start?##{{{}{*}type=all{*}}}
183 +##start?##{{{}{*}type=app&name=*{}}}{{color value="maroon"}}{{{}{*}AppName{*}{}}}{{/color}}
184 +##start?##{{{}{*}type=ins&name=*{}}}{{color value="maroon"}}{{{}{*}AppName{*}{}}}{{/color}}{{{}*\-*{}}}{{color value="maroon"}}{{{}{*}InstanceNumber{*}{}}}{{/color}}
195 195  
196 196  To get details about all instances of all applications:
197 -[[http:~~/~~/monitorhost:port/cgi-bin/WebObjects/JavaMonitor.woa/admin/info?type=all>>url:http://monitorhostport||shape="rect"]]{{code language="none"}}{{/code}}
187 +##[[http://monitorhost:port/cgi-bin/WebObjects/JavaMonitor.woa/admin/info?type=all]]##
198 198  
199 199  To get details about the **AjaxExample** application:
200 -[[http:~~/~~/monitorhost:port/cgi-bin/WebObjects/JavaMonitor.woa/admin/info?type=app&name=AjaxExample>>url:http://monitorhostport||shape="rect"]]{{code language="none"}}{{/code}}
190 +##[[http://monitorhost:port/cgi-bin/WebObjects/JavaMonitor.woa/admin/info?type=app&name=AjaxExample]]##
201 201  
202 202  To get details about instance **1** of the **AjaxExample** application:
203 -[[http:~~/~~/monitorhost:port/cgi-bin/WebObjects/JavaMonitor.woa/admin/info?type=ins&name=AjaxExample-1>>url:http://monitorhostport||shape="rect"]]{{code language="none"}}{{/code}}
193 +##[[http://monitorhost:port/cgi-bin/WebObjects/JavaMonitor.woa/admin/info?type=ins&name=AjaxExample-1]]##
204 204  
205 -==== Remote Control via REST Routes (for JavaMonitor) ====
195 +==== Remote Control via REST Routes ====
206 206  
207 -If the control offered by the Direct Actions isn't enough, JavaMonitor allows additional control via [[REST>>doc:ERRest Framework]] calls. Between the two methods (Direct Actions, REST) you have almost full remote-control of JavaMonitor. Just make sure that your JavaMonitor installation is secure! Just like with Direct Actions, you need to append {{code language="none"}}?pw=XXXX{{/code}} to the URLs if your JavaMonitor is password protected.
197 +If the control offered by the Direct Actions isn't enough, JavaMonitor allows additional control via [[REST>>ERRest Framework]] calls. Between the two methods (Direct Actions, REST) you have almost full remote-control of JavaMonitor. Just make sure that your JavaMonitor installation is secure Just like with Direct Actions, you need to append ##?pw=XXXX## to the URLs if your JavaMonitor is password protected.
208 208  
209 209  Examples of REST calls :
210 210  
211 -{{code title="Adding a New Host" 0="none"}}
201 +{{code title="Adding a New Host"}}
212 212  
213 213  curl -X POST -d "{id: 'otherserver.com',type: 'MHost', osType: 'MACOSX',address: '192.168.20.5', name: 'otherserver.com'}" http://monitorhost:port/apps/WebObjects/JavaMonitor.woa/ra/mHosts.json
214 214  
215 215  {{/code}}
216 216  
217 -(% class="auto-cursor-target" %)
218 -\\
207 +{{code title="Fetching Details for All Applications"}}
219 219  
220 -{{code title="Fetching Details for All Applications" 0="none"}}
221 -
222 222  curl -X GET http://monitorhost:port/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications.json
223 223  
224 224  {{/code}}
225 225  
226 -(% class="auto-cursor-target" %)
227 -\\
213 +{{code title="Adding a New Application"}}
228 228  
229 -{{code title="Adding a New Application" 0="none"}}
230 -
231 231  curl -X POST -d "{id: 'AjaxExample',type: 'MApplication', name: 'AjaxExample',unixOutputPath: '/opt/Local/Library/WebObjects/Logs', unixPath: '/opt/Local/Library/WebObjects/Applications/AjaxExample.woa/AjaxExample'}" http://monitorhost:port/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications.json
232 232  
233 233  {{/code}}
234 234  
235 -(% class="auto-cursor-target" %)
236 -\\
219 +{{code title="Delete an Application"}}
237 237  
238 -{{code title="Delete an Application" 0="none"}}
239 -
240 240  curl -X DELETE http://monitorhost:port/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/AjaxExample.json
241 241  
242 242  {{/code}}
243 243  
244 -(% class="auto-cursor-target" %)
245 -\\
225 +{{code title="Adding a New Instance"}}
246 246  
247 -{{code title="Adding a New Instance" 0="none"}}
227 +curl -X GET http://monitorhost:port/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/AjaxExample/addInstance&host=localhost
248 248  
249 -curl -X GET http://monitorhost:port/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/AjaxExample/addInstance?host=localhost
250 -
251 251  {{/code}}
252 252  
253 -(% class="auto-cursor-target" %)
254 -\\
231 +{{code title="Delete an Instance"}}
255 255  
256 -{{code title="Delete an Instance" 0="none"}}
257 -
258 258  curl -X GET http://monitorhost:port/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/AjaxExample/deleteInstance?id=1
259 259  
260 260  {{/code}}
261 261  
262 -(% class="auto-cursor-target" %)
263 -\\
237 +{{code title="Configuring the Site"}}
264 264  
265 -{{code title="Configuring the Site" 0="none"}}
266 -
267 267  curl -X PUT -d "{woAdaptor:'www.mydomain.com'}" http://monitorhost:port/cgi-bin/WebObjects/JavaMonitor.woa/ra/mSiteConfig.json
268 268  
269 269  {{/code}}
... ... @@ -270,227 +270,10 @@
270 270  
271 271  Note that before configuring the site you must first add a host. If you attempt to configure the site prior to adding a host you will get an InvalidStateException.
272 272  
273 -==== Remote Control via REST Routes (for wotaskd) ====
245 +{{info}}
246 +Starting on August 9th 2012 (in the integration branch of Wonder), the REST routes are also available in wotaskd.
247 +{{/info}}
274 274  
275 -Starting on August 10th 2012, wotaskd also have REST routes. By using them, you can do most of the tasks using REST and you might not even need JavaMonitor. Just like the JavaMonitor REST and Direct Actions, you need to append {{code language="none"}}?pw=XXXX{{/code}} to the URLs if wotaskd is password protected.
276 -
277 -Unfortunately, all changes you make in {{code language="none"}}wotaskd{{/code}} via this API will not be picked up by an already running {{code language="none"}}JavaMonitor{{/code}}, making all the modification endpoints here mostly useless.
278 -
279 -\\
280 -
281 -{{code title="Fetching Details for All Applications" 0="none"}}
282 -
283 -curl -X GET http://wotaskdhost:port/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications.json
284 -
285 -{{/code}}
286 -
287 -(% class="auto-cursor-target" %)
288 -\\
289 -
290 -{{code title="Adding a New Application" 0="none"}}
291 -
292 -curl -X POST -d "{id: 'AjaxExample',type: 'MApplication', name: 'AjaxExample',unixOutputPath: '/opt/Local/Library/WebObjects/Logs', unixPath: '/opt/Local/Library/WebObjects/Applications/AjaxExample.woa/AjaxExample'}" http://wotaskdhost:port/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications.json
293 -
294 -{{/code}}
295 -
296 -(% class="auto-cursor-target" %)
297 -\\
298 -
299 -{{code title="Delete an Application" 0="none"}}
300 -
301 -curl -X DELETE http://wotaskdhost:port/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/AjaxExample.json
302 -
303 -{{/code}}
304 -
305 -(% class="auto-cursor-target" %)
306 -\\
307 -
308 -{{code title="Adding a New Instance" 0="none"}}
309 -
310 -curl -X GET http://wotaskdhost:port/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/AjaxExample/addInstance&host=localhost
311 -
312 -{{/code}}
313 -
314 -(% class="auto-cursor-target" %)
315 -\\
316 -
317 -{{code title="Delete an Instance" 0="none"}}
318 -
319 -curl -X GET http://wotaskdhost:port/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/AjaxExample/deleteInstance?id=1
320 -
321 -{{/code}}
322 -
323 -(% class="auto-cursor-target" %)
324 -\\
325 -
326 -{{code title="Configuring the Site" 0="none"}}
327 -
328 -curl -X PUT -d "{woAdaptor:'www.mydomain.com'}" http://wotaskdhost:port/cgi-bin/WebObjects/JavaMonitor.woa/ra/mSiteConfig.json
329 -
330 -{{/code}}
331 -
332 -(% class="auto-cursor-target" %)
333 -\\
334 -
335 -{{code title="Starting all applications" 0="none"}}
336 -
337 -curl -X GET http://wotaskdhost:port/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/start
338 -
339 -{{/code}}
340 -
341 -(% class="auto-cursor-target" %)
342 -\\
343 -
344 -{{code title="Starting a specific application (AjaxExample in this example)" 0="none"}}
345 -
346 -curl -X GET http://wotaskdhost:port/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/AjaxExample/start
347 -
348 -{{/code}}
349 -
350 -(% class="auto-cursor-target" %)
351 -\\
352 -
353 -{{code title="Starting a specific instance of an application (instance 1 of AjaxExample in this example)" 0="none"}}
354 -
355 -curl -X GET http://wotaskdhost:port/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/AjaxExample/start?id=1
356 -
357 -{{/code}}
358 -
359 -(% class="auto-cursor-target" %)
360 -\\
361 -
362 -{{code title="Stopping all applications" 0="none"}}
363 -
364 -curl -X GET http://wotaskdhost:port/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/stop
365 -
366 -{{/code}}
367 -
368 -(% class="auto-cursor-target" %)
369 -\\
370 -
371 -{{code title="Stopping a specific application (AjaxExample in this example)" 0="none"}}
372 -
373 -curl -X GET http://wotaskdhost:port/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/AjaxExample/stop
374 -
375 -{{/code}}
376 -
377 -(% class="auto-cursor-target" %)
378 -\\
379 -
380 -{{code title="Stopping a specific instance of an application (instance 1 of AjaxExample in this example)" 0="none"}}
381 -
382 -curl -X GET http://wotaskdhost:port/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/AjaxExample/stop?id=1
383 -
384 -{{/code}}
385 -
386 -(% class="auto-cursor-target" %)
387 -\\
388 -
389 -{{code title="Force quit all applications" 0="none"}}
390 -
391 -curl -X GET http://wotaskdhost:port/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/forceQuit
392 -
393 -{{/code}}
394 -
395 -(% class="auto-cursor-target" %)
396 -\\
397 -
398 -{{code title="Force quit a specific application (AjaxExample in this example)" 0="none"}}
399 -
400 -curl -X GET http://wotaskdhost:port/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/AjaxExample/forceQuit
401 -
402 -{{/code}}
403 -
404 -(% class="auto-cursor-target" %)
405 -\\
406 -
407 -{{code title="Force quit a specific instance of an application (instance 1 of AjaxExample in this example)" 0="none"}}
408 -
409 -curl -X GET http://wotaskdhost:port/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/AjaxExample/forceQuit?id=1
410 -
411 -{{/code}}
412 -
413 -(% class="auto-cursor-target" %)
414 -\\
415 -
416 -{{code title="Information about all applications" 0="none"}}
417 -
418 -curl -X GET http://wotaskdhost:port/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/info
419 -
420 -{{/code}}
421 -
422 -(% class="auto-cursor-target" %)
423 -\\
424 -
425 -{{code title="Information about a specific application (AjaxExample in this example)" 0="none"}}
426 -
427 -curl -X GET http://wotaskdhost:port/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/AjaxExample/info
428 -
429 -{{/code}}
430 -
431 -(% class="auto-cursor-target" %)
432 -\\
433 -
434 -{{code title="Information about a specific instance of an application (instance 1 of AjaxExample in this example)" 0="none"}}
435 -
436 -curl -X GET http://wotaskdhost:port/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/AjaxExample/info?id=1
437 -
438 -{{/code}}
439 -
440 -(% class="auto-cursor-target" %)
441 -\\
442 -
443 -{{code title="Check if all applications are running" 0="none"}}
444 -
445 -curl -X GET http://wotaskdhost:port/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/isRunning
446 -
447 -{{/code}}
448 -
449 -(% class="auto-cursor-target" %)
450 -\\
451 -
452 -{{code title="Check if a specific application is running (AjaxExample in this example)" 0="none"}}
453 -
454 -curl -X GET http://wotaskdhost:port/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/AjaxExample/isRunning
455 -
456 -{{/code}}
457 -
458 -(% class="auto-cursor-target" %)
459 -\\
460 -
461 -{{code title="Check if a specific instance of an application is running (instance 1 of AjaxExample in this example)" 0="none"}}
462 -
463 -curl -X GET http://wotaskdhost:port/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/AjaxExample/isRunning?id=1
464 -
465 -{{/code}}
466 -
467 -(% class="auto-cursor-target" %)
468 -\\
469 -
470 -{{code title="Check if all applications are stopped" 0="none"}}
471 -
472 -curl -X GET http://wotaskdhost:port/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/isStopped
473 -
474 -{{/code}}
475 -
476 -(% class="auto-cursor-target" %)
477 -\\
478 -
479 -{{code title="Check if a specific application is stopped (AjaxExample in this example)" 0="none"}}
480 -
481 -curl -X GET http://wotaskdhost:port/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/AjaxExample/isStopped
482 -
483 -{{/code}}
484 -
485 -(% class="auto-cursor-target" %)
486 -\\
487 -
488 -{{code title="Check if a specific instance of an application is stopped (instance 1 of AjaxExample in this example)" 0="none"}}
489 -
490 -curl -X GET http://wotaskdhost:port/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/AjaxExample/isStopped?id=1
491 -
492 -{{/code}}
493 -
494 494  === Troubleshooting ===
495 495  
496 -If JavaMonitor won't start up check the [[troubleshooting deployment>>doc:Troubleshooting Deployment]] section. In particular pay attention to the [[WOTaskd Didn't Start>>doc:Troubleshooting Deployment]] Q&A.
251 +If JavaMonitor won't start up check the [[troubleshooting deployment>>Troubleshooting Deployment]] section. In particular pay attention to the [[WOTaskd Didn't Start>>Troubleshooting Deployment]] Q&A.