| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
| <!-- Generated by Apache Maven Doxia Site Renderer 1.3 at Jun 28, 2015 -->
|
| <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
| <head>
|
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
|
| <title>Apache Axis2 - |
| |
| The SOAP Monitor Module</title>
|
| <style type="text/css" media="all">
|
| @import url("../css/maven-base.css");
|
| @import url("../css/maven-theme.css");
|
| @import url("../css/site.css");
|
| </style>
|
| <link rel="stylesheet" href="../css/print.css" type="text/css" media="print" />
|
| <meta name="Date-Revision-yyyymmdd" content="20150628" />
|
| <meta http-equiv="Content-Language" content="en" />
|
| <meta http-equiv="content-type" content="" />
|
| </head>
|
| <body class="composite">
|
| <div id="banner">
|
| <a href="http://www.apache.org/" id="bannerLeft">
|
| <img src="http://www.apache.org/images/asf_logo_wide.png" alt="Apache Axis2" />
|
| </a>
|
| <a href=".././" id="bannerRight">
|
| <img src="../images/axis.jpg" alt="Apache Axis2" />
|
| </a>
|
| <div class="clear">
|
| <hr/>
|
| </div>
|
| </div>
|
| <div id="breadcrumbs">
|
|
|
|
|
| <div class="xleft">
|
| <span id="publishDate">Last Published: 2015-06-28</span>
|
| | <span id="projectVersion">Version: 1.6.3</span>
|
| </div>
|
| <div class="xright"> <a href="../index.html" title="Axis2/Java">Axis2/Java</a>
|
| |
|
| <a href="http://www.apache.org" class="externalLink" title="Apache">Apache</a>
|
|
|
|
|
| </div>
|
| <div class="clear">
|
| <hr/>
|
| </div>
|
| </div>
|
| <div id="leftColumn">
|
| <div id="navcolumn">
|
|
|
|
|
| <h5>Axis2/Java</h5>
|
| <ul>
|
| <li class="none">
|
| <a href="../index.html" title="Home">Home</a>
|
| </li>
|
| </ul>
|
| <h5>Downloads</h5>
|
| <ul>
|
| <li class="none">
|
| <a href="../download.cgi" title="Releases">Releases</a>
|
| </li>
|
| <li class="none">
|
| <a href="../modules/index.html" title="Modules">Modules</a>
|
| </li>
|
| <li class="none">
|
| <a href="../tools/index.html" title="Tools">Tools</a>
|
| </li>
|
| </ul>
|
| <h5>Documentation</h5>
|
| <ul>
|
| <li class="none">
|
| <a href="../docs/toc.html" title="Table of Contents">Table of Contents</a>
|
| </li>
|
| <li class="none">
|
| <a href="../docs/installationguide.html" title="Installation Guide">Installation Guide</a>
|
| </li>
|
| <li class="none">
|
| <a href="../docs/quickstartguide.html" title="QuickStart Guide">QuickStart Guide</a>
|
| </li>
|
| <li class="none">
|
| <a href="../docs/userguide.html" title="User Guide">User Guide</a>
|
| </li>
|
| <li class="none">
|
| <a href="../docs/jaxws-guide.html" title="JAXWS Guide">JAXWS Guide</a>
|
| </li>
|
| <li class="none">
|
| <a href="../docs/pojoguide.html" title="POJO Guide">POJO Guide</a>
|
| </li>
|
| <li class="none">
|
| <a href="../docs/spring.html" title="Spring Guide">Spring Guide</a>
|
| </li>
|
| <li class="none">
|
| <a href="../docs/webadminguide.html" title="Web Administrator's Guide">Web Administrator's Guide</a>
|
| </li>
|
| <li class="none">
|
| <a href="../docs/migration.html" title="Migration Guide (from Axis1)">Migration Guide (from Axis1)</a>
|
| </li>
|
| </ul>
|
| <h5>Resources</h5>
|
| <ul>
|
| <li class="none">
|
| <a href="../faq.html" title="FAQ">FAQ</a>
|
| </li>
|
| <li class="none">
|
| <a href="../articles.html" title="Articles">Articles</a>
|
| </li>
|
| <li class="none">
|
| <a href="http://wiki.apache.org/ws/FrontPage/Axis2/" class="externalLink" title="Wiki">Wiki</a>
|
| </li>
|
| <li class="none">
|
| <a href="../refLib.html" title="Reference Library">Reference Library</a>
|
| </li>
|
| <li class="none">
|
| <a href="../api/index.html" title="Online Java Docs">Online Java Docs</a>
|
| </li>
|
| </ul>
|
| <h5>Get Involved</h5>
|
| <ul>
|
| <li class="none">
|
| <a href="../overview.html" title="Overview">Overview</a>
|
| </li>
|
| <li class="none">
|
| <a href="../svn.html" title="Checkout the Source">Checkout the Source</a>
|
| </li>
|
| <li class="none">
|
| <a href="../mail-lists.html" title="Mailing Lists">Mailing Lists</a>
|
| </li>
|
| <li class="none">
|
| <a href="../release-process.html" title="Release Process">Release Process</a>
|
| </li>
|
| <li class="none">
|
| <a href="../guidelines.html" title="Developer Guidelines">Developer Guidelines</a>
|
| </li>
|
| <li class="none">
|
| <a href="../siteHowTo.html" title="Build the Site">Build the Site</a>
|
| </li>
|
| </ul>
|
| <h5>Project Information</h5>
|
| <ul>
|
| <li class="none">
|
| <a href="../team-list.html" title="Project Team">Project Team</a>
|
| </li>
|
| <li class="none">
|
| <a href="../issue-tracking.html" title="Issue Tracking">Issue Tracking</a>
|
| </li>
|
| <li class="none">
|
| <a href="http://svn.apache.org/viewvc/axis/axis2/java/core/trunk/" class="externalLink" title="Source Code">Source Code</a>
|
| </li>
|
| <li class="none">
|
| <a href="../thanks.html" title="Acknowledgements">Acknowledgements</a>
|
| </li>
|
| <li class="none">
|
| <a href="http://www.apache.org/licenses/LICENSE-2.0.html" class="externalLink" title="License">License</a>
|
| </li>
|
| <li class="none">
|
| <a href="http://www.apache.org/foundation/sponsorship.html" class="externalLink" title="Sponsorship">Sponsorship</a>
|
| </li>
|
| <li class="none">
|
| <a href="http://www.apache.org/foundation/thanks.html" class="externalLink" title="Thanks">Thanks</a>
|
| </li>
|
| <li class="none">
|
| <a href="http://www.apache.org/security/" class="externalLink" title="Security">Security</a>
|
| </li>
|
| </ul>
|
| <a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy">
|
| <img class="poweredBy" alt="Built by Maven" src="../images/logos/maven-feather.png" />
|
| </a>
|
|
|
|
|
| </div>
|
| </div>
|
| <div id="bodyColumn">
|
| <div id="contentBox">
|
| <!-- ~ 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. --><html> |
| |
| <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> |
| <div><pre> <module ref="soapmonitor"/></pre></div> |
| <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> |
| <div><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></div> |
| |
| <p>To configure the servlet to communicate with the applet, add the following |
| code to the web.xml (The SOAPMonitorPort is configurable.):</p> |
| <div><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></div> |
| |
| <p>Finally, the applet classes must be placed into the Web application so that |
| they can be loaded by the Web browser. You can get the compiled applet |
| classes from the WEB-INF/lib/axis2-soapmonitor-servlet-1.6.3.jar which is inside |
| the extracted axis2.war. To extract the content of the file, simply |
| execute the command, <tt>jar -xf axis2-soapmonitor-servlet-1.6.3.jar</tt>. |
| The applet code is in the org.apache.axis2.soapmonitor.applet package and therefore |
| the 'org' directory created by the unpacking of JAR file should be placed |
| in <CATALINA_HOME>/webapps/axis2/.</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> |
| |
| </html>
|
| </div>
|
| </div>
|
| <div class="clear">
|
| <hr/>
|
| </div>
|
| <div id="footer">
|
| <div class="xright">
|
| Copyright © 2004-2015
|
| <a href="http://www.apache.org/">The Apache Software Foundation</a>.
|
| All Rights Reserved.
|
|
|
| </div>
|
| <div class="clear">
|
| <hr/>
|
| </div>
|
| </div>
|
| </body>
|
| </html>
|