toshi 2004/06/24 04:58:57
Added: targets/axis/java soapmonitor-user-guide.pdf
soapmonitor-user-guide.html
Log:
SOAPMonitor User's Guide.
Revision Changes Path
1.1 ws-site/targets/axis/java/soapmonitor-user-guide.pdf
<<Binary file>>
1.1 ws-site/targets/axis/java/soapmonitor-user-guide.html
Index: soapmonitor-user-guide.html
===================================================================
<!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">
<!--*** This is a generated file. Do not edit. ***-->
<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>SOAPMonitor User's Guide</title>
</head>
<body bgcolor="white" class="composite">
<!--================= start Banner ==================-->
<div id="banner">
<table width="100%" cellpadding="8" cellspacing="0" summary="banner" border="0">
<tbody>
<tr>
<!--================= start Group Logo ==================-->
<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.jpg"></a>
</div>
</td>
<!--================= end Group Logo ==================-->
<!--================= start Project Logo ==================--><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/axis.jpg"></a>
</div>
</td>
<!--================= end Project Logo ==================-->
<!--================= start Search ==================--><td valign="top" rowspan="2"
align="right" class="search">
<form target="_blank" action="http://www.google.com/search"; method="get">
<table summary="search" border="0" cellspacing="0" cellpadding="0">
<tr>
<td bgcolor="#a5b6c6" colspan="3"><img height="10" width="1" alt=""
src="../skin/images/spacer.gif" class="spacer"></td>
</tr>
<tr>
<td colspan="3"><img height="8" width="1" alt="" src="../skin/images/spacer.gif"
class="spacer"></td>
</tr>
<tr>
<td><img height="1" width="1" alt="" src="../skin/images/spacer.gif"
class="spacer"></td><td nowrap="nowrap"><input value="ws.apache.org" name="sitesearch"
type="hidden"><input size="10" name="q" id="query" type="text"><img height="1"
width="5" alt="" src="../skin/images/spacer.gif" class="spacer"><input name="Search"
value="GO" type="submit">
<br>
Search WS</td><td><img height="1" width="1" alt=""
src="../skin/images/spacer.gif" class="spacer"></td>
</tr>
<tr>
<td colspan="3"><img height="7" width="1" alt="" src="../skin/images/spacer.gif"
class="spacer"></td>
</tr>
<tr>
<td class="bottom-left-thick"></td><td bgcolor="#a5b6c6"><img height="1" width="1"
alt="" src="../skin/images/spacer.gif" class="spacer"></td><td
class="bottom-right-thick"></td>
</tr>
</table>
</form>
</td>
<!--================= end Search ==================-->
</tr>
</tbody>
</table>
</div>
<!--================= end Banner ==================-->
<!--================= start Main ==================-->
<table width="100%" cellpadding="0" cellspacing="0" border="0" summary="nav"
id="breadcrumbs">
<tbody>
<!--================= start Status ==================-->
<tr class="status">
<td>
<!--================= start BreadCrumb ==================--><a
href="http://www.apache.org/";>Apache</a> | <a href="http://ws.apache.org/";>WS</a><a
href=""></a>
<!--================= end BreadCrumb ==================--></td><td id="tabs">
<!--================= start Tabs ==================-->
<div class="tab">
<span class="selectedTab"><a class="base-selected"
href="../index.html">WebServices-Axis</a></span>
</div>
<!--================= end Tabs ==================-->
</td>
</tr>
</tbody>
</table>
<!--================= end Status ==================-->
<table id="main" width="100%" cellpadding="8" cellspacing="0" summary="" border="0">
<tbody>
<tr valign="top">
<!--================= start Menu ==================-->
<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://nagoya.apache.org/wiki/apachewiki.cgi?AxisProjectPages";>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">CVS 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>
<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/install.html">Installation</a>
</div>
<div class="menuItem">
<span class="menuSelected">User's Guide</span>
</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="../cpp/index.html">Latest Axis C++ Release!</a>
</div>
<div class="menuItem">
<a href="../cpp/documentation.html">Documenation</a>
</div>
<div class="menuItem">
<a href="../cpp/download.html">Download</a>
</div>
<div class="menuItem">
<a href="http://nagoya.apache.org/wiki/apachewiki.cgi?AxisCPPProjectPages";>Wiki
Pages</a>
</div>
<div class="menuItem">
<a href="../cpp/who.html">Who we are</a>
</div>
</div>
<div class="menu">
<span class="menuLabel">Downloads</span>
<div class="menuItem">
<a href="../releases.html">Releases</a>
</div>
<div class="menuItem">
<a href="../interim.html">Interim Drops</a>
</div>
<div class="menuItem">
<a href="http://cvs.apache.org/viewcvs/ws-axis/";>Source Code</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://cvs.apache.org/viewcvs/*checkout*/ws-wsil/java/README.htm";>WSIL</a>
</div>
<div class="menuItem">
<a href="http://www-124.ibm.com/developerworks/projects/wsdl4j/";>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="../site.html">Whole Site</a>
</div>
<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>
<!--================= end Menu ==================-->
<!--================= start Content ==================--><td>
<div id="bodycol">
<div class="app">
<div align="center">
<h1>SOAPMonitor User's Guide</h1>
</div>
<div class="h3">
<div class="h3">
<h3>SOAPMonitor User's Guide</h3>
</div>
<em>1.0 Version</em>
<br>
<em>Feedback:</em><a href="mailto:[EMAIL PROTECTED]">[EMAIL PROTECTED]</a>
<p></p>
<p>
<a name="Contents"></a>
</p>
<div class="h4">
<h4>Contents</h4>
</div>
<ul>
<li>
<a href="#intro">Introduction</a>
<ul>
<li>
<a href="#whats_soapmonitor">What is SOAPMonitor ?</a>
</li>
<li>
<a href="#when_useit">When should I use it ?</a>
</li>
</ul>
</li>
<li>
<a href="#usage">Usage</a>
<ul>
<li>
<a href="#prepare">Prepareation</a>
</li>
<li>
<a href="#howto">How to use it ?</a>
</li>
</ul>
</li>
<li>
<a href="#appendix">Appendixes</a>
<ul>
<li>
<a href="#comparison">Version comparison chart</a>
</li>
<li>
<a href="#error">Error messages</a>
</li>
</ul>
</li>
</ul>
<p></p>
<p>
<a name="intro"></a>
</p>
<div class="h4">
<h4>Introduction</h4>
</div>
<dl>
<dd>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.</dd>
</dl>
<p>
<a name="whats_soapmonitor"></a>
</p>
<div class="h2">
<h2>What is SOAPMonitor ?</h2>
</div>
<dl>
<dd>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.</dd>
</dl>
<p>
<a name="when_useit"></a>
</p>
<div class="h2">
<h2>When should I use it ?</h2>
</div>
<dl>
<dd>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>
<strong>Please note that it desn't display any protocol specific data such as HTTP
protocol headers. In case of the usage, you have to use the TCP Monitor (tcpmon).
Please see the <a href="user-guide.html">Axis User's Guide also.</a></strong>
</p>
</dd>
</dl>
<p>
<a name="Usage"></a>
</p>
<div class="h4">
<h4>Usage</h4>
</div>
<p></p>
<p>
<a name="prepare"></a>
</p>
<div class="h2">
<h2>Preparation</h2>
</div>
<dl>
<dd>
<strong>step 1:</strong> Create an account for the administrator <dl>
<dd>Please open and edit the "webapps/axis/WEB-INF/users.lst".<br> The defalut
account for administrator is "admin", so please set a password anything you
want.<p>ex.) Like as follows; - i.e. "admin password".</p>
<p></p>
<dl>
<dd>user1 pass1<br> user2<br> user3 pass3<br> admin password<br>
</dd>
</dl>
</dd>
</dl>
<strong>That's all.</strong>
</dd>
</dl>
<p>
<a name="howto"></a>
</p>
<div class="h2">
<h2>How to use it ?</h2>
</div>
<dl>
<dd>
<strong>step 0:</strong> Make sure <a href="#prepare">the preparation phase</a>
<p>
<strong>step 1:</strong> Start the SOAPMonitor application</p>
<dl>
<dd>% java org.apache.axis.utils.SOAPMonitor [-u admin] [-w password] [-l axisURL]
<dl>
<dd>or</dd>
</dl>% javaw org.apache.axis.utils.SOAPMonitor [-u admin] [-w password] [-l
axisURL]</dd>
</dl>
<p>
<strong>step 2:</strong> Login</p>
<dl>
<dd>Please login with the account which you specified as an administorator. <img
alt="" src="images/LoginDialog.jpg"><br>
</dd>
</dl>
<p>
<strong>step 3:</strong> Please wait for a while</p>
<dl>
<dd>
<img alt="" src="images/DataLoading.jpg"><br>
</dd>
</dl>
<p>
<strong>step 4:</strong> Administration screen will be displayed</p>
<dl>
<dd>
<img alt="" src="images/InitialScreen.jpg"><br>
</dd>
</dl>
<p>
<strong>step 5-a:</strong> To enable monitoring</p>
<dl>
<dd>Please click services to enable monitoring, then push "Turn On" button.<br>
<img alt="" src="images/ToEnableMonitoring.jpg"><p>The following screen should be
displayed.<br>
<img alt="" src="images/AfterTurnOn.jpg"><br>
</p>
</dd>
</dl>
<p>
<strong>step 5-b:</strong> To disable monitoring</p>
<dl>
<dd>Please click services to disable monitoring, then push "Turn Off" button.<br>
<img alt="" src="images/ToDisableMonitoring.jpg"><p>The following screen should be
displayed.<br>
<img alt="" src="images/AfterTurnOff.jpg"><br>
</p>
</dd>
</dl>
<p>
<strong>step 6:</strong> Save changes</p>
<dl>
<dd>Please push "Save changes" button to save the current state.<br> The following
screen should be displayed.<br>
<img alt="" src="images/DeployStatus.jpg"><br>
</dd>
</dl>
<p>
<strong>step 7:</strong> Monitoring</p>
<dl>
<dd>Please push "Monitoring" tab to start monitoring with the current settings.<br>
The following screen should be displayed.<br>
<img alt="" src="images/MonitoringScreen.jpg"><br>
</dd>
</dl>
</dd>
</dl>
<p>
<a name="appendix"></a>
</p>
<div class="h4">
<h4>Appendixes</h4>
</div>
<p>
<a name="comparison"></a>
</p>
<div class="h2">
<h2>Version comparison chart</h2>
</div>
<table class="ForrestTable" cellspacing="1" cellpadding="4">
<tr class="b">
<th>Item</th><th>SOAPMonitorApplet(Old version)</th><th>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 bgcolor="#cccccc">App Type</td><td>Applet</td><td>Swing application</td>
</tr>
<tr class="b">
<td bgcolor="#cccccc">Security</td><td>NG (No authentication)</td><td>OK
(Authentication added)</td>
</tr>
<tr class="a">
<td bgcolor="#cccccc">Install & Use</td><td>1. Compile the component, at
first<br> 2. Deploy the soapmonitor handler to "server-config.wsdd"<br> 3. Deploy a
service which to be monitored with the soapmonitor handler<br> 4. Have an access to
"http://localhost:8080/axis/SOAPMonitor";<br> 5. Redeploy the service with no
soapmonitor to disable monitoring<p>*) More detail is <a
href="http://www.sosnoski.com/presents/java-xml/axis/axis-monitor.html";>here</a>.<br>
*) All of steps are the non-GUI based operations and these process are complicated for
users</p>
</td><td>Just do "java org.apache.axis.utils.SOAPMonitor"<br> (within the
axis.jar)<p>*) All of steps are the GUI based operations<br>
</p>
</td>
</tr>
</table>
<p>
<a name="error"></a>
</p>
<div class="h2">
<h2>Error messages</h2>
</div>
<dl>
<dd>You may meet the following screens, if you have an access denied. <dl>
<dd>
<strong>In case of "Unknown host":</strong>
<br>
<img alt="" src="images/UnknownHost.jpg"><p>
<strong>In case of "Port mismatch":</strong>
<br>
<img alt="" src="images/ConnectionRefused.jpg"></p>
<p>
<strong>In case of "Authrization failure":</strong>
<br>
<img alt="" src="images/Unauthorized.jpg"></p>
<p></p>
</dd>
</dl>
</dd>
</dl>
<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>
<!--================= end Content ==================-->
</tr>
</tbody>
</table>
<!--================= end Main ==================-->
<!--================= start Footer ==================-->
<div id="footer">
<table summary="footer" cellspacing="0" cellpadding="4" width="100%" border="0">
<tbody>
<tr>
<!--================= start Copyright ==================-->
<td colspan="2">
<div align="center">
<div class="copyright">
Copyright © 2000-2003 The Apache Software Foundation. All
rights reserved.
</div>
</div>
</td>
<!--================= end Copyright ==================-->
</tr>
<tr>
<td align="left">
<!--================= start Host ==================-->
<!--================= end Host ==================--></td><td align="right">
<!--================= start Credits ==================-->
<div align="right">
<div class="credit"></div>
</div>
<!--================= end Credits ==================-->
</td>
</tr>
</tbody>
</table>
</div>
<!--================= end Footer ==================-->
</body>
</html>
