| <!-- |
| ~ Licensed to the Apache Software Foundation (ASF) under one |
| ~ or more contributor license agreements. See the NOTICE file |
| ~ distributed with this work for additional information |
| ~ regarding copyright ownership. The ASF licenses this file |
| ~ to you under the Apache License, Version 2.0 (the |
| ~ "License"); you may not use this file except in compliance |
| ~ with the License. You may obtain a copy of the License at |
| ~ |
| ~ http://www.apache.org/licenses/LICENSE-2.0 |
| ~ |
| ~ Unless required by applicable law or agreed to in writing, |
| ~ software distributed under the License is distributed on an |
| ~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| ~ KIND, either express or implied. See the License for the |
| ~ specific language governing permissions and limitations |
| ~ under the License. |
| --> |
| |
| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" |
| "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd"> |
| <html> |
| <head> |
| <meta http-equiv="content-type" content=""/> |
| <title>The SOAP Monitor Module</title> |
| <link href="../css/axis-docs.css" rel="stylesheet" type="text/css" |
| media="all"/> |
| </head> |
| |
| <body> |
| <h1>Using the SOAP Monitor</h1> |
| |
| <p>Web service developers often want to see the SOAP messages that are being |
| used to invoke the Web services, along with the results of those messages. |
| The goal of the SOAP Monitor utility is to provide a way for the developers |
| to monitor these SOAP messages without requiring any special configuration or |
| restarting the server.</p> |
| |
| <p>In this utility, a handler has been written and added to the global |
| handler chain. As SOAP requests and responses are received, the SOAP message |
| information is forwarded to a SOAP monitor service where it can be displayed |
| using a Web browser interface. The SOAP message information is accessed by a |
| Web browser by going to http://localhost:8080/axis2/SOAPMonitor (where 8080 |
| is the port number where the application server is running). The SOAP message |
| information is displayed through a Web browser by using an applet that opens |
| a socket connection to the SOAP monitor service. This applet requires a Java |
| plug-in 1.3 or higher to be installed in your browser. If you do not have a |
| correct plug-in, the browser will prompt you to install one. The port used by |
| the SOAP monitor service to communicate with applets is configurable. Edit |
| the web.xml file to change the port used by the Axis2 Web application.</p> |
| |
| <p>The SOAP Monitor module (soapmonitor.mar) is available in the axis2.war |
| but it is not engaged by default. The SOAP Monitor is NOT enabled by default |
| for security reasons.</p> |
| |
| <p>The SOAP Monitor can be engaged by inserting the following in the |
| axis2.xml file.</p> |
| <source><pre> <module ref="soapmonitor"/></pre> |
| </source> |
| <p>In the axis2.xml file, define your phase orders for the 'soapmonitorPhase' |
| referenced in the module.xml of soapmonitor.mars. Below is an example which |
| should NOT be copied exactly, since the default phases change occasionally. |
| The important point here is that 'soapmonitorPhase' should be placed under |
| the 'user can add his own phases to this area' comment in the 'inflow', |
| 'outflow', 'INfaultflow', and 'Outfaultflow' sections.</p> |
| <pre> <phaseOrder type="inflow"> |
| <!--System pre defined phases--> |
| <phase name="TransportIn"/> |
| <phase name="PreDispatch"/> |
| <phase name="Dispatch" class="org.apache.axis2.engine.DispatchPhase"> |
| <handler name="AddressingBasedDispatcher" |
| class="org.apache.axis2.dispatchers.AddressingBasedDispatcher"> |
| <order phase="Dispatch"/> |
| </handler> |
| <handler name="RequestURIBasedDispatcher" |
| class="org.apache.axis2.dispatchers.RequestURIBasedDispatcher"> |
| <order phase="Dispatch"/> |
| </handler> |
| <handler name="SOAPActionBasedDispatcher" |
| class="org.apache.axis2.dispatchers.SOAPActionBasedDispatcher"> |
| <order phase="Dispatch"/> |
| </handler> |
| <handler name="SOAPMessageBodyBasedDispatcher" |
| class="org.apache.axis2.dispatchers.SOAPMessageBodyBasedDispatcher"> |
| <order phase="Dispatch"/> |
| </handler> |
| <handler name="InstanceDispatcher" |
| class="org.apache.axis2.engine.InstanceDispatcher"> |
| <order phase="PostDispatch"/> |
| </handler> |
| </phase> |
| <!--System pre defined phases--> |
| <!--After Postdispatch phase module author or or service author can add any phase he want--> |
| <phase name="userphase1"/> |
| <phase name="soapmonitorPhase"/> |
| </phaseOrder> |
| <phaseOrder type="outflow"> |
| <!--user can add his own phases to this area--> |
| <phase name="userphase1"/> |
| <phase name="soapmonitorPhase"/> |
| <!--system predefined phase--> |
| <!--these phase will run irrespective of the service--> |
| <phase name="PolicyDetermination"/> |
| <phase name="MessageOut"/> |
| </phaseOrder> |
| <phaseOrder type="INfaultflow"> |
| <!--user can add his own phases to this area--> |
| <phase name="userphase1"/> |
| <phase name="soapmonitorPhase"/> |
| </phaseOrder> |
| <phaseOrder type="Outfaultflow"> |
| <!--user can add his own phases to this area--> |
| <phase name="userphase1"/> |
| <phase name="soapmonitorPhase"/> |
| <phase name="PolicyDetermination"/> |
| <phase name="MessageOut"/> |
| </phaseOrder></pre> |
| |
| <p>To configure the servlet to communicate with the applet, add the following |
| code to the web.xml (The SOAPMonitorPort is configurable.):</p> |
| <pre> <servlet> |
| <servlet-name>SOAPMonitorService</servlet-name> |
| <display-name>SOAPMonitorService</display-name> |
| <servlet-class> |
| org.apache.axis2.soapmonitor.servlet.SOAPMonitorService |
| </servlet-class> |
| <init-param> |
| <param-name>SOAPMonitorPort</param-name> |
| <param-value>5001</param-value> |
| </init-param> |
| <load-on-startup>1</load-on-startup> |
| </servlet> |
| |
| <servlet-mapping> |
| <servlet-name>SOAPMonitorService</servlet-name> |
| <url-pattern>/SOAPMonitor</url-pattern> |
| </servlet-mapping></pre> |
| |
| <p>Finally, compile the applet classes and place them at the root (eg: |
| <CATALINA_HOME>/webapps/axis2/) of the extracted WAR file. You can find |
| the SOAPMonitorApplet.java in the source distribution. To compile, use the |
| following command:</p> |
| <pre>javac -classpath axis2-soapmonitor.jar org/apache/axis2/soapmonitor/applet/SOAPMonitorApplet.java</pre> |
| |
| <p>Alternatively, you can directly get the <strong>compiled applet |
| classes</strong> from the WEB-INF/lib/soapmonitor-1.4.jar which is inside |
| the extracted axis2.war. To extract the soapmonitor-1.4.jar file, simply |
| execute the command, <code>jar -xf soapmonitor-1.4.jar</code> and place |
| the compiled applet classes in the root directory of the extracted WAR, for |
| example, in <CATALINA_HOME>/webapps/axis2/. NOTE: Starting with axis2 1.4, |
| the applets code is in the org.apache.axis2.soapmonitor.applet package. Therefore |
| the 'org' directory created by the unpacking of soapmonitor-1.4.jar should be placed |
| in <CATALINA_HOME>/webapps/axis2/ as shown in the above example.</p> |
| |
| <p>Using a Web browser, go to http[s]://host[:port][/webapp]/SOAPMonitor |
| (e.g.http://localhost:8080/axis2/SOAPMonitor) substituting the correct values |
| for your Web application. This will show the SOAP Monitor applet used to view |
| the service requests and responses. Any requests to services that have been |
| configured and deployed correctly should show up in the applet.</p> |
| |
| <p>The SOAPMonitor with attachments currently serializes themselves as base64 |
| characters. It is therefore recommended to use the TCPMon tool to correctly |
| capture MTOM and SWA messages as an multipart mime where the binary data is |
| an attachment.</p> |
| </body> |
| </html> |
