| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <html> |
| <head> |
| <META http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <link rel="stylesheet" href="../skin/tigris.css" type="text/css"> |
| <link rel="stylesheet" href="../skin/mysite.css" type="text/css"> |
| <link rel="stylesheet" href="../skin/site.css" type="text/css"> |
| <link media="print" rel="stylesheet" href="../skin/print.css" type="text/css"> |
| <title>WebServices - Axis</title> |
| </head> |
| <body bgcolor="white" class="composite"> |
| <div id="banner"> |
| <table width="100%" cellpadding="0" cellspacing="0" summary="banner" border="0"> |
| <tbody> |
| <tr> |
| <td align="left"> |
| <div class="groupLogo"> |
| <a href="http://ws.apache.org/"><img border="0" class="logoImage" alt="The Apache WebServices Project" src="../images/project-logo.png"></a> |
| </div> |
| </td><td nowrap="1" width="100%" align="left"> |
| <div class="projectTitleImg"> |
| <br> |
| <a href=""><img border="0" class="logoImage" alt="Web Services - Axis" src="../images/wsaxis.png"></a> |
| </div> |
| </td><td align="right"> |
| <div class="projectLogo"> |
| <a href="http://ws.apache.org/axis/"><img border="0" class="logoImage" alt="The Apache Axis Project" src="../images/axis3.jpg"></a> |
| </div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <table width="100%" cellpadding="0" cellspacing="0" border="0" summary="nav" id="breadcrumbs"> |
| <tbody> |
| <tr class="status"> |
| <td width="100%"> <a href="http://www.apache.org/">Apache</a> | <a href="http://ws.apache.org/">Web Services</a> | <a href="http://ws.apache.org/axis/">Axis</a></td><td nowrap="1" align="right"> |
| <form method="get" action="http://www.google.com/search" target="_blank">Search <input type="hidden" name="sitesearch" value="ws.apache.org"><input type="text" id="query" name="q" size="10"><img class="spacer" src="skin/images/spacer.gif" alt="" width="5" height="1"><input type="submit" value="Go" name="Search"> |
| </form> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <table id="main" width="100%" cellpadding="8" cellspacing="0" summary="" border="0"> |
| <tbody> |
| <tr valign="top"> |
| <td id="leftcol"> |
| <div id="navcolumn"> |
| <div class="menuBar"> |
| <div class="menu"> |
| <span class="menuLabel">Axis</span> |
| |
| <div class="menuItem"> |
| <a href="../index.html">Introduction</a> |
| </div> |
| |
| <div class="menuItem"> |
| <a href="../news.html">News</a> |
| </div> |
| |
| |
| <div class="menuItem"> |
| <a href="http://wiki.apache.org/ws/FrontPage/Axis">FAQ/Wiki</a> |
| </div> |
| |
| <div class="menu"> |
| <span class="menuLabel">Get Involved</span> |
| |
| <div class="menuItem"> |
| <a href="../overview.html">Overview</a> |
| </div> |
| |
| <div class="menuItem"> |
| <a href="../cvs.html">SVN Repository</a> |
| </div> |
| |
| <div class="menuItem"> |
| <a href="../mail.html">Mailing Lists</a> |
| </div> |
| |
| <div class="menuItem"> |
| <a href="../ref.html">Reference Library</a> |
| </div> |
| |
| <div class="menuItem"> |
| <a href="../bugs.html">Bugs</a> |
| </div> |
| |
| <div class="menuItem"> |
| <a href="../howtobuild.html">HowToBuildSite</a> |
| </div> |
| |
| </div> |
| |
| <div class="menu"> |
| <span class="menuLabel">Axis (Java)</span> |
| |
| <div class="menuItem"> |
| <a href="../java/index.html">Documentation</a> |
| </div> |
| |
| |
| <div class="menuItem"> |
| <a href="../java/releases.html">Releases</a> |
| </div> |
| |
| <div class="menuItem"> |
| <a href="../java/install.html">Installation</a> |
| </div> |
| |
| <div class="menuItem"> |
| <a href="../java/user-guide.html">User's Guide</a> |
| </div> |
| |
| <div class="menuItem"> |
| <a href="../java/developers-guide.html">Developer's Guide</a> |
| </div> |
| |
| <div class="menuItem"> |
| <a href="../java/integration-guide.html">Integration Guide</a> |
| </div> |
| |
| <div class="menuItem"> |
| <a href="../java/architecture-guide.html">Architecture Guide</a> |
| </div> |
| |
| <div class="menuItem"> |
| <a href="../java/reference.html">Reference Guide</a> |
| </div> |
| |
| <div class="menuItem"> |
| <a href="../java/reading.html">Reading Guide</a> |
| </div> |
| |
| <div class="menuItem"> |
| <a href="../java/requirements.html">Requirements</a> |
| </div> |
| |
| </div> |
| |
| <div class="menu"> |
| <span class="menuLabel">Axis C++</span> |
| |
| <div class="menuItem"> |
| <a href="http://ws.apache.org/axis/cpp/index.html">Home</a> |
| </div> |
| |
| <div class="menuItem"> |
| <a href="http://ws.apache.org/axis/cpp/documentation.html">Documentation</a> |
| </div> |
| |
| <div class="menuItem"> |
| <a href="http://ws.apache.org/axis/cpp/download.html">Download</a> |
| </div> |
| |
| <div class="menuItem"> |
| <a href="http://wiki.apache.org/ws/FrontPage/AxisCPP">Wiki Pages</a> |
| </div> |
| |
| <div class="menuItem"> |
| <a href="http://ws.apache.org/axis/cpp/who.html">Who we are</a> |
| </div> |
| |
| </div> |
| |
| <div class="menu"> |
| <span class="menuLabel">Downloads</span> |
| |
| <div class="menuItem"> |
| <a href="../interim.html">Interim Drops</a> |
| </div> |
| |
| <div class="menuItem"> |
| <a href="http://svn.apache.org/viewcvs.cgi/webservices/axis/trunk/">Source Code</a> |
| </div> |
| |
| </div> |
| |
| <div class="menu"> |
| <span class="menuLabel">Translation</span> |
| |
| <div class="menuItem"> |
| <a href="http://ws.apache.org/axis/ja/index.html">Japanese</a> |
| </div> |
| |
| </div> |
| |
| <div class="menu"> |
| <span class="menuLabel">Related Projects</span> |
| |
| <div class="menuItem"> |
| <a href="http://ws.apache.org/wsif/">WSIF</a> |
| </div> |
| |
| <div class="menuItem"> |
| <a href="http://ws.apache.org/juddi/">jUDDI</a> |
| </div> |
| |
| <div class="menuItem"> |
| <a href="http://wsdl4j.sourceforge.net">WSDL4J</a> |
| </div> |
| |
| <div class="menuItem"> |
| <a href="http://www.uddi4j.org/">UDDI4J</a> |
| </div> |
| |
| </div> |
| |
| <div class="menu"> |
| <span class="menuLabel">Misc</span> |
| |
| <div class="menuItem"> |
| <a href="../who.html">Who we are</a> |
| </div> |
| |
| <div class="menuItem"> |
| <a href="../contact.html">Contact</a> |
| </div> |
| |
| <div class="menuItem"> |
| <a href="../legal.html">Legal</a> |
| </div> |
| |
| <div class="menuItem"> |
| <a href="../docs.html">Notes/Docs</a> |
| </div> |
| |
| </div> |
| |
| |
| </div> |
| </div> |
| </div> |
| </td><td> |
| <div id="bodycol"> |
| <div class="app"> |
| <div class="h3"> |
| |
| |
| |
| |
| <div class="h3"> |
| <h3>SOAPMonitor User's Guide</h3> |
| </div> |
| |
| |
| |
| <p> |
| <i>1.0 Version</i> |
| <br> |
| |
| <i>Feedback:</i> <a href="mailto:axis-dev@ws.apache.org">axis-dev@ws.apache.org</a> |
| </p> |
| |
| |
| <a name="TableOfContents"></a> |
| |
| <div class="h4"> |
| <h4>Table of Contents</h4> |
| </div> |
| |
| |
| |
| <ul> |
| |
| <li> |
| <a href="#Introduction">Introduction</a> |
| </li> |
| |
| <ul> |
| |
| <li> |
| <a href="#WhatIsSOAPMonitor">What is SOAPMonitor ?</a> |
| </li> |
| |
| <li> |
| <a href="#WhenShouldIUseIt">When should I use it ?</a> |
| </li> |
| |
| </ul> |
| |
| <li> |
| <a href="#Usage">Usage</a> |
| </li> |
| |
| <ul> |
| |
| <li> |
| <a href="#Preparation">Preparation</a> |
| </li> |
| |
| <li> |
| <a href="#HowToUseIt">How to use it ?</a> |
| </li> |
| |
| </ul> |
| |
| <li> |
| <a href="#Appendixes">Appendixes</a> |
| </li> |
| |
| <ul> |
| |
| <li> |
| <a href="#VersionComparisonChart">Version comparison chart</a> |
| </li> |
| |
| <li> |
| <a href="#ErrorMessages">Error messages</a> |
| </li> |
| |
| </ul> |
| |
| </ul> |
| |
| |
| |
| |
| <a name="Introduction"></a> |
| |
| <div class="h4"> |
| <h4>Introduction</h4> |
| </div> |
| |
| |
| |
| <p>Web service developers often have the need to see the SOAP messages being used to invoke web services along with the results of those messages. The goal of the SOAP Monitor utility is to provide a way for these developers to monitor the SOAP messages being used without requiring any special configuration or restarting of the server.</p> |
| |
| |
| <a name="WhatIsSOAPMonitor"></a> |
| |
| <div class="h2"> |
| <h2>What is SOAPMonitor ?</h2> |
| </div> |
| |
| |
| |
| <p>It's a utility what can be found in the org.apache.axis.utils package. It provides the monitoring capability described above to Web service developers.</p> |
| |
| |
| |
| |
| <a name="WhenShouldIUseIt"></a> |
| |
| <div class="h2"> |
| <h2>When should I use it ?</h2> |
| </div> |
| |
| |
| <p>It's a good opportunity for using this utility that you hope to monitor the SOAP messages for debugging. You can see all SOAP messages of what you want to monitor without any additional developments, special configurations or restarting of the application server.</p> |
| |
| <p> |
| <b>Please note that it doesn't display any protocol specific data such as HTTP protocol headers. If you need to do this, you should use the TCP Monitor (tcpmon). Please see the <a href="user-guide.html">Axis User's Guide</a> for details on tcpmon</b>.</p> |
| |
| |
| |
| |
| |
| |
| <a name="Usage"></a> |
| |
| <div class="h4"> |
| <h4>Usage</h4> |
| </div> |
| |
| |
| |
| <a name="Preparation"></a> |
| |
| <div class="h2"> |
| <h2>Preparation</h2> |
| </div> |
| |
| |
| |
| <ul> |
| |
| <li> |
| <b>step 1:</b> Create an account for the administrator |
| <p>Open and edit the "webapps/axis/WEB-INF/users.lst".<br> |
| The default account for administrator is "admin", set a password to anything you want.</p> |
| |
| <p>ex.) Like as follows; - i.e. "admin password".</p> |
| |
| <pre class="code">user1 pass1 |
| user2 |
| user3 pass3 |
| admin password</pre> |
| |
| </li> |
| |
| |
| <li> |
| <b>step 2:</b> Setting CLASSPATH |
| <p>Before running this utility, you'll need to make sure that your CLASSPATH includes:</p> |
| |
| <ul> |
| |
| <li>axis.jar</li> |
| |
| <li>jaxrpc.jar</li> |
| |
| <li>saaj.jar</li> |
| |
| <li>commons-logging.jar</li> |
| |
| <li>commons-discovery.jar</li> |
| |
| <li>activation.jar</li> |
| |
| <li>mail.jar</li> |
| |
| <li>A JAXP-1.1 compliant XML parser such as Xerces or Crimson</li> |
| |
| </ul> |
| |
| </li> |
| |
| |
| <li> |
| <b>That's all.</b> |
| </li> |
| |
| </ul> |
| |
| |
| |
| |
| <a name="HowToUseIt"></a> |
| |
| <div class="h2"> |
| <h2>How to use it ?</h2> |
| </div> |
| |
| |
| |
| <ul> |
| |
| <li> |
| <b>step 0:</b> Make sure you have completed <a href="#prepare">the preparation phase.</a> |
| </li> |
| |
| |
| <li> |
| <b>step 1:</b> Start the SOAPMonitor application. |
| <p> |
| <span class="codefrag">% java org.apache.axis.utils.SOAPMonitor [-u admin] [-w password] [-l axisURL]</span> |
| </p> |
| |
| <p>or</p> |
| |
| <p> |
| <span class="codefrag">% javaw org.apache.axis.utils.SOAPMonitor [-u admin] [-w password] [-l axisURL]</span> |
| </p> |
| |
| </li> |
| |
| |
| <li> |
| <b>step 2:</b> Login |
| <p>Try login with the account which you specified as an administrator.</p> |
| |
| <p> |
| <img src="images/LoginDialog.jpg"></p> |
| |
| </li> |
| |
| |
| <li> |
| <b>step 3:</b> Please wait for a while. |
| <p> |
| <img src="images/DataLoading.jpg" width="400"></p> |
| |
| </li> |
| |
| |
| <li> |
| <b>step 4:</b> Administration screen will be displayed |
| <p> |
| <img src="images/InitialScreen.jpg"></p> |
| |
| </li> |
| |
| |
| <li> |
| <b>step 5-a:</b> To enable monitoring |
| <p>Click services to enable monitoring, then push "Turn On" button.</p> |
| |
| <p> |
| <img src="images/ToEnableMonitoring.jpg"></p> |
| |
| <p>The following screen should be displayed.</p> |
| |
| <p> |
| <img src="images/AfterTurnOn.jpg"></p> |
| |
| </li> |
| |
| |
| <li> |
| <b>step 5-b:</b> To disable monitoring |
| <p>Click services to disable monitoring, then push "Turn Off" button.</p> |
| |
| <p> |
| <img src="images/ToDisableMonitoring.jpg"></p> |
| |
| <p>The following screen should be displayed.</p> |
| |
| <p> |
| <img src="images/AfterTurnOff.jpg"></p> |
| |
| </li> |
| |
| |
| <li> |
| <b>step 6:</b> Save changes |
| <p>Push "Save changes" button to save the current state.</p> |
| |
| <p>The following screen should be displayed.</p> |
| |
| <p> |
| <img src="images/DeployStatus.jpg"></p> |
| |
| </li> |
| |
| |
| <li> |
| <b>step 7:</b> Monitoring |
| <p>Push "Monitoring" tab to start monitoring with the current settings.</p> |
| |
| <p>The following screen should be displayed.</p> |
| |
| <p> |
| <img src="images/MonitoringScreen.jpg"></p> |
| |
| </li> |
| |
| </ul> |
| |
| |
| |
| |
| |
| |
| <a name="Appendixes"></a> |
| |
| <div class="h4"> |
| <h4>Appendixes</h4> |
| </div> |
| |
| |
| |
| <a name="VersionComparisonChart"></a> |
| |
| <div class="h2"> |
| <h2>Version comparison chart</h2> |
| </div> |
| |
| |
| |
| <table class="ForrestTable" cellspacing="1" cellpadding="4"> |
| |
| <tr class="b"> |
| |
| <th colspan="1" rowspan="1">Item</th> |
| <th colspan="1" rowspan="1">SOAPMonitorApplet(Old version)</th> |
| <th colspan="1" rowspan="1">SOAPMonitor(<a href="http://cvs.apache.org/viewcvs.cgi/ws-axis/java/src/org/apache/axis/utils/SOAPMonitor.java?view=markup">This version</a>)</th> |
| |
| </tr> |
| |
| <tr class="a"> |
| |
| <td colspan="1" rowspan="1">App Type</td> |
| <td colspan="1" rowspan="1">Applet</td> |
| <td colspan="1" rowspan="1">Swing application</td> |
| |
| </tr> |
| |
| <tr class="b"> |
| |
| <td colspan="1" rowspan="1">Security</td> |
| <td colspan="1" rowspan="1">N/A (No authentication)</td> |
| <td colspan="1" rowspan="1">OK (Authentication added)</td> |
| |
| </tr> |
| |
| <tr class="a"> |
| |
| <td colspan="1" rowspan="1">Install & Use</td> |
| <td colspan="1" rowspan="1"> |
| |
| <ol> |
| |
| <li>Compile the component, at first</li> |
| |
| <li>Deploy the soapmonitor handler to "server-config.wsdd"</li> |
| |
| <li>Deploy a service which to be monitored with the soapmonitor handler</li> |
| |
| <li>Have an access to "http://localhost:8080/axis/SOAPMonitor"</li> |
| |
| <li>Redeploy the service with no soapmonitor to disable monitoring</li> |
| |
| </ol> |
| |
| <ul> |
| |
| <li>More detail is <a href="http://www.sosnoski.com/presents/java-xml/axis/axis-monitor.html">here</a>.</li> |
| |
| <li>All of steps are the non-GUI based operations and these process are complicated for users</li> |
| |
| </ul> |
| |
| </td> |
| <td colspan="1" rowspan="1">Just do "java org.apache.axis.utils.SOAPMonitor" (within the axis.jar) |
| <ul> |
| |
| <li>All of steps are the GUI based operations</li> |
| |
| </ul> |
| |
| </td> |
| |
| </tr> |
| |
| </table> |
| |
| |
| |
| |
| <a name="ErrorMessages"></a> |
| |
| <div class="h2"> |
| <h2>Error Messages</h2> |
| </div> |
| |
| |
| |
| <p>You may meet the following screens, if you have an access denied.</p> |
| |
| |
| <ul> |
| |
| <li> |
| <b>In case of "Unknown host":</b> |
| |
| <p> |
| <img src="images/UnknownHost.jpg"></p> |
| |
| </li> |
| |
| <li> |
| <b>In case of "Port mismatch":</b> |
| |
| <p> |
| <img src="images/ConnectionRefused.jpg"></p> |
| |
| </li> |
| |
| <li> |
| <b>In case of "Authorization failure":</b> |
| |
| <p> |
| <img src="images/Unauthorized.jpg"></p> |
| |
| </li> |
| |
| </ul> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <div id="pdf" align="right"> |
| <a href="soapmonitor-user-guide.pdf"><img alt="PDF" src="../skin/images/pdfdoc.gif" class="skin"><br> |
| PDF</a> |
| </div> |
| </div> |
| </div> |
| </div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <div id="footer"> |
| <table summary="footer" cellspacing="0" cellpadding="4" width="100%" border="0"> |
| <tbody> |
| <tr> |
| <td colspan="2"> |
| <div align="center"> |
| <div class="copyright"> |
| Copyright © 2000-2005 The Apache Software Foundation. All rights reserved. |
| </div> |
| </div> |
| </td> |
| </tr> |
| <tr> |
| <td align="left"></td><td align="right"> |
| <div align="right"> |
| <div class="credit"></div> |
| </div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </body> |
| </html> |
