You are viewing a plain text version of this content. The canonical link for it is here.
Posted to pubscribe-commits@ws.apache.org by sc...@apache.org on 2005/08/05 15:44:13 UTC
svn commit: r230466 [1/5] - in /webservices/pubscribe/site: ./ dev_guide/
images/ skin/ skin/css/ skin/images/ skin/scripts/ tutorial/ tutorial/images/
Author: scamp
Date: Fri Aug 5 06:43:47 2005
New Revision: 230466
URL: http://svn.apache.org/viewcvs?rev=230466&view=rev
Log:
added new
Added:
webservices/pubscribe/site/contact_info.html
webservices/pubscribe/site/dev_guide/
webservices/pubscribe/site/dev_guide/client.html
webservices/pubscribe/site/dev_guide/consumer.html
webservices/pubscribe/site/dev_guide/debug.html
webservices/pubscribe/site/dev_guide/deploy.html
webservices/pubscribe/site/dev_guide/home.html
webservices/pubscribe/site/dev_guide/index.html
webservices/pubscribe/site/dev_guide/producer.html
webservices/pubscribe/site/dev_guide/subscription.html
webservices/pubscribe/site/dev_guide/wsdl.html
webservices/pubscribe/site/dev_guide/wsdl_tool.html
webservices/pubscribe/site/getting_started.html
webservices/pubscribe/site/images/
webservices/pubscribe/site/images/apache.ico (with props)
webservices/pubscribe/site/images/built-with-forrest-button.png (with props)
webservices/pubscribe/site/images/pubscribe-logo.gif (with props)
webservices/pubscribe/site/images/ws-logo.gif (with props)
webservices/pubscribe/site/index.html
webservices/pubscribe/site/issue_tracking.html
webservices/pubscribe/site/linkmap.html
webservices/pubscribe/site/release.html
webservices/pubscribe/site/release_notes.html
webservices/pubscribe/site/skin/
webservices/pubscribe/site/skin/basic.css
webservices/pubscribe/site/skin/breadcrumbs-optimized.js
webservices/pubscribe/site/skin/breadcrumbs.js
webservices/pubscribe/site/skin/css/
webservices/pubscribe/site/skin/fontsize.js
webservices/pubscribe/site/skin/forrest.css.xslt
webservices/pubscribe/site/skin/getBlank.js
webservices/pubscribe/site/skin/getMenu.js
webservices/pubscribe/site/skin/images/
webservices/pubscribe/site/skin/images/README.txt
webservices/pubscribe/site/skin/images/add.jpg (with props)
webservices/pubscribe/site/skin/images/built-with-forrest-button.png (with props)
webservices/pubscribe/site/skin/images/chapter.gif (with props)
webservices/pubscribe/site/skin/images/chapter_open.gif (with props)
webservices/pubscribe/site/skin/images/corner-imports.svg.xslt
webservices/pubscribe/site/skin/images/current.gif (with props)
webservices/pubscribe/site/skin/images/dc.svg.xslt
webservices/pubscribe/site/skin/images/error.png (with props)
webservices/pubscribe/site/skin/images/external-link.gif (with props)
webservices/pubscribe/site/skin/images/fix.jpg (with props)
webservices/pubscribe/site/skin/images/forrest-credit-logo.png (with props)
webservices/pubscribe/site/skin/images/hack.jpg (with props)
webservices/pubscribe/site/skin/images/header_white_line.gif (with props)
webservices/pubscribe/site/skin/images/info.png (with props)
webservices/pubscribe/site/skin/images/label.gif (with props)
webservices/pubscribe/site/skin/images/page.gif (with props)
webservices/pubscribe/site/skin/images/pdfdoc.gif (with props)
webservices/pubscribe/site/skin/images/poddoc.png (with props)
webservices/pubscribe/site/skin/images/poddoc.svg.xslt
webservices/pubscribe/site/skin/images/printer.gif (with props)
webservices/pubscribe/site/skin/images/rc-b-l-15-1body-2menu-3menu.png (with props)
webservices/pubscribe/site/skin/images/rc-b-r-15-1body-2menu-3menu.png (with props)
webservices/pubscribe/site/skin/images/rc-b-r-5-1header-2tab-selected-3tab-selected.png (with props)
webservices/pubscribe/site/skin/images/rc-t-l-5-1header-2searchbox-3searchbox.png (with props)
webservices/pubscribe/site/skin/images/rc-t-l-5-1header-2tab-selected-3tab-selected.png (with props)
webservices/pubscribe/site/skin/images/rc-t-l-5-1header-2tab-unselected-3tab-unselected.png (with props)
webservices/pubscribe/site/skin/images/rc-t-r-15-1body-2menu-3menu.png (with props)
webservices/pubscribe/site/skin/images/rc-t-r-5-1header-2searchbox-3searchbox.png (with props)
webservices/pubscribe/site/skin/images/rc-t-r-5-1header-2tab-selected-3tab-selected.png (with props)
webservices/pubscribe/site/skin/images/rc-t-r-5-1header-2tab-unselected-3tab-unselected.png (with props)
webservices/pubscribe/site/skin/images/rc.svg.xslt
webservices/pubscribe/site/skin/images/remove.jpg (with props)
webservices/pubscribe/site/skin/images/rss.png (with props)
webservices/pubscribe/site/skin/images/spacer.gif (with props)
webservices/pubscribe/site/skin/images/success.png (with props)
webservices/pubscribe/site/skin/images/update.jpg (with props)
webservices/pubscribe/site/skin/images/valid-html401.png (with props)
webservices/pubscribe/site/skin/images/vcss.png (with props)
webservices/pubscribe/site/skin/images/warning.png (with props)
webservices/pubscribe/site/skin/images/xmldoc.gif (with props)
webservices/pubscribe/site/skin/menu.js
webservices/pubscribe/site/skin/note.txt
webservices/pubscribe/site/skin/print.css
webservices/pubscribe/site/skin/profile.css
webservices/pubscribe/site/skin/profile.css.xslt
webservices/pubscribe/site/skin/screen.css
webservices/pubscribe/site/skin/scripts/
webservices/pubscribe/site/skin/skinconf.xsl
webservices/pubscribe/site/tutorial/
webservices/pubscribe/site/tutorial/images/
webservices/pubscribe/site/tutorial/images/back.gif (with props)
webservices/pubscribe/site/tutorial/images/next.gif (with props)
webservices/pubscribe/site/tutorial/index.html
webservices/pubscribe/site/tutorial/mod_home.html
webservices/pubscribe/site/tutorial/mod_resource.html
webservices/pubscribe/site/tutorial/setup.html
webservices/pubscribe/site/tutorial/test.html
webservices/pubscribe/site/tutorial/webapp.html
webservices/pubscribe/site/tutorial/wsdl.html
webservices/pubscribe/site/tutorial/wsdl2java.html
webservices/pubscribe/site/version_control.html
webservices/pubscribe/site/wsn.html
Added: webservices/pubscribe/site/contact_info.html
URL: http://svn.apache.org/viewcvs/webservices/pubscribe/site/contact_info.html?rev=230466&view=auto
==============================================================================
--- webservices/pubscribe/site/contact_info.html (added)
+++ webservices/pubscribe/site/contact_info.html Fri Aug 5 06:43:47 2005
@@ -0,0 +1,269 @@
+<!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">
+<meta content="Apache Forrest" name="Generator">
+<meta name="Forrest-version" content="0.6">
+<meta name="Forrest-skin-name" content="pelt">
+<title>Pubscribe Contact Information</title>
+<link type="text/css" href="skin/basic.css" rel="stylesheet">
+<link media="screen" type="text/css" href="skin/screen.css" rel="stylesheet">
+<link media="print" type="text/css" href="skin/print.css" rel="stylesheet">
+<link type="text/css" href="skin/profile.css" rel="stylesheet">
+<script src="skin/getBlank.js" language="javascript" type="text/javascript"></script><script src="skin/getMenu.js" language="javascript" type="text/javascript"></script><script src="skin/fontsize.js" language="javascript" type="text/javascript"></script>
+<link rel="shortcut icon" href="images/apache.ico">
+</head>
+<body onload="init()">
+<script type="text/javascript">ndeSetTextSize();</script>
+<div id="top">
+<!--+
+ |breadtrail
+ +-->
+<div class="breadtrail">
+<a href="http://www.apache.org/">apache</a> > <a href="http://ws.apache.org">ws.apache</a><script src="skin/breadcrumbs.js" language="JavaScript" type="text/javascript"></script>
+</div>
+<!--+
+ |header
+ +-->
+<div class="header">
+<!--+
+ |start group logo
+ +-->
+<div class="grouplogo">
+<a href="http://ws.apache.org/"><img class="logoImage" alt="Web Services" src="images/ws-logo.gif"></a>
+</div>
+<!--+
+ |end group logo
+ +-->
+<!--+
+ |start Project Logo
+ +-->
+<div class="projectlogoA1">
+<a href="http://ws.apache.org/ws-fx/pubscribe/"><img class="logoImage" alt="Pubscribe" src="images/pubscribe-logo.gif"></a>
+</div>
+<!--+
+ |end Project Logo
+ +-->
+<!--+
+ |start Tabs
+ +-->
+<ul id="tabs">
+<li class="current">
+<a class="base-selected" href="index.html">Project Info</a>
+</li>
+<li>
+<a class="base-not-selected" href="getting_started.html">Documentation</a>
+</li>
+<li>
+<a class="base-not-selected" href="apidocs/index.html">API Docs</a>
+</li>
+</ul>
+<!--+
+ |end Tabs
+ +-->
+</div>
+</div>
+<div id="main">
+<div id="publishedStrip">
+<!--+
+ |start Subtabs
+ +-->
+<div id="level2tabs"></div>
+<!--+
+ |end Endtabs
+ +-->
+<script type="text/javascript" language="JavaScript"><!--
+ document.write("Published: " + document.lastModified);
+ // --></script>
+</div>
+<!--+
+ |breadtrail
+ +-->
+<div class="breadtrail">
+
+
+ </div>
+<!--+
+ |start Menu, mainarea
+ +-->
+<!--+
+ |start Menu
+ +-->
+<div id="menu">
+<div onclick="SwitchMenu('menu_selected_1.1', 'skin/')" id="menu_selected_1.1Title" class="menutitle" style="background-image: url('skin/images/chapter_open.gif');">Project Info</div>
+<div id="menu_selected_1.1" class="selectedmenuitemgroup" style="display: block;">
+<div class="menuitem">
+<a title="" href="index.html">Overview</a>
+</div>
+<div class="menuitem">
+<a title="" href="version_control.html">Version Control</a>
+</div>
+<div class="menuitem">
+<a title="" href="issue_tracking.html">Issue Tracking</a>
+</div>
+<div class="menupage">
+<div class="menupagetitle">Contact Info</div>
+</div>
+<div class="menuitem">
+<a title="" href="release_notes.html">Release Notes</a>
+</div>
+<div class="menuitem">
+<a title="" href="wsn.html">WSN Specs</a>
+</div>
+</div>
+<div onclick="SwitchMenu('menu_1.2', 'skin/')" id="menu_1.2Title" class="menutitle">Downloads</div>
+<div id="menu_1.2" class="menuitemgroup">
+<div class="menuitem">
+<a title="" href="release.html">Releases</a>
+</div>
+</div>
+<div id="credit"></div>
+<div id="roundbottom">
+<img style="display: none" class="corner" height="15" width="15" alt="" src="skin/images/rc-b-l-15-1body-2menu-3menu.png"></div>
+<!--+
+ |alternative credits
+ +-->
+</div>
+<!--+
+ |end Menu
+ +-->
+<!--+
+ |start content
+ +-->
+<div id="content">
+<div id="skinconf-txtlink"></div>
+<h1>Pubscribe Contact Information</h1>
+<div id="minitoc-area">
+<ul class="minitoc">
+<li>
+<a href="#Mailing+Lists">Mailing Lists</a>
+<ul class="minitoc">
+<li>
+<a href="#pubscribe-user">pubscribe-user</a>
+</li>
+<li>
+<a href="#pubscribe-dev">pubscribe-dev</a>
+</li>
+<li>
+<a href="#pubscribe-commits">pubscribe-commits</a>
+</li>
+</ul>
+</li>
+<li>
+<a href="#Chat+Room">Chat Room</a>
+</li>
+</ul>
+</div>
+
+<a name="N1000C"></a><a name="Mailing+Lists"></a>
+<h2 class="boxed">Mailing Lists</h2>
+<div class="section">
+<p>
+ There are currently three mailing lists for the project: pubscribe-user, pubscribe-dev, and pubscribe-commits.
+ </p>
+<div class="frame note">
+<div class="label">Note</div>
+<div class="content">In order to post to one of the lists, it is necessary to first subscribe to it.</div>
+</div>
+<a name="N10018"></a><a name="pubscribe-user"></a>
+<h3 class="boxed">pubscribe-user</h3>
+<p>This list is for developers that are using Pubscribe in their own projects to ask questions,
+ share knowledge, and discuss issues related to using Pubscribe.</p>
+<ul>
+
+<li>
+<a href="mailto:pubscribe-user-subscribe.at.ws.apache.org">Subscribe to List</a>
+</li>
+
+<li>
+<a href="mailto:pubscribe-user-unsubscribe.at.ws.apache.org">Unsubscribe from List</a>
+</li>
+
+<li>
+<a href="mailto:pubscribe-user.at.ws.apache.org">Post to List</a>
+</li>
+
+<li>Archives: <a href="http://ws.apache.org/mail/pubscribe-user/">Apache</a> ,
+ <a class="external" href="http://marc.theaimsgroup.com/?l=pubscribe-user&r=1&w=2/">MARC</a>
+</li>
+
+</ul>
+<a name="N1003E"></a><a name="pubscribe-dev"></a>
+<h3 class="boxed">pubscribe-dev</h3>
+<p>This is the list where developers of the Pubscribe project discuss issues, code changes/additions, etc.</p>
+<ul>
+
+<li>
+<a href="mailto:pubscribe-dev-subscribe.at.ws.apache.org">Subscribe to List</a>
+</li>
+
+<li>
+<a href="mailto:pubscribe-dev-unsubscribe.at.ws.apache.org">Unsubscribe from List</a>
+</li>
+
+<li>
+<a href="mailto:pubscribe-dev.at.ws.apache.org">Post to List</a>
+</li>
+
+<li>Archives: <a href="http://ws.apache.org/mail/pubscribe-dev/">Apache</a> ,
+ <a class="external" href="http://marc.theaimsgroup.com/?l=pubscribe-dev&r=1&w=2/">MARC</a>
+</li>
+
+</ul>
+<a name="N10064"></a><a name="pubscribe-commits"></a>
+<h3 class="boxed">pubscribe-commits</h3>
+<p>This list is for those who wish to be notified whenever files are committed to the Pubscribe SVN repository.</p>
+<ul>
+
+<li>
+<a href="mailto:pubscribe-commits-subscribe.at.ws.apache.org">Subscribe to List</a>
+</li>
+
+<li>
+<a href="mailto:pubscribe-commits-unsubscribe.at.ws.apache.org">Unsubscribe from List</a>
+</li>
+
+<li>
+<a href="mailto:pubscribe-commits.at.ws.apache.org">Post to List</a>
+</li>
+
+<li>Archives: <a href="http://ws.apache.org/mail/pubscribe-commits/">Apache</a> ,
+ <a class="external" href="http://marc.theaimsgroup.com/?l=pubscribe-commits&r=1&w=2/">MARC</a>
+</li>
+
+</ul>
+</div>
+
+<a name="N1008B"></a><a name="Chat+Room"></a>
+<h2 class="boxed">Chat Room</h2>
+<div class="section">
+<p>
+ Pubscribe developers can often be found on the
+ <a class="external" href="irc://irc.freenode.net/apache-ws"><span class="codefrag">#apache-ws</span> channel on the
+ <span class="codefrag">irc.freenode.net</span> IRC server</a>.
+ </p>
+</div>
+
+</div>
+<!--+
+ |end content
+ +-->
+<div class="clearboth"> </div>
+</div>
+<div id="footer">
+<!--+
+ |start bottomstrip
+ +-->
+<div class="lastmodified">
+<script type="text/javascript"><!--
+document.write("Last Published: " + document.lastModified);
+// --></script>
+</div>
+<div class="copyright">
+ Copyright © 2004 The Apache Software Foundation.</div>
+<!--+
+ |end bottomstrip
+ +-->
+</div>
+</body>
+</html>
Added: webservices/pubscribe/site/dev_guide/client.html
URL: http://svn.apache.org/viewcvs/webservices/pubscribe/site/dev_guide/client.html?rev=230466&view=auto
==============================================================================
--- webservices/pubscribe/site/dev_guide/client.html (added)
+++ webservices/pubscribe/site/dev_guide/client.html Fri Aug 5 06:43:47 2005
@@ -0,0 +1,260 @@
+<!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">
+<meta content="Apache Forrest" name="Generator">
+<meta name="Forrest-version" content="0.6">
+<meta name="Forrest-skin-name" content="pelt">
+<title>SOAP Client</title>
+<link type="text/css" href="../skin/basic.css" rel="stylesheet">
+<link media="screen" type="text/css" href="../skin/screen.css" rel="stylesheet">
+<link media="print" type="text/css" href="../skin/print.css" rel="stylesheet">
+<link type="text/css" href="../skin/profile.css" rel="stylesheet">
+<script src="../skin/getBlank.js" language="javascript" type="text/javascript"></script><script src="../skin/getMenu.js" language="javascript" type="text/javascript"></script><script src="../skin/fontsize.js" language="javascript" type="text/javascript"></script>
+<link rel="shortcut icon" href="../images/apache.ico">
+</head>
+<body onload="init()">
+<script type="text/javascript">ndeSetTextSize();</script>
+<div id="top">
+<!--+
+ |breadtrail
+ +-->
+<div class="breadtrail">
+<a href="http://www.apache.org/">apache</a> > <a href="http://ws.apache.org">ws.apache</a><script src="../skin/breadcrumbs.js" language="JavaScript" type="text/javascript"></script>
+</div>
+<!--+
+ |header
+ +-->
+<div class="header">
+<!--+
+ |start group logo
+ +-->
+<div class="grouplogo">
+<a href="http://ws.apache.org/"><img class="logoImage" alt="Web Services" src="../images/ws-logo.gif"></a>
+</div>
+<!--+
+ |end group logo
+ +-->
+<!--+
+ |start Project Logo
+ +-->
+<div class="projectlogoA1">
+<a href="http://ws.apache.org/ws-fx/pubscribe/"><img class="logoImage" alt="Pubscribe" src="../images/pubscribe-logo.gif"></a>
+</div>
+<!--+
+ |end Project Logo
+ +-->
+<!--+
+ |start Tabs
+ +-->
+<ul id="tabs">
+<li>
+<a class="base-not-selected" href="../index.html">Project Info</a>
+</li>
+<li class="current">
+<a class="base-selected" href="../getting_started.html">Documentation</a>
+</li>
+<li>
+<a class="base-not-selected" href="../apidocs/index.html">API Docs</a>
+</li>
+</ul>
+<!--+
+ |end Tabs
+ +-->
+</div>
+</div>
+<div id="main">
+<div id="publishedStrip">
+<!--+
+ |start Subtabs
+ +-->
+<div id="level2tabs"></div>
+<!--+
+ |end Endtabs
+ +-->
+<script type="text/javascript" language="JavaScript"><!--
+ document.write("Published: " + document.lastModified);
+ // --></script>
+</div>
+<!--+
+ |breadtrail
+ +-->
+<div class="breadtrail">
+
+
+ </div>
+<!--+
+ |start Menu, mainarea
+ +-->
+<!--+
+ |start Menu
+ +-->
+<div id="menu">
+<div onclick="SwitchMenu('menu_1.1', '../skin/')" id="menu_1.1Title" class="menutitle">Getting Started</div>
+<div id="menu_1.1" class="menuitemgroup">
+<div class="menuitem">
+<a title="" href="../getting_started.html">Introduction</a>
+</div>
+<div class="menuitem">
+<a title="" href="../getting_started.html#install">Installation</a>
+</div>
+<div class="menuitem">
+<a title="" href="../getting_started.html#qd">Quick Demo</a>
+</div>
+</div>
+<div onclick="SwitchMenu('menu_1.2', '../skin/')" id="menu_1.2Title" class="menutitle">Tutorial</div>
+<div id="menu_1.2" class="menuitemgroup">
+<div class="menuitem">
+<a title="" href="../tutorial/index.html">Overview</a>
+</div>
+<div class="menuitem">
+<a title="" href="../tutorial/setup.html">Create Workspace</a>
+</div>
+<div class="menuitem">
+<a title="" href="../tutorial/wsdl.html">Create WSDL</a>
+</div>
+<div class="menuitem">
+<a title="" href="../tutorial/wsdl2java.html">Run wsdl2Java Tool</a>
+</div>
+<div class="menuitem">
+<a title="" href="../tutorial/mod_home.html">Modify Home Class</a>
+</div>
+<div class="menuitem">
+<a title="" href="../tutorial/mod_resource.html">Modify Resource Class</a>
+</div>
+<div class="menuitem">
+<a title="" href="../tutorial/webapp.html">Deploy Service</a>
+</div>
+<div class="menuitem">
+<a title="" href="../tutorial/test.html">Test</a>
+</div>
+</div>
+<div onclick="SwitchMenu('menu_selected_1.3', '../skin/')" id="menu_selected_1.3Title" class="menutitle" style="background-image: url('../skin/images/chapter_open.gif');">Developer Guide</div>
+<div id="menu_selected_1.3" class="selectedmenuitemgroup" style="display: block;">
+<div class="menuitem">
+<a title="" href="../dev_guide/index.html">Overview</a>
+</div>
+<div class="menuitem">
+<a title="" href="../dev_guide/wsdl.html">WSRF/WSN WSDL</a>
+</div>
+<div class="menuitem">
+<a title="" href="../dev_guide/wsdl_tool.html">Using Wsdl2Java</a>
+</div>
+<div class="menuitem">
+<a title="" href="../dev_guide/home.html">Home Class</a>
+</div>
+<div class="menuitem">
+<a title="" href="../dev_guide/producer.html">Notification Producer</a>
+</div>
+<div class="menuitem">
+<a title="" href="../dev_guide/consumer.html">Notification Consumer</a>
+</div>
+<div class="menuitem">
+<a title="" href="../dev_guide/subscription.html">Subscription Manager</a>
+</div>
+<div class="menuitem">
+<a title="" href="../dev_guide/deploy.html">Deploying</a>
+</div>
+<div class="menupage">
+<div class="menupagetitle">Using the SOAP Client</div>
+</div>
+<div class="menuitem">
+<a title="" href="../dev_guide/debug.html">Logging</a>
+</div>
+</div>
+<div id="credit"></div>
+<div id="roundbottom">
+<img style="display: none" class="corner" height="15" width="15" alt="" src="../skin/images/rc-b-l-15-1body-2menu-3menu.png"></div>
+<!--+
+ |alternative credits
+ +-->
+</div>
+<!--+
+ |end Menu
+ +-->
+<!--+
+ |start content
+ +-->
+<div id="content">
+<div id="skinconf-txtlink"></div>
+<h1>SOAP Client</h1>
+<div id="minitoc-area">
+<ul class="minitoc">
+<li>
+<a href="#intro">Introduction</a>
+</li>
+<li>
+<a href="#SOAP+Files">SOAP Files</a>
+</li>
+<li>
+<a href="#Running+the+Client">Running the Client</a>
+</li>
+</ul>
+</div>
+
+<a name="N1000C"></a><a name="intro"></a>
+<h2 class="boxed">Introduction</h2>
+<div class="section">
+<p>Pubscribe includes a lightweight SOAP client that can be used to test your services. The client is invoked using an Ant script, which is located in
+ <span class="codefrag">INSTALL_DIR/template/soapclient.xml</span>. Request and response messages are viewed in the Ant output. This section explains how to use the client and
+ how to build request SOAP messages for the client.</p>
+</div>
+
+<a name="N10019"></a><a name="SOAP+Files"></a>
+<h2 class="boxed">SOAP Files</h2>
+<div class="section">
+<p>The client reads a <span class="codefrag">.soap</span> file which contains the SOAP envelope to be sent. Examples of SOAP files are located in
+ <span class="codefrag">INSTALL_DIR/examples/filesystem/requests/</span>. Each file is named appropriately based on the operation it contains. Use these files as models when
+ creating your own .soap files. Make sure you modify the resource identifier in the WS-Addressing header to match the entry that is in the JNDI
+ configuration file and the resource id for the instance you would like to invoke. The id is used by the invocation framework to lookup a particular resource instance.</p>
+</div>
+
+<a name="N10029"></a><a name="Running+the+Client"></a>
+<h2 class="boxed">Running the Client</h2>
+<div class="section">
+<p>To invoke the script:</p>
+<ol>
+
+<li>Make sure your WS Resource is deployed.</li>
+
+<li>open a command prompt and change directories to <span class="codefrag">INSTALL_DIR/template/soapclient.xml</span>.</li>
+
+<li>Run:
+ <pre class="code">ant -f soapclient.xml sendRequest -Durl=http://localhost:8080/pubscribe/services/<em>your_service</em> -Dxml=./requests/Subscribe_updateMountPointProp.soap</pre>
+
+<p>Where <em>your_service</em> represents your WS Resource endpoint name, and the script name should be the name (including the path) of your .soap file.
+ </p>
+
+</li>
+
+</ol>
+<div class="frame note">
+<div class="label">Note</div>
+<div class="content">You can add an entry to <span class="codefrag">build.properties</span> for the <span class="codefrag">url</span> property, which alleviates the need
+ to specify it on the command line.</div>
+</div>
+</div>
+
+</div>
+<!--+
+ |end content
+ +-->
+<div class="clearboth"> </div>
+</div>
+<div id="footer">
+<!--+
+ |start bottomstrip
+ +-->
+<div class="lastmodified">
+<script type="text/javascript"><!--
+document.write("Last Published: " + document.lastModified);
+// --></script>
+</div>
+<div class="copyright">
+ Copyright © 2004 The Apache Software Foundation.</div>
+<!--+
+ |end bottomstrip
+ +-->
+</div>
+</body>
+</html>
Added: webservices/pubscribe/site/dev_guide/consumer.html
URL: http://svn.apache.org/viewcvs/webservices/pubscribe/site/dev_guide/consumer.html?rev=230466&view=auto
==============================================================================
--- webservices/pubscribe/site/dev_guide/consumer.html (added)
+++ webservices/pubscribe/site/dev_guide/consumer.html Fri Aug 5 06:43:47 2005
@@ -0,0 +1,333 @@
+<!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">
+<meta content="Apache Forrest" name="Generator">
+<meta name="Forrest-version" content="0.6">
+<meta name="Forrest-skin-name" content="pelt">
+<title>Notification Consumer</title>
+<link type="text/css" href="../skin/basic.css" rel="stylesheet">
+<link media="screen" type="text/css" href="../skin/screen.css" rel="stylesheet">
+<link media="print" type="text/css" href="../skin/print.css" rel="stylesheet">
+<link type="text/css" href="../skin/profile.css" rel="stylesheet">
+<script src="../skin/getBlank.js" language="javascript" type="text/javascript"></script><script src="../skin/getMenu.js" language="javascript" type="text/javascript"></script><script src="../skin/fontsize.js" language="javascript" type="text/javascript"></script>
+<link rel="shortcut icon" href="../images/apache.ico">
+</head>
+<body onload="init()">
+<script type="text/javascript">ndeSetTextSize();</script>
+<div id="top">
+<!--+
+ |breadtrail
+ +-->
+<div class="breadtrail">
+<a href="http://www.apache.org/">apache</a> > <a href="http://ws.apache.org">ws.apache</a><script src="../skin/breadcrumbs.js" language="JavaScript" type="text/javascript"></script>
+</div>
+<!--+
+ |header
+ +-->
+<div class="header">
+<!--+
+ |start group logo
+ +-->
+<div class="grouplogo">
+<a href="http://ws.apache.org/"><img class="logoImage" alt="Web Services" src="../images/ws-logo.gif"></a>
+</div>
+<!--+
+ |end group logo
+ +-->
+<!--+
+ |start Project Logo
+ +-->
+<div class="projectlogoA1">
+<a href="http://ws.apache.org/ws-fx/pubscribe/"><img class="logoImage" alt="Pubscribe" src="../images/pubscribe-logo.gif"></a>
+</div>
+<!--+
+ |end Project Logo
+ +-->
+<!--+
+ |start Tabs
+ +-->
+<ul id="tabs">
+<li>
+<a class="base-not-selected" href="../index.html">Project Info</a>
+</li>
+<li class="current">
+<a class="base-selected" href="../getting_started.html">Documentation</a>
+</li>
+<li>
+<a class="base-not-selected" href="../apidocs/index.html">API Docs</a>
+</li>
+</ul>
+<!--+
+ |end Tabs
+ +-->
+</div>
+</div>
+<div id="main">
+<div id="publishedStrip">
+<!--+
+ |start Subtabs
+ +-->
+<div id="level2tabs"></div>
+<!--+
+ |end Endtabs
+ +-->
+<script type="text/javascript" language="JavaScript"><!--
+ document.write("Published: " + document.lastModified);
+ // --></script>
+</div>
+<!--+
+ |breadtrail
+ +-->
+<div class="breadtrail">
+
+
+ </div>
+<!--+
+ |start Menu, mainarea
+ +-->
+<!--+
+ |start Menu
+ +-->
+<div id="menu">
+<div onclick="SwitchMenu('menu_1.1', '../skin/')" id="menu_1.1Title" class="menutitle">Getting Started</div>
+<div id="menu_1.1" class="menuitemgroup">
+<div class="menuitem">
+<a title="" href="../getting_started.html">Introduction</a>
+</div>
+<div class="menuitem">
+<a title="" href="../getting_started.html#install">Installation</a>
+</div>
+<div class="menuitem">
+<a title="" href="../getting_started.html#qd">Quick Demo</a>
+</div>
+</div>
+<div onclick="SwitchMenu('menu_1.2', '../skin/')" id="menu_1.2Title" class="menutitle">Tutorial</div>
+<div id="menu_1.2" class="menuitemgroup">
+<div class="menuitem">
+<a title="" href="../tutorial/index.html">Overview</a>
+</div>
+<div class="menuitem">
+<a title="" href="../tutorial/setup.html">Create Workspace</a>
+</div>
+<div class="menuitem">
+<a title="" href="../tutorial/wsdl.html">Create WSDL</a>
+</div>
+<div class="menuitem">
+<a title="" href="../tutorial/wsdl2java.html">Run wsdl2Java Tool</a>
+</div>
+<div class="menuitem">
+<a title="" href="../tutorial/mod_home.html">Modify Home Class</a>
+</div>
+<div class="menuitem">
+<a title="" href="../tutorial/mod_resource.html">Modify Resource Class</a>
+</div>
+<div class="menuitem">
+<a title="" href="../tutorial/webapp.html">Deploy Service</a>
+</div>
+<div class="menuitem">
+<a title="" href="../tutorial/test.html">Test</a>
+</div>
+</div>
+<div onclick="SwitchMenu('menu_selected_1.3', '../skin/')" id="menu_selected_1.3Title" class="menutitle" style="background-image: url('../skin/images/chapter_open.gif');">Developer Guide</div>
+<div id="menu_selected_1.3" class="selectedmenuitemgroup" style="display: block;">
+<div class="menuitem">
+<a title="" href="../dev_guide/index.html">Overview</a>
+</div>
+<div class="menuitem">
+<a title="" href="../dev_guide/wsdl.html">WSRF/WSN WSDL</a>
+</div>
+<div class="menuitem">
+<a title="" href="../dev_guide/wsdl_tool.html">Using Wsdl2Java</a>
+</div>
+<div class="menuitem">
+<a title="" href="../dev_guide/home.html">Home Class</a>
+</div>
+<div class="menuitem">
+<a title="" href="../dev_guide/producer.html">Notification Producer</a>
+</div>
+<div class="menupage">
+<div class="menupagetitle">Notification Consumer</div>
+</div>
+<div class="menuitem">
+<a title="" href="../dev_guide/subscription.html">Subscription Manager</a>
+</div>
+<div class="menuitem">
+<a title="" href="../dev_guide/deploy.html">Deploying</a>
+</div>
+<div class="menuitem">
+<a title="" href="../dev_guide/client.html">Using the SOAP Client</a>
+</div>
+<div class="menuitem">
+<a title="" href="../dev_guide/debug.html">Logging</a>
+</div>
+</div>
+<div id="credit"></div>
+<div id="roundbottom">
+<img style="display: none" class="corner" height="15" width="15" alt="" src="../skin/images/rc-b-l-15-1body-2menu-3menu.png"></div>
+<!--+
+ |alternative credits
+ +-->
+</div>
+<!--+
+ |end Menu
+ +-->
+<!--+
+ |start content
+ +-->
+<div id="content">
+<div id="skinconf-txtlink"></div>
+<h1>Notification Consumer</h1>
+<div id="minitoc-area">
+<ul class="minitoc">
+<li>
+<a href="#intro">Introduction</a>
+</li>
+<li>
+<a href="#Modify+the+Service+Class">Modify the Service Class</a>
+</li>
+<li>
+<a href="#Modify+the+Resource+Class">Modify the Resource Class</a>
+</li>
+<li>
+<a href="#Modify+the+Home+Class">Modify the Home Class</a>
+</li>
+</ul>
+</div>
+
+<a name="N1000C"></a><a name="intro"></a>
+<h2 class="boxed">Introduction</h2>
+<div class="section">
+<p>This section provides instructions for creating a notification consumer resource. A service that acts as a notification consumer (implements the WSN
+ <span class="codefrag">NotificationConsumer</span> portType) can receive SOAP notification messages sent by a notification producer. The consumer
+ only receives messages for notifications to which it is subscribed.
+ </p>
+<p>The Wsdl2Java tool generates the same artifacts for a notification consumer as it does for a notification producer. In particular, the service, resource, and home class are
+ generated but need to be modified specifically for your consumer. The topics in this section describe how to modify these classes. An example notification consumer that works together
+ with the filesystem example is provided in the <span class="codefrag">INSTALL_DIR/examples/consumer</span> and discussed below. Initially, you should model your consumer based on the example to
+ ensure that you write a valid consumer.
+ </p>
+<div class="frame note">
+<div class="label">Note</div>
+<div class="content">A consumer WSDL must implement the <span class="codefrag">Notify</span> operation from the <span class="codefrag">NotificationConsumer</span> portType. If you use the
+ <span class="codefrag">INSTALL_DIR/template/_TEMPLATE_.wsdl</span> to create the WSDL, this operation is included and only needs to be uncommented. A WSDL is included in the consumer
+ example. To use this example, run the Wsdl2Java tool on the WSDL.
+ </div>
+</div>
+</div>
+
+<a name="N1002B"></a><a name="Modify+the+Service+Class"></a>
+<h2 class="boxed">Modify the Service Class</h2>
+<div class="section">
+<p>An abstract method <span class="codefrag">Notify</span> is generated in the abstractService class an needs to be implemented in your service class. The implementation of the method is dependant
+ on whatever features you want to include for your consumer. In the consumer example, a property is used to retrieve the last notification message. In
+ this case, the <span class="codefrag">notify</span> method will allow a JSP page to retrieve and display the current notification message. Notice that the service class is also used to
+ setup and initialize the <span class="codefrag">LASTMESSAGE</span> resource property. Therefore, the the resource class will not need to perform these operations. The method is implemented as
+ follows:</p>
+<pre class="code">
+public void notify(org.oasisOpen.docs.wsn.x2004.x06.wsnWSBaseNotification12Draft01.NotifyDocument notifyDocument)
+ {
+ //get the property set
+ org.apache.ws.resource.properties.ResourcePropertySet resourcePropertySet = ((org.apache.ws.resource.PropertiesResource)getResource()).getResourcePropertySet();
+
+ //get the property
+ org.apache.ws.resource.properties.ResourceProperty resourceProperty = resourcePropertySet.get(ConsumerPropertyQNames.LASTMESSAGE);
+ resourceProperty.clear();//clear old notifs
+
+ //add the new entry
+ //build the LastMessage type for updating this resoruce property
+ LastMessageDocument lastMessageDocument = LastMessageDocument.Factory.newInstance();
+ org.apache.ws.resource.example.notifConsumer.LastMessageType lastMessageType = lastMessageDocument.addNewLastMessage();
+ lastMessageType.setOccurred(java.util.Calendar.getInstance());
+ org.apache.xmlbeans.XmlObject lastMessageNotif = lastMessageType.addNewNotification();
+ org.apache.ws.util.XmlBeanUtils.addChildElement(lastMessageNotif, notifyDocument);
+
+ //add the LastMessageDocument to the resource property
+ resourceProperty.add(lastMessageDocument);
+ }</pre>
+</div>
+
+<a name="N10042"></a><a name="Modify+the+Resource+Class"></a>
+<h2 class="boxed">Modify the Resource Class</h2>
+<div class="section">
+<p>The resource class is used to setup and initialize any resource properties. For the consumer example, the resource class is not used to setup and initialize the
+ <span class="codefrag">LASTMESSAGE</span> resource property, but instead the service class is used to perform these operations. If you choose to use the resource class, you should
+ update the <span class="codefrag">init()</span> method to add your properties to the <span class="codefrag">ResourcePropertySet</span>. The following sample code
+ is required for the consumer example. Below the consumer example code is an example of setting up and initializing resource properties in the resource class.
+ </p>
+<pre class="code">
+public void init()
+ {
+ super.init();
+ }
+ </pre>
+<p>Generic example of setting and initialing resource properties.</p>
+<pre class="code">
+public void init()
+ {
+ super.init();
+
+ /**
+ * The ResourcePropertySet which contains all the defined ResourceProperties
+ */
+ org.apache.ws.resource.properties.ResourcePropertySet resourcePropertySet = getResourcePropertySet();
+ org.apache.ws.resource.properties.ResourceProperty resourceProperty = null;
+
+
+ try{
+ // init the {http://ws.apache.org/resource/example/NotifConsumer}YourResourceProperty Property
+ resourceProperty = resourcePropertySet.get(ConsumerPortPropertyQNames.YourResourceProperty);
+
+ }
+ catch (Exception e)
+ {
+ throw new javax.xml.rpc.JAXRPCException("There was a problem in initializing your resource properties. Please check your init() method. Cause: " + e.getLocalizedMessage());
+ }
+} </pre>
+</div>
+
+<a name="N10060"></a><a name="Modify+the+Home+Class"></a>
+<h2 class="boxed">Modify the Home Class</h2>
+<div class="section">
+<p>The home class is used to lookup the resource instance. It can act as a factory for creating instances upon request, or build all instances. It is meant to be the entry point for
+ locating a resource instance. For the consumer example the <span class="codefrag">init()</span> method is modified to get an instance of the consumer resource. The resource is a singleton
+ and therfore only requires a single instance. For more information on creating a singleton, see the <a href="http://ws.apache.org/wsrf/dev_guide/singleton.html">Creating a Singleton Service</a> in the Apache WSRF
+ documentation.
+ </p>
+<pre class="code">
+ public void init() throws Exception
+ {
+ super.init();
+ add( createInstance( null ) );
+ }</pre>
+<div class="frame note">
+<div class="label">Note</div>
+<div class="content">At runtime, a client for the consumer must use the EPR to access the consumer resource. The EPR is returned by the notification producer when you subscribe to a
+ notification topic.
+ </div>
+</div>
+</div>
+
+</div>
+<!--+
+ |end content
+ +-->
+<div class="clearboth"> </div>
+</div>
+<div id="footer">
+<!--+
+ |start bottomstrip
+ +-->
+<div class="lastmodified">
+<script type="text/javascript"><!--
+document.write("Last Published: " + document.lastModified);
+// --></script>
+</div>
+<div class="copyright">
+ Copyright © 2004 The Apache Software Foundation.</div>
+<!--+
+ |end bottomstrip
+ +-->
+</div>
+</body>
+</html>
Added: webservices/pubscribe/site/dev_guide/debug.html
URL: http://svn.apache.org/viewcvs/webservices/pubscribe/site/dev_guide/debug.html?rev=230466&view=auto
==============================================================================
--- webservices/pubscribe/site/dev_guide/debug.html (added)
+++ webservices/pubscribe/site/dev_guide/debug.html Fri Aug 5 06:43:47 2005
@@ -0,0 +1,254 @@
+<!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">
+<meta content="Apache Forrest" name="Generator">
+<meta name="Forrest-version" content="0.6">
+<meta name="Forrest-skin-name" content="pelt">
+<title>Logging</title>
+<link type="text/css" href="../skin/basic.css" rel="stylesheet">
+<link media="screen" type="text/css" href="../skin/screen.css" rel="stylesheet">
+<link media="print" type="text/css" href="../skin/print.css" rel="stylesheet">
+<link type="text/css" href="../skin/profile.css" rel="stylesheet">
+<script src="../skin/getBlank.js" language="javascript" type="text/javascript"></script><script src="../skin/getMenu.js" language="javascript" type="text/javascript"></script><script src="../skin/fontsize.js" language="javascript" type="text/javascript"></script>
+<link rel="shortcut icon" href="../images/apache.ico">
+</head>
+<body onload="init()">
+<script type="text/javascript">ndeSetTextSize();</script>
+<div id="top">
+<!--+
+ |breadtrail
+ +-->
+<div class="breadtrail">
+<a href="http://www.apache.org/">apache</a> > <a href="http://ws.apache.org">ws.apache</a><script src="../skin/breadcrumbs.js" language="JavaScript" type="text/javascript"></script>
+</div>
+<!--+
+ |header
+ +-->
+<div class="header">
+<!--+
+ |start group logo
+ +-->
+<div class="grouplogo">
+<a href="http://ws.apache.org/"><img class="logoImage" alt="Web Services" src="../images/ws-logo.gif"></a>
+</div>
+<!--+
+ |end group logo
+ +-->
+<!--+
+ |start Project Logo
+ +-->
+<div class="projectlogoA1">
+<a href="http://ws.apache.org/ws-fx/pubscribe/"><img class="logoImage" alt="Pubscribe" src="../images/pubscribe-logo.gif"></a>
+</div>
+<!--+
+ |end Project Logo
+ +-->
+<!--+
+ |start Tabs
+ +-->
+<ul id="tabs">
+<li>
+<a class="base-not-selected" href="../index.html">Project Info</a>
+</li>
+<li class="current">
+<a class="base-selected" href="../getting_started.html">Documentation</a>
+</li>
+<li>
+<a class="base-not-selected" href="../apidocs/index.html">API Docs</a>
+</li>
+</ul>
+<!--+
+ |end Tabs
+ +-->
+</div>
+</div>
+<div id="main">
+<div id="publishedStrip">
+<!--+
+ |start Subtabs
+ +-->
+<div id="level2tabs"></div>
+<!--+
+ |end Endtabs
+ +-->
+<script type="text/javascript" language="JavaScript"><!--
+ document.write("Published: " + document.lastModified);
+ // --></script>
+</div>
+<!--+
+ |breadtrail
+ +-->
+<div class="breadtrail">
+
+
+ </div>
+<!--+
+ |start Menu, mainarea
+ +-->
+<!--+
+ |start Menu
+ +-->
+<div id="menu">
+<div onclick="SwitchMenu('menu_1.1', '../skin/')" id="menu_1.1Title" class="menutitle">Getting Started</div>
+<div id="menu_1.1" class="menuitemgroup">
+<div class="menuitem">
+<a title="" href="../getting_started.html">Introduction</a>
+</div>
+<div class="menuitem">
+<a title="" href="../getting_started.html#install">Installation</a>
+</div>
+<div class="menuitem">
+<a title="" href="../getting_started.html#qd">Quick Demo</a>
+</div>
+</div>
+<div onclick="SwitchMenu('menu_1.2', '../skin/')" id="menu_1.2Title" class="menutitle">Tutorial</div>
+<div id="menu_1.2" class="menuitemgroup">
+<div class="menuitem">
+<a title="" href="../tutorial/index.html">Overview</a>
+</div>
+<div class="menuitem">
+<a title="" href="../tutorial/setup.html">Create Workspace</a>
+</div>
+<div class="menuitem">
+<a title="" href="../tutorial/wsdl.html">Create WSDL</a>
+</div>
+<div class="menuitem">
+<a title="" href="../tutorial/wsdl2java.html">Run wsdl2Java Tool</a>
+</div>
+<div class="menuitem">
+<a title="" href="../tutorial/mod_home.html">Modify Home Class</a>
+</div>
+<div class="menuitem">
+<a title="" href="../tutorial/mod_resource.html">Modify Resource Class</a>
+</div>
+<div class="menuitem">
+<a title="" href="../tutorial/webapp.html">Deploy Service</a>
+</div>
+<div class="menuitem">
+<a title="" href="../tutorial/test.html">Test</a>
+</div>
+</div>
+<div onclick="SwitchMenu('menu_selected_1.3', '../skin/')" id="menu_selected_1.3Title" class="menutitle" style="background-image: url('../skin/images/chapter_open.gif');">Developer Guide</div>
+<div id="menu_selected_1.3" class="selectedmenuitemgroup" style="display: block;">
+<div class="menuitem">
+<a title="" href="../dev_guide/index.html">Overview</a>
+</div>
+<div class="menuitem">
+<a title="" href="../dev_guide/wsdl.html">WSRF/WSN WSDL</a>
+</div>
+<div class="menuitem">
+<a title="" href="../dev_guide/wsdl_tool.html">Using Wsdl2Java</a>
+</div>
+<div class="menuitem">
+<a title="" href="../dev_guide/home.html">Home Class</a>
+</div>
+<div class="menuitem">
+<a title="" href="../dev_guide/producer.html">Notification Producer</a>
+</div>
+<div class="menuitem">
+<a title="" href="../dev_guide/consumer.html">Notification Consumer</a>
+</div>
+<div class="menuitem">
+<a title="" href="../dev_guide/subscription.html">Subscription Manager</a>
+</div>
+<div class="menuitem">
+<a title="" href="../dev_guide/deploy.html">Deploying</a>
+</div>
+<div class="menuitem">
+<a title="" href="../dev_guide/client.html">Using the SOAP Client</a>
+</div>
+<div class="menupage">
+<div class="menupagetitle">Logging</div>
+</div>
+</div>
+<div id="credit"></div>
+<div id="roundbottom">
+<img style="display: none" class="corner" height="15" width="15" alt="" src="../skin/images/rc-b-l-15-1body-2menu-3menu.png"></div>
+<!--+
+ |alternative credits
+ +-->
+</div>
+<!--+
+ |end Menu
+ +-->
+<!--+
+ |start content
+ +-->
+<div id="content">
+<div id="skinconf-txtlink"></div>
+<h1>Logging</h1>
+<div id="minitoc-area">
+<ul class="minitoc">
+<li>
+<a href="#Introduction">Introduction</a>
+</li>
+<li>
+<a href="#Changing+Log+Levels">Changing Log Levels</a>
+</li>
+</ul>
+</div>
+
+<a name="N1000C"></a><a name="Introduction"></a>
+<h2 class="boxed">Introduction</h2>
+<div class="section">
+<p>Pubscribe uses the Apache Commons Logging Framework with Log4j as the underlying logging system. You can configure Log4j using the log4j.properties
+ file. This includes changing log levels or where the output is emitted (e.g. stdout, log file, etc...). The properties file is located in the Pubscribe Web application in
+ the WEB-INF/classes directory.
+ </p>
+</div>
+
+<a name="N10016"></a><a name="Changing+Log+Levels"></a>
+<h2 class="boxed">Changing Log Levels</h2>
+<div class="section">
+<p>Log4j uses the following log levels: DEBUG, INFO, WARN, ERROR, and FATAL. By default, Apache WSRF is configured at the INFO level, which means messages logged
+ at INFO or higher level (i.e. INFO, WARN, ERROR, and FATAL) are included in the output. To see more detailed log messages, you must change the log level.
+ The following example assumes Tomcat.
+ </p>
+<p>To change the logging level:</p>
+<ol>
+
+<li>Using a text editor, open the log4j.properties file located in the WEB-INF/classes directory of the deployed Pubscribe Web application.</li>
+
+<li>Change the log level associated with all classes below the <span class="codefrag">log4j.category.org.apache.ws</span> package. For example:<pre class="code">
+log4j.category.org.apache.ws=DEBUG</pre>
+
+</li>
+
+<li>Save the log4j.properties file.</li>
+
+<li>Restart Tomcat.
+ <div class="frame note">
+<div class="label">Note</div>
+<div class="content">Log messages are displayed in Tomcat's standard output. If you are not using Tomcat, you may need to configure your Web container to include the output
+ in its standard output.</div>
+</div>
+
+</li>
+
+</ol>
+</div>
+
+</div>
+<!--+
+ |end content
+ +-->
+<div class="clearboth"> </div>
+</div>
+<div id="footer">
+<!--+
+ |start bottomstrip
+ +-->
+<div class="lastmodified">
+<script type="text/javascript"><!--
+document.write("Last Published: " + document.lastModified);
+// --></script>
+</div>
+<div class="copyright">
+ Copyright © 2004 The Apache Software Foundation.</div>
+<!--+
+ |end bottomstrip
+ +-->
+</div>
+</body>
+</html>
Added: webservices/pubscribe/site/dev_guide/deploy.html
URL: http://svn.apache.org/viewcvs/webservices/pubscribe/site/dev_guide/deploy.html?rev=230466&view=auto
==============================================================================
--- webservices/pubscribe/site/dev_guide/deploy.html (added)
+++ webservices/pubscribe/site/dev_guide/deploy.html Fri Aug 5 06:43:47 2005
@@ -0,0 +1,392 @@
+<!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">
+<meta content="Apache Forrest" name="Generator">
+<meta name="Forrest-version" content="0.6">
+<meta name="Forrest-skin-name" content="pelt">
+<title>Deploy the service to the Pubscribe Web Application</title>
+<link type="text/css" href="../skin/basic.css" rel="stylesheet">
+<link media="screen" type="text/css" href="../skin/screen.css" rel="stylesheet">
+<link media="print" type="text/css" href="../skin/print.css" rel="stylesheet">
+<link type="text/css" href="../skin/profile.css" rel="stylesheet">
+<script src="../skin/getBlank.js" language="javascript" type="text/javascript"></script><script src="../skin/getMenu.js" language="javascript" type="text/javascript"></script><script src="../skin/fontsize.js" language="javascript" type="text/javascript"></script>
+<link rel="shortcut icon" href="../images/apache.ico">
+</head>
+<body onload="init()">
+<script type="text/javascript">ndeSetTextSize();</script>
+<div id="top">
+<!--+
+ |breadtrail
+ +-->
+<div class="breadtrail">
+<a href="http://www.apache.org/">apache</a> > <a href="http://ws.apache.org">ws.apache</a><script src="../skin/breadcrumbs.js" language="JavaScript" type="text/javascript"></script>
+</div>
+<!--+
+ |header
+ +-->
+<div class="header">
+<!--+
+ |start group logo
+ +-->
+<div class="grouplogo">
+<a href="http://ws.apache.org/"><img class="logoImage" alt="Web Services" src="../images/ws-logo.gif"></a>
+</div>
+<!--+
+ |end group logo
+ +-->
+<!--+
+ |start Project Logo
+ +-->
+<div class="projectlogoA1">
+<a href="http://ws.apache.org/ws-fx/pubscribe/"><img class="logoImage" alt="Pubscribe" src="../images/pubscribe-logo.gif"></a>
+</div>
+<!--+
+ |end Project Logo
+ +-->
+<!--+
+ |start Tabs
+ +-->
+<ul id="tabs">
+<li>
+<a class="base-not-selected" href="../index.html">Project Info</a>
+</li>
+<li class="current">
+<a class="base-selected" href="../getting_started.html">Documentation</a>
+</li>
+<li>
+<a class="base-not-selected" href="../apidocs/index.html">API Docs</a>
+</li>
+</ul>
+<!--+
+ |end Tabs
+ +-->
+</div>
+</div>
+<div id="main">
+<div id="publishedStrip">
+<!--+
+ |start Subtabs
+ +-->
+<div id="level2tabs"></div>
+<!--+
+ |end Endtabs
+ +-->
+<script type="text/javascript" language="JavaScript"><!--
+ document.write("Published: " + document.lastModified);
+ // --></script>
+</div>
+<!--+
+ |breadtrail
+ +-->
+<div class="breadtrail">
+
+
+ </div>
+<!--+
+ |start Menu, mainarea
+ +-->
+<!--+
+ |start Menu
+ +-->
+<div id="menu">
+<div onclick="SwitchMenu('menu_1.1', '../skin/')" id="menu_1.1Title" class="menutitle">Getting Started</div>
+<div id="menu_1.1" class="menuitemgroup">
+<div class="menuitem">
+<a title="" href="../getting_started.html">Introduction</a>
+</div>
+<div class="menuitem">
+<a title="" href="../getting_started.html#install">Installation</a>
+</div>
+<div class="menuitem">
+<a title="" href="../getting_started.html#qd">Quick Demo</a>
+</div>
+</div>
+<div onclick="SwitchMenu('menu_1.2', '../skin/')" id="menu_1.2Title" class="menutitle">Tutorial</div>
+<div id="menu_1.2" class="menuitemgroup">
+<div class="menuitem">
+<a title="" href="../tutorial/index.html">Overview</a>
+</div>
+<div class="menuitem">
+<a title="" href="../tutorial/setup.html">Create Workspace</a>
+</div>
+<div class="menuitem">
+<a title="" href="../tutorial/wsdl.html">Create WSDL</a>
+</div>
+<div class="menuitem">
+<a title="" href="../tutorial/wsdl2java.html">Run wsdl2Java Tool</a>
+</div>
+<div class="menuitem">
+<a title="" href="../tutorial/mod_home.html">Modify Home Class</a>
+</div>
+<div class="menuitem">
+<a title="" href="../tutorial/mod_resource.html">Modify Resource Class</a>
+</div>
+<div class="menuitem">
+<a title="" href="../tutorial/webapp.html">Deploy Service</a>
+</div>
+<div class="menuitem">
+<a title="" href="../tutorial/test.html">Test</a>
+</div>
+</div>
+<div onclick="SwitchMenu('menu_selected_1.3', '../skin/')" id="menu_selected_1.3Title" class="menutitle" style="background-image: url('../skin/images/chapter_open.gif');">Developer Guide</div>
+<div id="menu_selected_1.3" class="selectedmenuitemgroup" style="display: block;">
+<div class="menuitem">
+<a title="" href="../dev_guide/index.html">Overview</a>
+</div>
+<div class="menuitem">
+<a title="" href="../dev_guide/wsdl.html">WSRF/WSN WSDL</a>
+</div>
+<div class="menuitem">
+<a title="" href="../dev_guide/wsdl_tool.html">Using Wsdl2Java</a>
+</div>
+<div class="menuitem">
+<a title="" href="../dev_guide/home.html">Home Class</a>
+</div>
+<div class="menuitem">
+<a title="" href="../dev_guide/producer.html">Notification Producer</a>
+</div>
+<div class="menuitem">
+<a title="" href="../dev_guide/consumer.html">Notification Consumer</a>
+</div>
+<div class="menuitem">
+<a title="" href="../dev_guide/subscription.html">Subscription Manager</a>
+</div>
+<div class="menupage">
+<div class="menupagetitle">Deploying</div>
+</div>
+<div class="menuitem">
+<a title="" href="../dev_guide/client.html">Using the SOAP Client</a>
+</div>
+<div class="menuitem">
+<a title="" href="../dev_guide/debug.html">Logging</a>
+</div>
+</div>
+<div id="credit"></div>
+<div id="roundbottom">
+<img style="display: none" class="corner" height="15" width="15" alt="" src="../skin/images/rc-b-l-15-1body-2menu-3menu.png"></div>
+<!--+
+ |alternative credits
+ +-->
+</div>
+<!--+
+ |end Menu
+ +-->
+<!--+
+ |start content
+ +-->
+<div id="content">
+<div id="skinconf-txtlink"></div>
+<h1>Deploy the service to the Pubscribe Web Application</h1>
+<div id="minitoc-area">
+<ul class="minitoc">
+<li>
+<a href="#intro">Introduction</a>
+</li>
+<li>
+<a href="#Using+the+generated+build+scripts">Using the generated build scripts</a>
+</li>
+<li>
+<a href="#steps">Manually Deploying your Service</a>
+</li>
+</ul>
+</div>
+
+<a name="N1000C"></a><a name="intro"></a>
+<h2 class="boxed">Introduction</h2>
+<div class="section">
+<p>The quickest way to deploy your WS Resource is to use the generated build scripts. The scripts compile and delploy your WS
+ Resource to the Pubscribe Web application, which is an Apache-Axis Web application. This section describes how to use the
+ generated build scripts and also how the script works so you can build your own scripts.</p>
+</div>
+
+<a name="N10016"></a><a name="Using+the+generated+build+scripts"></a>
+<h2 class="boxed">Using the generated build scripts</h2>
+<div class="section">
+<p>The Wsdl2Java tool generates an Ant build script that is used to compile and deploy your WS Resource. The script is located in the
+ output directory under the subdirectory for you WS Resource (e.g., <span class="codefrag">generated/</span>
+ <em>
+ <span class="codefrag">service_name</span>
+ </em>).</p>
+<p>To compile and deploy using the Ant script</p>
+<ol>
+
+<li>In your output directory, edit build.properties and modify the <span class="codefrag">pubscribe.webapp.dir</span>. If you are using
+ Tomcat and have <span class="codefrag">CATALINA_HOME</span> set, you do not need to modify this property.</li>
+
+<li>From a command prompt, change directories to <span class="codefrag">generated/</span>
+ <em>
+ <span class="codefrag">service_name</span>
+ </em>
+
+</li>
+
+<li>Run:</li>
+
+</ol>
+<pre class="code">
+ ant compile deploy </pre>
+<p>Start Tomcat and verify that the service is deployed by going to
+ <a class="external" href="http://localhost:8080/pubscribe/services">http://localhost:8080/pubscribe/services</a>
+
+</p>
+</div>
+
+<a name="N10052"></a><a name="steps"></a>
+<h2 class="boxed">Manually Deploying your Service</h2>
+<div class="section">
+<p>In this section we will describe how to manually deploy your service. We will describe each step in the process.</p>
+<ol>
+
+<li>
+
+<strong>Copy your WSDL file.</strong>
+
+<p>Your WSDL file needs to be copied to an appropriate location in the webapp. We recommend you put it in the
+ <span class="codefrag">pubscribe/WEB-INF/classes/wsdl</span> directory. This allows Axis to reference it from the classpath and avoids the need to
+ hard-code a location on your file system. This location is used when registering the service in the
+ <span class="codefrag">server-config.wsdd</span> file.
+ </p>
+
+</li>
+
+<li>
+
+<strong>Copy your classes.</strong>
+
+<p>You will need to copy any .class files, generated by Wsdl2Java or hand written, to the <span class="codefrag">pubscribe/WEB-INF/classes/</span> directory so that your service
+ can be created by Axis and Pubscribe.</p>
+
+</li>
+
+<li>
+
+<strong>Update the jndi-config.xml file.</strong>
+
+<p>The jndi-config.xml contains information about your service, resource, home and resource key. This information is necessary for
+ Pubscribe to create your home and handle requests for your service. It will setup the in-memory JNDI context for your classes.
+ Here is the entry that was used for the FileSystem example:</p>
+
+<pre class="code"> <service name="filesystem">
+ <resource name="home" type="example.filesystem.FileSystemHome">
+ <resourceParams>
+ <parameter>
+ <name>baseWebappUrl</name>
+ <value>http://$IP_ADDRESS$:8080/pubscribe</value>
+ </parameter>
+ <parameter>
+ <name>serviceClassName</name>
+ <value>example.filesystem.FileSystemService</value>
+ </parameter>
+ <parameter>
+ <name>resourceClassName</name>
+ <value>example.filesystem.FileSystemResource</value>
+ </parameter>
+ <parameter>
+ <name>wsdlTargetNamespace</name>
+ <value>http://ws.apache.org/resource/example/filesystem</value>
+ </parameter>
+ <parameter>
+ <name>resourceIdentifierReferenceParameterName</name>
+ <value>{http://ws.apache.org/resource/example/filesystem}ResourceIdentifier</value>
+ </parameter>
+ </resourceParams>
+ </resource>
+ </service></pre>
+
+<p>The<span class="codefrag"> name</span> attribute is a unique name in the config file to denote your service in JNDI. The resource "name" attribute is used for locating your home
+ instance, and is named <span class="codefrag">home</span>. Notice <span class="codefrag">serviceClassName</span> points to the clasname for the service class. The same is said for the
+ <span class="codefrag">resourceClassName</span>. The <span class="codefrag">wsdlTargetNamespace </span> is the target namespace from your WSDL.
+ </p>
+
+<p>The <span class="codefrag">baseWebappUrl</span> parameter is used to define the URL of your Web application. You can include a static host, or as an
+ alternative, you can use the following markers which are replaced at runtime:
+ </p>
+
+<ul>
+
+<li>
+
+<span class="codefrag">$IP_ADDRESS$</span> - An attempt is made to determine the IP address at runtime. (Do not use on multi-homed systems).</li>
+
+<li>
+
+<span class="codefrag">$HOST_NAME$</span> - An attempt is made to determine the host name at runtime.</li>
+
+</ul>
+
+<p>The <span class="codefrag">resourceIdentifierReferenceParameterName</span> parameter represents the name of the WS-Addressing-header that is used to
+ extract a unique resource identifier to lookup a specific WS-Resource instance. This value should be a QName that includes the local
+ reference parameter name in the format <em><span class="codefrag">{namespaceURI}localPart</span></em>, where namesapaceURI and localPart are the namespace and URI and local
+ part of the qualified name of the reference paramater that should contain the resource identifier. If you omit this entry, it is assumed that the service is a
+ <strong><span class="codefrag">SINGLETON</span></strong> service and no resource id is expected in the
+ WS-Addressing headers.
+ </p>
+
+</li>
+
+<li>
+
+<strong>Update the server-config.wsdd file</strong>
+
+<p>The <span class="codefrag">server-config.wsdd</span> file is the configuration file for the Axis SOAP engine,
+ which is bundled with Pubscribe. This file is located in the <span class="codefrag">pubscribe/WEB-INF/</span> directory.
+ See the <a href="http://ws.apache.org/axis/">Axis</a> documentation for complete instructions about <span class="codefrag">server-config.wsdd</span>
+
+</p>
+
+<p>The file contains a deployment entry for each Web service. For example, the FileSystem service example is:
+ </p>
+
+<pre class="code"> <service name="filesystem" provider="java:WSRF" style="document" use="literal">
+ <wsdlFile>/wsdl/FileSystem.wsdl</wsdlFile>
+ <requestFlow>
+ <handler type="java:org.apache.axis.handlers.JAXRPCHandler">
+ <parameter name="className" value="org.apache.axis.message.addressing.handler.AxisServerSideAddressingHandler"/>
+ <parameter name="referencePropertyNames" value="*"/>
+ </handler>
+ </requestFlow>
+ </service></pre>
+
+<p>The service <span class="codefrag">name</span> attribute is the endpoint name and should be the same as the port's <span class="codefrag">name</span> attribute
+ from your WSDL file. This will ensure people consuming your WSDL will be able to invoke your service.
+ </p>
+
+<p>Notice the entry for <span class="codefrag">wsdlFile</span> which points to the <span class="codefrag">/wsdl/FileSystem.wsdl</span>.
+ This translates to the wsdl directory under the <span class="codefrag">WEB-INF/classes</span> directory.
+ </p>
+
+<p>The last part is the <span class="codefrag">requestFlow</span>. This xml fragment is necessary to ensure the
+ requests are routed through the WS-Addressing handler. This is static and should
+ always be present. We did not define it globally in case there were other services
+ defined which will not use WS-Addressing.
+ </p>
+
+</li>
+
+</ol>
+</div>
+
+</div>
+<!--+
+ |end content
+ +-->
+<div class="clearboth"> </div>
+</div>
+<div id="footer">
+<!--+
+ |start bottomstrip
+ +-->
+<div class="lastmodified">
+<script type="text/javascript"><!--
+document.write("Last Published: " + document.lastModified);
+// --></script>
+</div>
+<div class="copyright">
+ Copyright © 2004 The Apache Software Foundation.</div>
+<!--+
+ |end bottomstrip
+ +-->
+</div>
+</body>
+</html>
Added: webservices/pubscribe/site/dev_guide/home.html
URL: http://svn.apache.org/viewcvs/webservices/pubscribe/site/dev_guide/home.html?rev=230466&view=auto
==============================================================================
--- webservices/pubscribe/site/dev_guide/home.html (added)
+++ webservices/pubscribe/site/dev_guide/home.html Fri Aug 5 06:43:47 2005
@@ -0,0 +1,281 @@
+<!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">
+<meta content="Apache Forrest" name="Generator">
+<meta name="Forrest-version" content="0.6">
+<meta name="Forrest-skin-name" content="pelt">
+<title>Writing a Home class</title>
+<link type="text/css" href="../skin/basic.css" rel="stylesheet">
+<link media="screen" type="text/css" href="../skin/screen.css" rel="stylesheet">
+<link media="print" type="text/css" href="../skin/print.css" rel="stylesheet">
+<link type="text/css" href="../skin/profile.css" rel="stylesheet">
+<script src="../skin/getBlank.js" language="javascript" type="text/javascript"></script><script src="../skin/getMenu.js" language="javascript" type="text/javascript"></script><script src="../skin/fontsize.js" language="javascript" type="text/javascript"></script>
+<link rel="shortcut icon" href="../images/apache.ico">
+</head>
+<body onload="init()">
+<script type="text/javascript">ndeSetTextSize();</script>
+<div id="top">
+<!--+
+ |breadtrail
+ +-->
+<div class="breadtrail">
+<a href="http://www.apache.org/">apache</a> > <a href="http://ws.apache.org">ws.apache</a><script src="../skin/breadcrumbs.js" language="JavaScript" type="text/javascript"></script>
+</div>
+<!--+
+ |header
+ +-->
+<div class="header">
+<!--+
+ |start group logo
+ +-->
+<div class="grouplogo">
+<a href="http://ws.apache.org/"><img class="logoImage" alt="Web Services" src="../images/ws-logo.gif"></a>
+</div>
+<!--+
+ |end group logo
+ +-->
+<!--+
+ |start Project Logo
+ +-->
+<div class="projectlogoA1">
+<a href="http://ws.apache.org/ws-fx/pubscribe/"><img class="logoImage" alt="Pubscribe" src="../images/pubscribe-logo.gif"></a>
+</div>
+<!--+
+ |end Project Logo
+ +-->
+<!--+
+ |start Tabs
+ +-->
+<ul id="tabs">
+<li>
+<a class="base-not-selected" href="../index.html">Project Info</a>
+</li>
+<li class="current">
+<a class="base-selected" href="../getting_started.html">Documentation</a>
+</li>
+<li>
+<a class="base-not-selected" href="../apidocs/index.html">API Docs</a>
+</li>
+</ul>
+<!--+
+ |end Tabs
+ +-->
+</div>
+</div>
+<div id="main">
+<div id="publishedStrip">
+<!--+
+ |start Subtabs
+ +-->
+<div id="level2tabs"></div>
+<!--+
+ |end Endtabs
+ +-->
+<script type="text/javascript" language="JavaScript"><!--
+ document.write("Published: " + document.lastModified);
+ // --></script>
+</div>
+<!--+
+ |breadtrail
+ +-->
+<div class="breadtrail">
+
+
+ </div>
+<!--+
+ |start Menu, mainarea
+ +-->
+<!--+
+ |start Menu
+ +-->
+<div id="menu">
+<div onclick="SwitchMenu('menu_1.1', '../skin/')" id="menu_1.1Title" class="menutitle">Getting Started</div>
+<div id="menu_1.1" class="menuitemgroup">
+<div class="menuitem">
+<a title="" href="../getting_started.html">Introduction</a>
+</div>
+<div class="menuitem">
+<a title="" href="../getting_started.html#install">Installation</a>
+</div>
+<div class="menuitem">
+<a title="" href="../getting_started.html#qd">Quick Demo</a>
+</div>
+</div>
+<div onclick="SwitchMenu('menu_1.2', '../skin/')" id="menu_1.2Title" class="menutitle">Tutorial</div>
+<div id="menu_1.2" class="menuitemgroup">
+<div class="menuitem">
+<a title="" href="../tutorial/index.html">Overview</a>
+</div>
+<div class="menuitem">
+<a title="" href="../tutorial/setup.html">Create Workspace</a>
+</div>
+<div class="menuitem">
+<a title="" href="../tutorial/wsdl.html">Create WSDL</a>
+</div>
+<div class="menuitem">
+<a title="" href="../tutorial/wsdl2java.html">Run wsdl2Java Tool</a>
+</div>
+<div class="menuitem">
+<a title="" href="../tutorial/mod_home.html">Modify Home Class</a>
+</div>
+<div class="menuitem">
+<a title="" href="../tutorial/mod_resource.html">Modify Resource Class</a>
+</div>
+<div class="menuitem">
+<a title="" href="../tutorial/webapp.html">Deploy Service</a>
+</div>
+<div class="menuitem">
+<a title="" href="../tutorial/test.html">Test</a>
+</div>
+</div>
+<div onclick="SwitchMenu('menu_selected_1.3', '../skin/')" id="menu_selected_1.3Title" class="menutitle" style="background-image: url('../skin/images/chapter_open.gif');">Developer Guide</div>
+<div id="menu_selected_1.3" class="selectedmenuitemgroup" style="display: block;">
+<div class="menuitem">
+<a title="" href="../dev_guide/index.html">Overview</a>
+</div>
+<div class="menuitem">
+<a title="" href="../dev_guide/wsdl.html">WSRF/WSN WSDL</a>
+</div>
+<div class="menuitem">
+<a title="" href="../dev_guide/wsdl_tool.html">Using Wsdl2Java</a>
+</div>
+<div class="menupage">
+<div class="menupagetitle">Home Class</div>
+</div>
+<div class="menuitem">
+<a title="" href="../dev_guide/producer.html">Notification Producer</a>
+</div>
+<div class="menuitem">
+<a title="" href="../dev_guide/consumer.html">Notification Consumer</a>
+</div>
+<div class="menuitem">
+<a title="" href="../dev_guide/subscription.html">Subscription Manager</a>
+</div>
+<div class="menuitem">
+<a title="" href="../dev_guide/deploy.html">Deploying</a>
+</div>
+<div class="menuitem">
+<a title="" href="../dev_guide/client.html">Using the SOAP Client</a>
+</div>
+<div class="menuitem">
+<a title="" href="../dev_guide/debug.html">Logging</a>
+</div>
+</div>
+<div id="credit"></div>
+<div id="roundbottom">
+<img style="display: none" class="corner" height="15" width="15" alt="" src="../skin/images/rc-b-l-15-1body-2menu-3menu.png"></div>
+<!--+
+ |alternative credits
+ +-->
+</div>
+<!--+
+ |end Menu
+ +-->
+<!--+
+ |start content
+ +-->
+<div id="content">
+<div id="skinconf-txtlink"></div>
+<h1>Writing a Home class</h1>
+<div id="minitoc-area">
+<ul class="minitoc">
+<li>
+<a href="#intro">Introduction</a>
+</li>
+<li>
+<a href="#class-declaration">Class Declaration</a>
+</li>
+<li>
+<a href="#ops">Operations</a>
+</li>
+</ul>
+</div>
+
+<a name="N1000C"></a><a name="intro"></a>
+<h2 class="boxed">Introduction</h2>
+<div class="section">
+<p>The home class is used to lookup the resource instance. It can act as a factory for creating instances upon request, or build all instances. It is meant
+ to be the entry point for locating a resource instance.
+ </p>
+<div class="frame note">
+<div class="label">Note</div>
+<div class="content">If your service is a singleton and only requires a single resource instance, see the <a href="http://ws.apache.org/wsrf/dev_guide/singleton.html">Creating a Singleton Service</a> in the Apache WSRF
+ documentation.</div>
+</div>
+<p>If you use the Wsdl2Java tool, the home class is automatically generated but will need to modified to create instances of your resource. This section will
+ describe how to write a home class for your resource. Initially, you should model your resource off of the included <span class="codefrag">FilesystemHome</span> example
+ to ensure that you write a valid home class for your resource.</p>
+</div>
+
+<a name="N10023"></a><a name="class-declaration"></a>
+<h2 class="boxed">Class Declaration</h2>
+<div class="section">
+<p>The generated home class extends <span class="codefrag">AbstractResourceHome</span>. Extending <span class="codefrag">AbstractResourceHome</span>
+ provides services for caching instances and looking them up. It also ensures
+ that the correct interfaces are implemented so that Apache WSRF can interact with your home.
+ </p>
+<p>The <span class="codefrag">FileSystemHome</span> class extends <span class="codefrag">AbstractResourceHome</span> and implements <span class="codefrag">Serializable</span>:</p>
+<pre class="code">public class FileSystemHome
+ extends AbstractResourceHome
+ implements Serializable</pre>
+<div class="frame note">
+<div class="label">Note</div>
+<div class="content">Many of the operations in the <span class="codefrag">AbstractResourceHome</span> may be overridden in your Home
+ class, if you have a need to extend its functionality.</div>
+</div>
+</div>
+
+<a name="N10049"></a><a name="ops"></a>
+<h2 class="boxed">Operations</h2>
+<div class="section">
+<p>If you extend <span class="codefrag">AbstractResourceHome</span>, the only required operation you will need to implement is:</p>
+<pre class="code">public void init()</pre>
+<p>The <span class="codefrag">init()</span> operation can be used to initialize any instances at startup. In the FileSystem example, the <span class="codefrag">init()</span> method is used:</p>
+<pre class="code">public void init() throws Exception
+ {
+ super.init();
+ add( createInstance( LVOL1_ID ) );
+ add( createInstance( LVOL2_ID ) );
+ }</pre>
+<p>The <span class="codefrag">createInstance()</span> method:</p>
+<ul>
+
+<li>Creates an instance of the resource.</li>
+
+<li>Sets an endpoint reference on the resource.</li>
+
+<li>Calls <span class="codefrag">init()</span> on the resource.</li>
+
+</ul>
+<div class="frame note">
+<div class="label">Note</div>
+<div class="content">If you choose to not use the <span class="codefrag">createInstance()</span> method (e.g. if you have a non-empty constructor), then you must manually set the EPR then call
+ the <span class="codefrag">init()</span> method on the resource. The generated home class contains a utility method from the <span class="codefrag">AbstractResourceHome</span> that can be used
+ to build an EPR.</div>
+</div>
+</div>
+
+</div>
+<!--+
+ |end content
+ +-->
+<div class="clearboth"> </div>
+</div>
+<div id="footer">
+<!--+
+ |start bottomstrip
+ +-->
+<div class="lastmodified">
+<script type="text/javascript"><!--
+document.write("Last Published: " + document.lastModified);
+// --></script>
+</div>
+<div class="copyright">
+ Copyright © 2004 The Apache Software Foundation.</div>
+<!--+
+ |end bottomstrip
+ +-->
+</div>
+</body>
+</html>
Added: webservices/pubscribe/site/dev_guide/index.html
URL: http://svn.apache.org/viewcvs/webservices/pubscribe/site/dev_guide/index.html?rev=230466&view=auto
==============================================================================
--- webservices/pubscribe/site/dev_guide/index.html (added)
+++ webservices/pubscribe/site/dev_guide/index.html Fri Aug 5 06:43:47 2005
@@ -0,0 +1,342 @@
+<!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">
+<meta content="Apache Forrest" name="Generator">
+<meta name="Forrest-version" content="0.6">
+<meta name="Forrest-skin-name" content="pelt">
+<title>Pubscribe Developer Guide</title>
+<link type="text/css" href="../skin/basic.css" rel="stylesheet">
+<link media="screen" type="text/css" href="../skin/screen.css" rel="stylesheet">
+<link media="print" type="text/css" href="../skin/print.css" rel="stylesheet">
+<link type="text/css" href="../skin/profile.css" rel="stylesheet">
+<script src="../skin/getBlank.js" language="javascript" type="text/javascript"></script><script src="../skin/getMenu.js" language="javascript" type="text/javascript"></script><script src="../skin/fontsize.js" language="javascript" type="text/javascript"></script>
+<link rel="shortcut icon" href="../images/apache.ico">
+</head>
+<body onload="init()">
+<script type="text/javascript">ndeSetTextSize();</script>
+<div id="top">
+<!--+
+ |breadtrail
+ +-->
+<div class="breadtrail">
+<a href="http://www.apache.org/">apache</a> > <a href="http://ws.apache.org">ws.apache</a><script src="../skin/breadcrumbs.js" language="JavaScript" type="text/javascript"></script>
+</div>
+<!--+
+ |header
+ +-->
+<div class="header">
+<!--+
+ |start group logo
+ +-->
+<div class="grouplogo">
+<a href="http://ws.apache.org/"><img class="logoImage" alt="Web Services" src="../images/ws-logo.gif"></a>
+</div>
+<!--+
+ |end group logo
+ +-->
+<!--+
+ |start Project Logo
+ +-->
+<div class="projectlogoA1">
+<a href="http://ws.apache.org/ws-fx/pubscribe/"><img class="logoImage" alt="Pubscribe" src="../images/pubscribe-logo.gif"></a>
+</div>
+<!--+
+ |end Project Logo
+ +-->
+<!--+
+ |start Tabs
+ +-->
+<ul id="tabs">
+<li>
+<a class="base-not-selected" href="../index.html">Project Info</a>
+</li>
+<li class="current">
+<a class="base-selected" href="../getting_started.html">Documentation</a>
+</li>
+<li>
+<a class="base-not-selected" href="../apidocs/index.html">API Docs</a>
+</li>
+</ul>
+<!--+
+ |end Tabs
+ +-->
+</div>
+</div>
+<div id="main">
+<div id="publishedStrip">
+<!--+
+ |start Subtabs
+ +-->
+<div id="level2tabs"></div>
+<!--+
+ |end Endtabs
+ +-->
+<script type="text/javascript" language="JavaScript"><!--
+ document.write("Published: " + document.lastModified);
+ // --></script>
+</div>
+<!--+
+ |breadtrail
+ +-->
+<div class="breadtrail">
+
+
+ </div>
+<!--+
+ |start Menu, mainarea
+ +-->
+<!--+
+ |start Menu
+ +-->
+<div id="menu">
+<div onclick="SwitchMenu('menu_1.1', '../skin/')" id="menu_1.1Title" class="menutitle">Getting Started</div>
+<div id="menu_1.1" class="menuitemgroup">
+<div class="menuitem">
+<a title="" href="../getting_started.html">Introduction</a>
+</div>
+<div class="menuitem">
+<a title="" href="../getting_started.html#install">Installation</a>
+</div>
+<div class="menuitem">
+<a title="" href="../getting_started.html#qd">Quick Demo</a>
+</div>
+</div>
+<div onclick="SwitchMenu('menu_1.2', '../skin/')" id="menu_1.2Title" class="menutitle">Tutorial</div>
+<div id="menu_1.2" class="menuitemgroup">
+<div class="menuitem">
+<a title="" href="../tutorial/index.html">Overview</a>
+</div>
+<div class="menuitem">
+<a title="" href="../tutorial/setup.html">Create Workspace</a>
+</div>
+<div class="menuitem">
+<a title="" href="../tutorial/wsdl.html">Create WSDL</a>
+</div>
+<div class="menuitem">
+<a title="" href="../tutorial/wsdl2java.html">Run wsdl2Java Tool</a>
+</div>
+<div class="menuitem">
+<a title="" href="../tutorial/mod_home.html">Modify Home Class</a>
+</div>
+<div class="menuitem">
+<a title="" href="../tutorial/mod_resource.html">Modify Resource Class</a>
+</div>
+<div class="menuitem">
+<a title="" href="../tutorial/webapp.html">Deploy Service</a>
+</div>
+<div class="menuitem">
+<a title="" href="../tutorial/test.html">Test</a>
+</div>
+</div>
+<div onclick="SwitchMenu('menu_selected_1.3', '../skin/')" id="menu_selected_1.3Title" class="menutitle" style="background-image: url('../skin/images/chapter_open.gif');">Developer Guide</div>
+<div id="menu_selected_1.3" class="selectedmenuitemgroup" style="display: block;">
+<div class="menupage">
+<div class="menupagetitle">Overview</div>
+</div>
+<div class="menuitem">
+<a title="" href="../dev_guide/wsdl.html">WSRF/WSN WSDL</a>
+</div>
+<div class="menuitem">
+<a title="" href="../dev_guide/wsdl_tool.html">Using Wsdl2Java</a>
+</div>
+<div class="menuitem">
+<a title="" href="../dev_guide/home.html">Home Class</a>
+</div>
+<div class="menuitem">
+<a title="" href="../dev_guide/producer.html">Notification Producer</a>
+</div>
+<div class="menuitem">
+<a title="" href="../dev_guide/consumer.html">Notification Consumer</a>
+</div>
+<div class="menuitem">
+<a title="" href="../dev_guide/subscription.html">Subscription Manager</a>
+</div>
+<div class="menuitem">
+<a title="" href="../dev_guide/deploy.html">Deploying</a>
+</div>
+<div class="menuitem">
+<a title="" href="../dev_guide/client.html">Using the SOAP Client</a>
+</div>
+<div class="menuitem">
+<a title="" href="../dev_guide/debug.html">Logging</a>
+</div>
+</div>
+<div id="credit">
+<a href="http://forrest.apache.org/"><img border="0" title="Built with Apache Forrest" alt="Built with Apache Forrest - logo" src="../images/built-with-forrest-button.png" style="width: 88px;height: 31px;"></a>
+</div>
+<div id="roundbottom">
+<img style="display: none" class="corner" height="15" width="15" alt="" src="../skin/images/rc-b-l-15-1body-2menu-3menu.png"></div>
+<!--+
+ |alternative credits
+ +-->
+</div>
+<!--+
+ |end Menu
+ +-->
+<!--+
+ |start content
+ +-->
+<div id="content">
+<div id="skinconf-txtlink"></div>
+<h1>Pubscribe Developer Guide</h1>
+<div id="minitoc-area">
+<ul class="minitoc">
+<li>
+<a href="#About+this+Guide">About this Guide</a>
+</li>
+<li>
+<a href="#WSN+Overview">WSN Overview</a>
+</li>
+<li>
+<a href="#Conceptual+Overview">Conceptual Overview</a>
+<ul class="minitoc">
+<li>
+<a href="#Notification+Producer">Notification Producer</a>
+</li>
+<li>
+<a href="#Notification+Consumer">Notification Consumer</a>
+</li>
+</ul>
+</li>
+<li>
+<a href="#Design-Time">Design-Time</a>
+</li>
+</ul>
+</div>
+
+<a name="N1000C"></a><a name="About+this+Guide"></a>
+<h2 class="boxed">About this Guide</h2>
+<div class="section">
+<p>The Developer Guide provides instructions for using many of the features that are included in Pubscribe. If you are new to this project, you should start
+ with the <a href="../index.html">Getting Started</a> and the <a href="../tutorial/index.html">Tutorial</a> before reading this guide. They provide a good starting point for
+ learning how to use Pubscribe.</p>
+<div class="frame note">
+<div class="label">Note</div>
+<div class="content">Pubscribe is tightly integrated with <a href="http://ws.apache.org/wsrf/">Apache WSRF</a> as its WSRF foundation. While it is not required, it is a good idea to start with Apache WSRF.
+ You should also consult the Apache WSRF documentation while completing the instructions in this document. All of the tasks required in Apache WSRF are also required in
+ Pubscribe.
+ </div>
+</div>
+<p>The Developer guide often refers to different parts of the <a href="../wsn.html">Web Services Notifications (WSN) specifications</a> that are defined by
+ the OASIS standards body. You should become familiar with these specifications and refer to them as needed.
+ </p>
+<p>The Developer Guide guide often refers to Apache WSRF, Apache Axis, Apache Tomcat, Apache Ant, and Apache XMLBeans. Instructions for these packages are
+ included as required and are not meant to replace the formal documentation for these projects. Consult them as necessary.
+ </p>
+</div>
+
+<a name="N1002F"></a><a name="WSN+Overview"></a>
+<h2 class="boxed">WSN Overview</h2>
+<div class="section">
+<p>Pubscribe is an implementation of the <a href="../wsn.html">WSN</a> family of specifications that are defined by the OASIS standards body. The specifications describe
+ how to expose the publish/subscribe pattern using Web services in a way that is scalable from simple devices to enterprise messaging systems. The specifications
+ include:</p>
+<ul>
+
+<li>WS-BaseNotification - Defines the participants and messages needed to support basic notifications. A notification consumer can subscribe to one or more
+ notifications that are supported by a notification producer. When a notification is published to a producer, the producer sends SOAP notification messages to all
+ consumers who are currently subscribed for that particular notification. There is also optional support for enterprise scale messaging.</li>
+
+<li>WS-Topics - Defines how a hierarchy of notification topics can be described and how XPath-like topic expressions can be used to reference one or more topics in
+ the topic hierarchy.</li>
+
+<li>WS-BrokeredNotification - Defines how a simple resource can offload the responsibilities of managing subscriptions to another entity called a broker. Having a broker
+ aggregate messages from many resources also enables the ability to provide different notification channels through the use of topics.</li>
+
+</ul>
+</div>
+
+<a name="N10049"></a><a name="Conceptual+Overview"></a>
+<h2 class="boxed">Conceptual Overview</h2>
+<div class="section">
+<p>Pubscribe builds on top of Apache WSRF and provides three deliverables:</p>
+<ul>
+
+<li>APIs for WSN topic spaces, subscriptions, etc...</li>
+
+<li>Implementations of the operations defined by the WS-BaseNotification specification</li>
+
+<li>A SubscriptionManager service that exposes WS-Resources that represent subscriptions
+ <div class="frame note">
+<div class="label">Note</div>
+<div class="content">APIs and operation implementations are not currently provided for the WS-BrokeredNotification specification.</div>
+</div>
+
+</li>
+
+</ul>
+<a name="N10061"></a><a name="Notification+Producer"></a>
+<h3 class="boxed">Notification Producer</h3>
+<p>A resource that acts as a notification producer implements the WSN <span class="codefrag">NotificationProducer</span> portType. The resource has a <span class="codefrag">TopicSet</span>
+ object associated with it. This topic set represents the set of topics to which the resource may publish notifications and to which consumers may subscribe. As the
+ service developer of the producer resource, you are responsible for adding the topics you wish to support to the topic set using Pubscribe APIs.
+ </p>
+<p>When a Subscribe request is received, subscribe creates a new Subscription Resource which is exposed via the built-in <span class="codefrag">SubscriptionManager</span>
+ service. The Subscription Resource provides operations which allow clients to cancel, pause, or resume the associated subscription. To publish a notification to a topic,
+ you must call the <span class="codefrag">publish</span> method on the Topic object, passing it a DOM Node or XMLBeans XmlObject that represents the XML message to be published.
+ Pubscribe will then take care of wrapping the message in a SOAP envelope and sending it to all consumers who are subscribed to the associated Topic.
+ </p>
+<a name="N1007A"></a><a name="Notification+Consumer"></a>
+<h3 class="boxed">Notification Consumer</h3>
+<p>A resource that acts as a notification consumer implements the <span class="codefrag">NotificationConsumer</span> portType. This portType
+ includes only one operation - <span class="codefrag">Notify</span>. Producers invoke the <span class="codefrag">Notify</span> operation when they send notifications to the consumer resource. In
+ addition to the actual notification message, the <span class="codefrag">Notify</span> operation also includes the topic expression to which the message was published and the EPR of
+ the producer resource that generated the message. These additional components allow the consumer to correlate the message with a particular subscription.
+ </p>
+<p>Topic expressions are XPath-like expressions that refer to one or more topics. The <span class="codefrag">Subscribe</span> operation includes a topic expression that specifies
+ which topic(s) the client would like to subscribe to. The WS-Topics specification defines three topic expression dialects of varying complexity - Simple, Concrete, and
+ Full. Pubscribe includes full support for all three dialects, which means that any producer Resources you expose via Pubscribe can advertise to clients support
+ for all three dialects.
+ </p>
+</div>
+
+<a name="N10097"></a><a name="Design-Time"></a>
+<h2 class="boxed">Design-Time</h2>
+<div class="section">
+<p>A set of tools and integrations are provided that facilitate developing WSRF/WSN-compliant Web services. They are provided to help developers focus on
+ defining their WS Resource and Notification Topics without having to deal with low-level implementation details.</p>
+<div class="frame note">
+<div class="label">Note</div>
+<div class="content">These tools and integrations are not required to create WSRF/WSN-compliant Web services, but are instead provided to save you time.</div>
+</div>
+<p>The tools and integrations include:</p>
+<ul>
+
+<li>A WSRF/WSN WSDL template for writing WSRF/WSN-compliant WSDLs</li>
+
+<li>A Wsdl2Java tool for generating Java Classes from a WSDL.</li>
+
+<li>An integration with Apache XMLBeans for generating custom types defined in the WSDL</li>
+
+<li>an integration with Apache Axis for automatically deploying WS Resources</li>
+
+</ul>
+</div>
+
+</div>
+<!--+
+ |end content
+ +-->
+<div class="clearboth"> </div>
+</div>
+<div id="footer">
+<!--+
+ |start bottomstrip
+ +-->
+<div class="lastmodified">
+<script type="text/javascript"><!--
+document.write("Last Published: " + document.lastModified);
+// --></script>
+</div>
+<div class="copyright">
+ Copyright © 2004 The Apache Software Foundation.</div>
+<div id="logos">
+<a href="http://validator.w3.org/check/referer"><img style="height: 31px; width: 88px;" title="Valid HTML 4.01!" alt="Valid HTML 4.01!" src="../skin/images/valid-html401.png" class="logoImage"></a><a href="http://jigsaw.w3.org/css-validator/"><img style="height: 31px; width: 88px;" title="Valid CSS!" alt="Valid CSS!" src="../skin/images/vcss.png" class="logoImage"></a>
+</div>
+<!--+
+ |end bottomstrip
+ +-->
+</div>
+</body>
+</html>