Skip to Content
Last modified by Pascal Robert on 2023/08/10 22:21
From version 87.1
edited by David Avendasora
on 2010/11/29 23:03
Change comment: There is no comment for this version
To version 89.1
edited by ted_archibald
on 2010/11/29 22:14
Change comment: There is no comment for this version

Summary

Details

Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.avendasora
1 +XWiki.ted_archibald
Content
... ... @@ -105,87 +105,49 @@
105 105  
106 106  List of available direct actions :
107 107  
108 -* **##info##** : Returns details (number of deaths, state, etc.), in JavaScript Object Notation (JSON) as specified
109 -##info?**type=all**##
110 -##info?**type=app&name={{color value="maroon"}}AppName{{/color}}**##
111 -##info?**type=ins&name={{color value="maroon"}}AppName{{/color}}-{{color value="maroon"}}InstanceNumber{{/color}}**##
108 +* {{{*}info{*}}} : returns the details (number of deaths, state, etc.; see example above), in JavaScript Object Notation (JSON)
109 +** ##**?type=all{**##} : Returns details about all instances of all applications
110 +** ##**?type=app&name=**{##}{{color value="maroon"}}{{{}{*}AppName{*}{}}}{{/color}} : Returns details about all instances of a specific application
111 +** ##**?type=ins&name=**{##}{{color value="maroon"}}{{{}{*}AppName{*}{}}}{{/color}}{{{}*\-*{}}}{{color value="maroon"}}{{{}{*}InstanceNumber{*}{}}}{{/color}} : Returns details about one specific instance
112 +* {{{*}running{*}}} : Returns {{{*}YES{*}}} or {{{*}NO{*}}}
113 +** ##**?type=all{**##} : Returns {{{*}YES{*}}} if all instances of all applications are running
114 +** ##**?type=app&name=**{##}{{color value="maroon"}}{{{}{*}AppName{*}{}}}{{/color}} : Returns {{{*}YES{*}}} if all instances of the specified application are running
115 +** ##**?type=ins&name=**{##}{{color value="maroon"}}{{{}{*}AppName{*}{}}}{{/color}}{{{}*\-*{}}}{{color value="maroon"}}{{{}{*}InstanceNumber{*}{}}}{{/color}} : Returns {{{*}YES{*}}} if the instance of the specified application is running
116 +* {{{*}stopped{*}}} : return NO if the instance is running, YES if not.
117 +* {{{*}bounce{*}}} : more on it later.
118 +* {{{*}clearDeaths{*}}} : clear the number of deaths (same action as clicking the "Clear deaths" in JavaMonitor)
119 +* {{{*}turnScheduledOn{*}}} : turn scheduling on for an application or instance. Call ///turnScheduledOff// to do the opposite.
120 +* {{{*}turnRefuseNewSessionsOn{*}}} : turn "Refuse new sessions" on, call //turnRefuseNewSessionsOff// to do the opposite.
121 +* {{{*}turnAutoRecoverOn{*}}} : guess what? It activate "Auto recover" And guess again? ///turnAutoRecoverOff// do the opposite
122 +* {{{*}forceQuit{*}}} : force quit an application, might be useful to call it from a monitoring system.
123 +* {{{*}stop{*}}} : stop an application/instance the normal way.
124 +* {{{*}start{*}}} : start an application/instance the normal way.
112 112  
113 -* **##running##** : Returns **##YES##** if **all** of the specified are running, ##NO## if not
114 -##running?**type=all**##
115 -##running?**type=app&name={{color value="maroon"}}AppName{{/color}}**##
116 -##running?**type=ins&name={{color value="maroon"}}AppName{{/color}}-{{color value="maroon"}}InstanceNumber{{/color}}**##
126 +##?type=all## : returns details about all applications and instances
127 +##?type=app&name=AppName## : returns details about all instances of a specific application
128 +##?type=ins&name=AppName-InstanceNo## : returns details about one specific instance
117 117  
118 -* **##stopped##** : Returns **##YES##** if **all** the specified is running, **##NO##** if not.
119 -##stopped?**type=all**##
120 -##stopped?**type=app&name={{color value="maroon"}}AppName{{/color}}**##
121 -##stopped?**type=ins&name={{color value="maroon"}}AppName{{/color}}-{{color value="maroon"}}InstanceNumber{{/color}}**##
130 +For example, if you want to get details about all instances and applications, you call :
122 122  
123 -* **##bounce##** : Returns **##OK##** after Bouncing (see description above) as specified
124 -##bounce?**type=all**##
125 -##bounce?**type=app&name={{color value="maroon"}}AppName{{/color}}**##
132 +[[http://monitorhost:port9/cgi-bin/WebObjects/JavaMonitor.woa/admin/info?type=all]]
126 126  
127 -* **##clearDeaths##** : Returns **##OK##** after clearing deaths as specified
128 -##clearDeaths?**type=all**##
129 -##clearDeaths?**type=app&name={{color value="maroon"}}AppName{{/color}}**##
134 +To get details about the //AjaxExample// application :
130 130  
131 -* **##turnScheduledOn##** : Returns **##OK##** after turning on scheduling as specified. Call ///turnScheduledOff// to do the opposite.
132 -##turnScheduledOn?**type=all**##
133 -##turnScheduledOn?**type=app&name={{color value="maroon"}}AppName{{/color}}**##
134 -##turnScheduledOn?**type=ins&name={{color value="maroon"}}AppName{{/color}}-{{color value="maroon"}}InstanceNumber{{/color}}**##
136 +[[http://monitorhost:port/cgi-bin/WebObjects/JavaMonitor.woa/admin/info?type=app&name=AjaxExample]]
135 135  
136 -* **##turnRefuseNewSessionsOn##** : Returns **##OK##** after turning on "Refuse new sessions" as specified
137 -##turnRefuseNewSessionsOn?**type=all**##
138 -##turnRefuseNewSessionsOn?**type=app&name={{color value="maroon"}}AppName{{/color}}**##
139 -##turnRefuseNewSessionsOn?**type=ins&name={{color value="maroon"}}AppName{{/color}}-{{color value="maroon"}}InstanceNumber{{/color}}**##
138 +And for a specific instance :
140 140  
141 -* **##turnRefuseNewSessionsOff##** : Returns **##OK##** after turning off "Refuse new sessions" as specified
142 -##turnRefuseNewSessionsOn?**type=all**##
143 -##turnRefuseNewSessionsOn?**type=app&name={{color value="maroon"}}AppName{{/color}}**##
144 -##turnRefuseNewSessionsOn?**type=ins&name={{color value="maroon"}}AppName{{/color}}-{{color value="maroon"}}InstanceNumber{{/color}}**##
140 +[[http://monitorhost:port/cgi-bin/WebObjects/JavaMonitor.woa/admin/info?type=ins&name=AjaxExample-1]]
145 145  
146 -* **##turnAutoRecoverOn##** : Returns **##OK##** after turning on "Auto Recover" as specified
147 -##turnAutoRecoverOn?**type=all**##
148 -##turnAutoRecoverOn?**type=app&name={{color value="maroon"}}AppName{{/color}}**##
149 -##turnAutoRecoverOn?**type=ins&name={{color value="maroon"}}AppName{{/color}}-{{color value="maroon"}}InstanceNumber{{/color}}**##
150 -
151 -* **##turnAutoRecoverOff##** : Returns **##OK##** after turning off "Auto Recover" as specified
152 -##turnAutoRecoverOn?**type=all**##
153 -##turnAutoRecoverOn?**type=app&name={{color value="maroon"}}AppName{{/color}}**##
154 -##turnAutoRecoverOn?**type=ins&name={{color value="maroon"}}AppName{{/color}}-{{color value="maroon"}}InstanceNumber{{/color}}**##
155 -
156 -* **##forceQuit##** : Returns **##OK##** after force quitting as specified. This could be useful to call from a monitoring system.
157 -##forceQuit?**type=all**##
158 -##forceQuit?**type=app&name={{color value="maroon"}}AppName{{/color}}**##
159 -##forceQuit?**type=ins&name={{color value="maroon"}}AppName{{/color}}-{{color value="maroon"}}InstanceNumber{{/color}}**##
160 -
161 -* **##stop##** : Returns **##OK##** after calling "Stop" as specified
162 -##stop?**type=all**##
163 -##stop?**type=app&name={{color value="maroon"}}AppName{{/color}}**##
164 -##stop?**type=ins&name={{color value="maroon"}}AppName{{/color}}-{{color value="maroon"}}InstanceNumber{{/color}}**##
165 -
166 -* **##start##** : Returns **##OK##** after calling "Start" as specified
167 -##start?**type=all**##
168 -##start?**type=app&name={{color value="maroon"}}AppName{{/color}}**##
169 -##start?**type=ins&name={{color value="maroon"}}AppName{{/color}}-{{color value="maroon"}}InstanceNumber{{/color}}**##
170 -
171 -To get details about all instances of all applications:
172 -##http:~/~/monitorhost:port/cgi-bin/WebObjects/JavaMonitor.woa/admin/info?type=all##
173 -
174 -To get details about the **AjaxExample** application:
175 -##http:~/~/monitorhost:port/cgi-bin/WebObjects/JavaMonitor.woa/admin/info?type=app&name=AjaxExample##
176 -
177 -To get details about instance **1** of the **AjaxExample** application:
178 -##http:~/~/monitorhost:port/cgi-bin/WebObjects/JavaMonitor.woa/admin/info?type=ins&name=AjaxExample-1##
179 -
180 180  ==== Remote Control via REST Routes ====
181 181  
182 -If the control offered by the Direct Actions isn't enough, JavaMonitor allows additional control via [[REST>>WONDER: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.
144 +On September 28th 2010, REST routes were added in JavaMonitor. Those routes + the direct actions explained in this document allow you to control almost everything remotely (make sure that your JavaMonitor installation is secure). As the direct actions, append //?pw=XXXX// to the URLs if JavaMonitor is password protected.
183 183  
184 184  Examples of REST calls :
185 185  
186 186  {{code title="Adding a New Host"}}
187 187  
188 -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
150 +curl -X POST -d "{id: 'otherserver.com',type: 'MHost', osType: 'MACOSX',address: '192.168.20.5', name: 'otherserver.com'}" http://monitorhost:port/cgi-bin/WebObjects/JavaMonitor.woa/ra/mHosts.json
189 189  
190 190  {{/code}}
191 191