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

Summary

Details

Page properties
Content
... ... @@ -99,75 +99,14 @@
99 99  
100 100  ##[[http://monitorhost:port/cgi-bin/WebObjects/JavaMonitor.woa/wa/statistics?pw=monitorpassword]]##
101 101  
102 -==== Direct Actions for Management Tasks ====
102 +==== Direct Actions to many tasks ====
103 103  
104 -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.
104 +You can do most of the standard tasks you do in Monitor by calling direct actions. They are in a different query handler, ///admin//. They follow the same format and use the same query parameters. Those DA can be useful if you need to restart instances or other tasks within ant or other build/deployment systems.
105 105  
106 -List of available direct actions :
106 +##?type=all## : returns details about all applications and instances
107 +##?type=app&name=AppName## : returns details about all instances of a specific application
108 +##?type=ins&name=AppName-InstanceNo## : returns details about one specific instance
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}}**##
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}}**##
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}}**##
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}}**##
126 -
127 -* **##clearDeaths##** : Returns **##OK##** after clearing deaths as specified
128 -##clearDeaths?**type=all**##
129 -##clearDeaths?**type=app&name={{color value="maroon"}}AppName{{/color}}**##
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}}**##
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}}**##
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}}**##
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 171  For example, if you want to get details about all instances and applications, you call :
172 172  
173 173  [[http://monitorhost:port9/cgi-bin/WebObjects/JavaMonitor.woa/admin/info?type=all]]
... ... @@ -180,9 +180,31 @@
180 180  
181 181  [[http://monitorhost:port/cgi-bin/WebObjects/JavaMonitor.woa/admin/info?type=ins&name=AjaxExample-1]]
182 182  
122 +The response for the direct actions will either send a JSON array or YES/NO. For example, the query //info// for all instances will return :
123 +
124 +{{code}}
125 +
126 +[Hudson Build Server for Wonder|http://webobjects.mdimension.com/hudson/job/Wonder54/lastSuccessfulBuild/artifact/dist/]
127 +
128 +{{/code}}
129 +
130 +List of available direct actions :
131 +
132 +///info// : return details (number of deaths, state, etc.; see above), in JSON, about an instance.
133 +///running// : return YES if the instance is running, NO if not.
134 +///stopped// : return NO if the instance is running, YES if not.
135 +///bounce//: more on it later.
136 +///clearDeaths// : clear the number of deaths (same action as clicking the "Clear deaths" in JavaMonitor)
137 +///turnScheduledOn// : turn scheduling on for an application or instance. Call ///turnScheduledOff// to do the opposite.
138 +///turnRefuseNewSessionsOn// : turn "Refuse new sessions" on, call //turnRefuseNewSessionsOff// to do the opposite.
139 +///turnAutoRecoverOn// : guess what? It activate "Auto recover" And guess again? ///turnAutoRecoverOff// do the opposite
140 +///forceQuit// : force quit an application, might be useful to call it from a monitoring system.
141 +///stop// : stop an application/instance the normal way.
142 +///start// : start an application/instance the normal way.
143 +
183 183  ==== Remote Control via REST Routes ====
184 184  
185 -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.
146 +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.
186 186  
187 187  Examples of REST calls :
188 188