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

From version 180.1
edited by Marc Guenther
on 2023/08/10 01:45
Change comment: fixed the download link to Jenkins
To version 175.1
edited by Maik Musall
on 2013/04/23 11:54
Change comment: see https://github.com/projectwonder/wonder/issues/426

Summary

Details

Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.marc
1 +XWiki.mmusall
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 serialized Property List 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 127  ==== Direct Actions in JavaMonitor 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 +##turnRefuseNewSessionsOff?##{{{}{*}type=all{*}}}
158 +##turnRefuseNewSessionsOff?##{{{}{*}type=app&name=*{}}}{{color value="maroon"}}{{{}{*}AppName{*}{}}}{{/color}}
159 +##turnRefuseNewSessionsOff?##{{{}{*}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 205  ==== Remote Control via REST Routes (for JavaMonitor) ====
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"}}
248 -
249 249  curl -X GET http://monitorhost:port/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/AjaxExample/addInstance&host=localhost
250 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}}
... ... @@ -272,217 +272,148 @@
272 272  
273 273  ==== Remote Control via REST Routes (for wotaskd) ====
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.
247 +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 ##?pw=XXXX## to the URLs if wotaskd is password protected.
276 276  
277 -{{code title="Fetching Details for All Applications" 0="none"}}
249 +{{code title="Fetching Details for All Applications"}}
278 278  
279 279  curl -X GET http://wotaskdhost:port/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications.json
280 280  
281 281  {{/code}}
282 282  
283 -(% class="auto-cursor-target" %)
284 -\\
255 +{{code title="Adding a New Application"}}
285 285  
286 -{{code title="Adding a New Application" 0="none"}}
287 -
288 288  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
289 289  
290 290  {{/code}}
291 291  
292 -(% class="auto-cursor-target" %)
293 -\\
261 +{{code title="Delete an Application"}}
294 294  
295 -{{code title="Delete an Application" 0="none"}}
296 -
297 297  curl -X DELETE http://wotaskdhost:port/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/AjaxExample.json
298 298  
299 299  {{/code}}
300 300  
301 -(% class="auto-cursor-target" %)
302 -\\
267 +{{code title="Adding a New Instance"}}
303 303  
304 -{{code title="Adding a New Instance" 0="none"}}
305 -
306 306  curl -X GET http://wotaskdhost:port/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/AjaxExample/addInstance&host=localhost
307 307  
308 308  {{/code}}
309 309  
310 -(% class="auto-cursor-target" %)
311 -\\
273 +{{code title="Delete an Instance"}}
312 312  
313 -{{code title="Delete an Instance" 0="none"}}
314 -
315 315  curl -X GET http://wotaskdhost:port/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/AjaxExample/deleteInstance?id=1
316 316  
317 317  {{/code}}
318 318  
319 -(% class="auto-cursor-target" %)
320 -\\
279 +{{code title="Configuring the Site"}}
321 321  
322 -{{code title="Configuring the Site" 0="none"}}
323 -
324 324  curl -X PUT -d "{woAdaptor:'www.mydomain.com'}" http://wotaskdhost:port/cgi-bin/WebObjects/JavaMonitor.woa/ra/mSiteConfig.json
325 325  
326 326  {{/code}}
327 327  
328 -(% class="auto-cursor-target" %)
329 -\\
285 +{{code title="Starting all applications"}}
330 330  
331 -{{code title="Starting all applications" 0="none"}}
332 -
333 333  curl -X GET http://wotaskdhost:port/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/start
334 334  
335 335  {{/code}}
336 336  
337 -(% class="auto-cursor-target" %)
338 -\\
291 +{{code title="Starting a specific application (AjaxExample in this example)"}}
339 339  
340 -{{code title="Starting a specific application (AjaxExample in this example)" 0="none"}}
341 -
342 342  curl -X GET http://wotaskdhost:port/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/AjaxExample/start
343 343  
344 344  {{/code}}
345 345  
346 -(% class="auto-cursor-target" %)
347 -\\
297 +{{code title="Starting a specific instance of an application (instance 1 of AjaxExample in this example)"}}
348 348  
349 -{{code title="Starting a specific instance of an application (instance 1 of AjaxExample in this example)" 0="none"}}
350 -
351 351  curl -X GET http://wotaskdhost:port/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/AjaxExample/start?id=1
352 352  
353 353  {{/code}}
354 354  
355 -(% class="auto-cursor-target" %)
356 -\\
303 +{{code title="Stopping all applications"}}
357 357  
358 -{{code title="Stopping all applications" 0="none"}}
359 -
360 360  curl -X GET http://wotaskdhost:port/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/stop
361 361  
362 362  {{/code}}
363 363  
364 -(% class="auto-cursor-target" %)
365 -\\
309 +{{code title="Stopping a specific application (AjaxExample in this example)"}}
366 366  
367 -{{code title="Stopping a specific application (AjaxExample in this example)" 0="none"}}
368 -
369 369  curl -X GET http://wotaskdhost:port/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/AjaxExample/stop
370 370  
371 371  {{/code}}
372 372  
373 -(% class="auto-cursor-target" %)
374 -\\
315 +{{code title="Stopping a specific instance of an application (instance 1 of AjaxExample in this example)"}}
375 375  
376 -{{code title="Stopping a specific instance of an application (instance 1 of AjaxExample in this example)" 0="none"}}
377 -
378 378  curl -X GET http://wotaskdhost:port/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/AjaxExample/stop?id=1
379 379  
380 380  {{/code}}
381 381  
382 -(% class="auto-cursor-target" %)
383 -\\
321 +{{code title="Force quit all applications"}}
384 384  
385 -{{code title="Force quit all applications" 0="none"}}
386 -
387 387  curl -X GET http://wotaskdhost:port/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/forceQuit
388 388  
389 389  {{/code}}
390 390  
391 -(% class="auto-cursor-target" %)
392 -\\
327 +{{code title="Force quit a specific application (AjaxExample in this example)"}}
393 393  
394 -{{code title="Force quit a specific application (AjaxExample in this example)" 0="none"}}
395 -
396 396  curl -X GET http://wotaskdhost:port/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/AjaxExample/forceQuit
397 397  
398 398  {{/code}}
399 399  
400 -(% class="auto-cursor-target" %)
401 -\\
333 +{{code title="Force quit a specific instance of an application (instance 1 of AjaxExample in this example)"}}
402 402  
403 -{{code title="Force quit a specific instance of an application (instance 1 of AjaxExample in this example)" 0="none"}}
404 -
405 405  curl -X GET http://wotaskdhost:port/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/AjaxExample/forceQuit?id=1
406 406  
407 407  {{/code}}
408 408  
409 -(% class="auto-cursor-target" %)
410 -\\
339 +{{code title="Information about all applications"}}
411 411  
412 -{{code title="Information about all applications" 0="none"}}
413 -
414 414  curl -X GET http://wotaskdhost:port/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/info
415 415  
416 416  {{/code}}
417 417  
418 -(% class="auto-cursor-target" %)
419 -\\
345 +{{code title="Information about a specific application (AjaxExample in this example)"}}
420 420  
421 -{{code title="Information about a specific application (AjaxExample in this example)" 0="none"}}
422 -
423 423  curl -X GET http://wotaskdhost:port/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/AjaxExample/info
424 424  
425 425  {{/code}}
426 426  
427 -(% class="auto-cursor-target" %)
428 -\\
351 +{{code title="Information about a specific instance of an application (instance 1 of AjaxExample in this example)"}}
429 429  
430 -{{code title="Information about a specific instance of an application (instance 1 of AjaxExample in this example)" 0="none"}}
431 -
432 432  curl -X GET http://wotaskdhost:port/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/AjaxExample/info?id=1
433 433  
434 434  {{/code}}
435 435  
436 -(% class="auto-cursor-target" %)
437 -\\
357 +{{code title="Check if all applications are running"}}
438 438  
439 -{{code title="Check if all applications are running" 0="none"}}
440 -
441 441  curl -X GET http://wotaskdhost:port/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/isRunning
442 442  
443 443  {{/code}}
444 444  
445 -(% class="auto-cursor-target" %)
446 -\\
363 +{{code title="Check if a specific application is running (AjaxExample in this example)"}}
447 447  
448 -{{code title="Check if a specific application is running (AjaxExample in this example)" 0="none"}}
449 -
450 450  curl -X GET http://wotaskdhost:port/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/AjaxExample/isRunning
451 451  
452 452  {{/code}}
453 453  
454 -(% class="auto-cursor-target" %)
455 -\\
369 +{{code title="Check if a specific instance of an application is running (instance 1 of AjaxExample in this example)"}}
456 456  
457 -{{code title="Check if a specific instance of an application is running (instance 1 of AjaxExample in this example)" 0="none"}}
458 -
459 459  curl -X GET http://wotaskdhost:port/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/AjaxExample/isRunning?id=1
460 460  
461 461  {{/code}}
462 462  
463 -(% class="auto-cursor-target" %)
464 -\\
375 +{{code title="Check if all applications are stopped"}}
465 465  
466 -{{code title="Check if all applications are stopped" 0="none"}}
467 -
468 468  curl -X GET http://wotaskdhost:port/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/isStopped
469 469  
470 470  {{/code}}
471 471  
472 -(% class="auto-cursor-target" %)
473 -\\
381 +{{code title="Check if a specific application is stopped (AjaxExample in this example)"}}
474 474  
475 -{{code title="Check if a specific application is stopped (AjaxExample in this example)" 0="none"}}
476 -
477 477  curl -X GET http://wotaskdhost:port/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/AjaxExample/isStopped
478 478  
479 479  {{/code}}
480 480  
481 -(% class="auto-cursor-target" %)
482 -\\
387 +{{code title="Check if a specific instance of an application is stopped (instance 1 of AjaxExample in this example)"}}
483 483  
484 -{{code title="Check if a specific instance of an application is stopped (instance 1 of AjaxExample in this example)" 0="none"}}
485 -
486 486  curl -X GET http://wotaskdhost:port/cgi-bin/WebObjects/JavaMonitor.woa/ra/mApplications/AjaxExample/isStopped?id=1
487 487  
488 488  {{/code}}
... ... @@ -489,4 +489,4 @@
489 489  
490 490  === Troubleshooting ===
491 491  
492 -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.
395 +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.