ws-kandula-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From her...@apache.org
Subject svn commit: r607143 [7/15] - in /webservices/kandula/site/1/xref: ./ org/ org/apache/ org/apache/kandula/ org/apache/kandula/coordinator/ org/apache/kandula/coordinator/at/ org/apache/kandula/coordinator/ba/ org/apache/kandula/coordinator/ba/coordinato...
Date Fri, 28 Dec 2007 00:03:23 GMT
Added: webservices/kandula/site/1/xref/org/apache/kandula/coordinator/ba/coordinator/BACoordinator.html
URL: http://svn.apache.org/viewvc/webservices/kandula/site/1/xref/org/apache/kandula/coordinator/ba/coordinator/BACoordinator.html?rev=607143&view=auto
==============================================================================
--- webservices/kandula/site/1/xref/org/apache/kandula/coordinator/ba/coordinator/BACoordinator.html (added)
+++ webservices/kandula/site/1/xref/org/apache/kandula/coordinator/ba/coordinator/BACoordinator.html Thu Dec 27 16:03:17 2007
@@ -0,0 +1,538 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" /><title>BACoordinator xref</title>
+<link type="text/css" rel="stylesheet" href="../../../../../../stylesheet.css" />
+</head>
+<body>
+<div id="overview"><a href="../../../../../../../apidocs/org/apache/kandula/coordinator/ba/coordinator/BACoordinator.html">View Javadoc</a></div><pre>
+
+<a name="1" href="#1">1</a>   <em class="comment">/*</em>
+<a name="2" href="#2">2</a>   <em class="comment"> * Copyright 2007 The Apache Software Foundation.</em>
+<a name="3" href="#3">3</a>   <em class="comment"> * </em>
+<a name="4" href="#4">4</a>   <em class="comment"> * Licensed under the Apache License, Version 2.0 (the "License"); you may not</em>
+<a name="5" href="#5">5</a>   <em class="comment"> * use this file except in compliance with the License. You may obtain a copy of</em>
+<a name="6" href="#6">6</a>   <em class="comment"> * the License at</em>
+<a name="7" href="#7">7</a>   <em class="comment"> * </em>
+<a name="8" href="#8">8</a>   <em class="comment"> * <a href="http://www.apache.org/licenses/LICENSE-2.0" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></em>
+<a name="9" href="#9">9</a>   <em class="comment"> * </em>
+<a name="10" href="#10">10</a>  <em class="comment"> * Unless required by applicable law or agreed to in writing, software</em>
+<a name="11" href="#11">11</a>  <em class="comment"> * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT</em>
+<a name="12" href="#12">12</a>  <em class="comment"> * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the</em>
+<a name="13" href="#13">13</a>  <em class="comment"> * License for the specific language governing permissions and limitations under</em>
+<a name="14" href="#14">14</a>  <em class="comment"> * the License.</em>
+<a name="15" href="#15">15</a>  <em class="comment"> *</em>
+<a name="16" href="#16">16</a>  <em class="comment"> *  @author Hannes Erven, Georg Hicker</em>
+<a name="17" href="#17">17</a>  <em class="comment"> */</em>
+<a name="18" href="#18">18</a>  
+<a name="19" href="#19">19</a>  <strong>package</strong> <a href="../../../../../../org/apache/kandula/coordinator/ba/coordinator/package-summary.html">org.apache.kandula.coordinator.ba.coordinator</a>;
+<a name="20" href="#20">20</a>  
+<a name="21" href="#21">21</a>  
+<a name="22" href="#22">22</a>  <strong>import</strong> java.rmi.RemoteException;
+<a name="23" href="#23">23</a>  <strong>import</strong> java.util.Collection;
+<a name="24" href="#24">24</a>  <strong>import</strong> java.util.HashMap;
+<a name="25" href="#25">25</a>  <strong>import</strong> java.util.Iterator;
+<a name="26" href="#26">26</a>  <strong>import</strong> java.util.Map;
+<a name="27" href="#27">27</a>  
+<a name="28" href="#28">28</a>  <strong>import</strong> javax.xml.namespace.QName;
+<a name="29" href="#29">29</a>  <strong>import</strong> javax.xml.soap.Name;
+<a name="30" href="#30">30</a>  
+<a name="31" href="#31">31</a>  <strong>import</strong> org.apache.axis.AxisFault;
+<a name="32" href="#32">32</a>  <strong>import</strong> org.apache.axis.components.uuid.UUIDGen;
+<a name="33" href="#33">33</a>  <strong>import</strong> org.apache.axis.components.uuid.UUIDGenFactory;
+<a name="34" href="#34">34</a>  <strong>import</strong> org.apache.axis.message.addressing.EndpointReference;
+<a name="35" href="#35">35</a>  <strong>import</strong> org.apache.axis.types.URI;
+<a name="36" href="#36">36</a>  <strong>import</strong> org.apache.axis.types.URI.MalformedURIException;
+<a name="37" href="#37">37</a>  <strong>import</strong> org.apache.kandula.coordinator.CallbackRegistry;
+<a name="38" href="#38">38</a>  <strong>import</strong> org.apache.kandula.coordinator.CoordinationContext;
+<a name="39" href="#39">39</a>  <strong>import</strong> org.apache.kandula.coordinator.CoordinationService;
+<a name="40" href="#40">40</a>  <strong>import</strong> org.apache.kandula.coordinator.Coordinator;
+<a name="41" href="#41">41</a>  <strong>import</strong> org.apache.kandula.coordinator.CoordinatorImpl;
+<a name="42" href="#42">42</a>  <strong>import</strong> org.apache.kandula.coordinator.InvalidCoordinationProtocolException;
+<a name="43" href="#43">43</a>  <strong>import</strong> org.apache.kandula.coordinator.TimedOutException;
+<a name="44" href="#44">44</a>  <strong>import</strong> org.apache.kandula.coordinator.ba.ProtocolType;
+<a name="45" href="#45">45</a>  <strong>import</strong> org.apache.kandula.coordinator.ba.State;
+<a name="46" href="#46">46</a>  <strong>import</strong> org.apache.kandula.wsba.StateType;
+<a name="47" href="#47">47</a>  <strong>import</strong> org.apache.kandula.wsba.StatusType;
+<a name="48" href="#48">48</a>  <strong>import</strong> org.apache.kandula.wscoor.CreateCoordinationContextTypeCurrentContext;
+<a name="49" href="#49">49</a>  
+<a name="50" href="#50">50</a>  <strong>import</strong> org.apache.kandula.wsbai.BAParticipantReferenceType;
+<a name="51" href="#51">51</a>  <strong>import</strong> org.apache.kandula.wsbai.BAParticipantType;
+<a name="52" href="#52">52</a>  
+<a name="53" href="#53">53</a>  <em>/**<em>*</em></em>
+<a name="54" href="#54">54</a>  <em> * Base class for all WS-BusinessActivity coordinators.</em>
+<a name="55" href="#55">55</a>  <em> * </em>
+<a name="56" href="#56">56</a>  <em> * @author Hannes Erven, Georg Hicker (C) 2006</em>
+<a name="57" href="#57">57</a>  <em> *</em>
+<a name="58" href="#58">58</a>  <em> */</em>
+<a name="59" href="#59">59</a>  <strong>public</strong> <strong>abstract</strong> <strong>class</strong> <a href="../../../../../../org/apache/kandula/coordinator/ba/coordinator/BACoordinator.html">BACoordinator</a> <strong>extends</strong> <a href="../../../../../../org/apache/kandula/coordinator/CoordinatorImpl.html">CoordinatorImpl</a> {
+<a name="60" href="#60">60</a>  	<em>/**<em>*</em></em>
+<a name="61" href="#61">61</a>  <em>	 * The QName used to identify the BA with Coordinator Completion protocol.</em>
+<a name="62" href="#62">62</a>  <em>	 * TODO WSBA Change this to the final initiator protocol identifier</em>
+<a name="63" href="#63">63</a>  <em>	 */</em>
+<a name="64" href="#64">64</a>  	<strong>public</strong> <strong>final</strong> <strong>static</strong> String PROTOCOL_ID_INITIATOR = <span class="string">"http://big.tuwien.ac.at/ws-ba--extensions/protocol/initiator"</span>;
+<a name="65" href="#65">65</a>  	
+<a name="66" href="#66">66</a>  	<em>/**<em>*</em></em>
+<a name="67" href="#67">67</a>  <em>	 * The QName used to identify the Business Activity "Atomic" Outcome</em>
+<a name="68" href="#68">68</a>  <em>	 */</em>
+<a name="69" href="#69">69</a>  	<strong>public</strong> <strong>final</strong> <strong>static</strong> String COORDINATION_TYPE__ATOMIC = <span class="string">"http://schemas.xmlsoap.org/ws/2004/10/wsba/AtomicOutcome"</span>;
+<a name="70" href="#70">70</a>  	
+<a name="71" href="#71">71</a>  	<em>/**<em>*</em></em>
+<a name="72" href="#72">72</a>  <em>	 * The QName used to identify the Business Activity "Mixed" Outcome</em>
+<a name="73" href="#73">73</a>  <em>	 */</em>
+<a name="74" href="#74">74</a>  	<strong>public</strong> <strong>final</strong> <strong>static</strong> String COORDINATION_TYPE__MIXED = <span class="string">"http://schemas.xmlsoap.org/ws/2004/10/wsba/MixedOutcome"</span>;
+<a name="75" href="#75">75</a>  	
+<a name="76" href="#76">76</a>  	<em>/**<em>*</em></em>
+<a name="77" href="#77">77</a>  <em>	 * This QName is used to pass around the initiator's uuid.</em>
+<a name="78" href="#78">78</a>  <em>	 */</em>
+<a name="79" href="#79">79</a>  	<strong>public</strong> <strong>static</strong> <strong>final</strong> QName INITIATOR_REF = <strong>new</strong> QName(
+<a name="80" href="#80">80</a>  			<span class="string">"http://ws.apache.org/kandula"</span>, <span class="string">"InitiatorRef"</span>
+<a name="81" href="#81">81</a>  	);
+<a name="82" href="#82">82</a>  	
+<a name="83" href="#83">83</a>  	<em>/**<em>*</em></em>
+<a name="84" href="#84">84</a>  <em>	 * This QName identifies an error that is thrown when attempting to register</em>
+<a name="85" href="#85">85</a>  <em>	 * a given matchcode twice in a context</em>
+<a name="86" href="#86">86</a>  <em>	 */</em>
+<a name="87" href="#87">87</a>  	<strong>public</strong> <strong>static</strong> <strong>final</strong> QName DUPLICATE_MATCHCODE_FAULT = <strong>new</strong> QName(
+<a name="88" href="#88">88</a>  			PROTOCOL_ID_INITIATOR, <span class="string">"duplicateMatchcodeFault"</span>
+<a name="89" href="#89">89</a>  	);
+<a name="90" href="#90">90</a>  	
+<a name="91" href="#91">91</a>  	<em>/**<em>*</em></em>
+<a name="92" href="#92">92</a>  <em>	 * Return a new AxisFault instance with its faultCode set to</em>
+<a name="93" href="#93">93</a>  <em>	 * the  @see #DUPLICATE_MATCHCODE_FAULT QName.</em>
+<a name="94" href="#94">94</a>  <em>	 * @param matchcode The matchcode that was requested twice.</em>
+<a name="95" href="#95">95</a>  <em>	 * @return AxisFault</em>
+<a name="96" href="#96">96</a>  <em>	 */</em>
+<a name="97" href="#97">97</a>  	<strong>public</strong> AxisFault DUPLICATE_MATCHCODE_SOAP_FAULT(<strong>final</strong> String matchcode){
+<a name="98" href="#98">98</a>  		<strong>return</strong> <strong>new</strong> AxisFault(
+<a name="99" href="#99">99</a>  				DUPLICATE_MATCHCODE_FAULT,
+<a name="100" href="#100">100</a> 				<span class="string">"Attempted to register a matchcode that was already in use: "</span>+matchcode,
+<a name="101" href="#101">101</a> 				<span class="string">""</span>, <strong>null</strong>
+<a name="102" href="#102">102</a> 		);
+<a name="103" href="#103">103</a> 	}
+<a name="104" href="#104">104</a> 	
+<a name="105" href="#105">105</a> 	<em class="comment">/*</em>
+<a name="106" href="#106">106</a> <em class="comment">	 * = = = = = = = = = = = = = = =</em>
+<a name="107" href="#107">107</a> <em class="comment">	 */</em>
+<a name="108" href="#108">108</a> 	
+<a name="109" href="#109">109</a> 	<em>/**<em>*</em></em>
+<a name="110" href="#110">110</a> <em>	 * This field stores the chosen outcome Type (mixed/atomic).</em>
+<a name="111" href="#111">111</a> <em>	 */</em>
+<a name="112" href="#112">112</a> 	<strong>private</strong> <strong>final</strong> String outcomeType ;
+<a name="113" href="#113">113</a> 	
+<a name="114" href="#114">114</a> 	<em>/**<em>*</em></em>
+<a name="115" href="#115">115</a> <em>	 * The participants map contains all registered participants, accessible by</em>
+<a name="116" href="#116">116</a> <em>	 * their Participant UUID.</em>
+<a name="117" href="#117">117</a> <em>	 * Access to this map should be synchronized for any write access and for methods</em>
+<a name="118" href="#118">118</a> <em>	 * that use iterators or enumerations derived from the map. The map is expected</em>
+<a name="119" href="#119">119</a> <em>	 * to only extend, it never loses entries.</em>
+<a name="120" href="#120">120</a> <em>	 */</em>
+<a name="121" href="#121">121</a> 	<strong>private</strong> <strong>final</strong> Map participants = <strong>new</strong> HashMap();
+<a name="122" href="#122">122</a> 	
+<a name="123" href="#123">123</a> 	<em>/**<em>*</em></em>
+<a name="124" href="#124">124</a> <em>	 * This map contains a matchcode --> participant association. matchcodes</em>
+<a name="125" href="#125">125</a> <em>	 * are inserted with a null value as soon as the initiator requests </em>
+<a name="126" href="#126">126</a> <em>	 * a registration service endpoint for a matchcode.</em>
+<a name="127" href="#127">127</a> <em>	 * Synchronize access to this map!! </em>
+<a name="128" href="#128">128</a> <em>	 */</em>
+<a name="129" href="#129">129</a> 	<strong>private</strong> <strong>final</strong> Map participantMatchcodes = <strong>new</strong> HashMap();
+<a name="130" href="#130">130</a> 	
+<a name="131" href="#131">131</a> 	<em>/**<em>*</em></em>
+<a name="132" href="#132">132</a> <em>	 * A reference to the initiator, if they already registered.</em>
+<a name="133" href="#133">133</a> <em>	 */</em>
+<a name="134" href="#134">134</a> 	<strong>private</strong> <a href="../../../../../../org/apache/kandula/coordinator/ba/coordinator/InitiatorProxy.html">InitiatorProxy</a> initiator = <strong>null</strong>;
+<a name="135" href="#135">135</a> 	
+<a name="136" href="#136">136</a> 	<em>/**<em>*</em></em>
+<a name="137" href="#137">137</a> <em>	 * The default constructor. Use this to create a new Business Activity Coordinator.</em>
+<a name="138" href="#138">138</a> <em>	 * If superContext is given, this coordinator will register itself as a CoordinatorCompletion</em>
+<a name="139" href="#139">139</a> <em>	 * participant in the supercontext and will provide the initiator with all messages and state</em>
+<a name="140" href="#140">140</a> <em>	 * changes related to the supercontext. See the WSBAI specification for more detail.</em>
+<a name="141" href="#141">141</a> <em>	 *  </em>
+<a name="142" href="#142">142</a> <em>	 * @param pOutcomeType The outcome type for this coordination context.</em>
+<a name="143" href="#143">143</a> <em>	 * @param superContext The super context, if this is a subcontext</em>
+<a name="144" href="#144">144</a> <em>	 * @throws MalformedURIException Exception if the OutcomeType could not be parsed</em>
+<a name="145" href="#145">145</a> <em>	 * @throws InvalidOutcomeAssertion  Exception if the OutcomeType could be parsed, but not accepted</em>
+<a name="146" href="#146">146</a> <em>	 */</em>
+<a name="147" href="#147">147</a> 	<strong>protected</strong> <a href="../../../../../../org/apache/kandula/coordinator/ba/coordinator/BACoordinator.html">BACoordinator</a>(
+<a name="148" href="#148">148</a> 			<strong>final</strong> String pOutcomeType,
+<a name="149" href="#149">149</a> 			<strong>final</strong> CreateCoordinationContextTypeCurrentContext superContext
+<a name="150" href="#150">150</a> 	) 
+<a name="151" href="#151">151</a> 		throws MalformedURIException, <a href="../../../../../../org/apache/kandula/coordinator/ba/coordinator/InvalidOutcomeAssertion.html">InvalidOutcomeAssertion</a>
+<a name="152" href="#152">152</a> 	{		
+<a name="153" href="#153">153</a> 		<strong>super</strong>(pOutcomeType);
+<a name="154" href="#154">154</a> 		
+<a name="155" href="#155">155</a> 		<strong>if</strong> (superContext != <strong>null</strong>){
+<a name="156" href="#156">156</a> 			<em class="comment">// Check the super context </em>
+<a name="157" href="#157">157</a> 			<strong>if</strong> (false
+<a name="158" href="#158">158</a> 					|| COORDINATION_TYPE__ATOMIC.equals( superContext.getCoordinationType().toString() ) 
+<a name="159" href="#159">159</a> 					|| COORDINATION_TYPE__MIXED.equals( superContext.getCoordinationType().toString() )
+<a name="160" href="#160">160</a> 			){
+<a name="161" href="#161">161</a> 				<em class="comment">// Super's coordination type is OK</em>
+<a name="162" href="#162">162</a> 			}<strong>else</strong>{
+<a name="163" href="#163">163</a> 				<strong>throw</strong> <strong>new</strong> IllegalArgumentException(<span class="string">"The Kandula Business Activity coordination service currently can only create subordinate coordination contexts to a WS-BA parent context."</span>);
+<a name="164" href="#164">164</a> 			}
+<a name="165" href="#165">165</a> 			
+<a name="166" href="#166">166</a> 			<em class="comment">// TODO HE set super context and act appropriately...</em>
+<a name="167" href="#167">167</a> 			
+<a name="168" href="#168">168</a> 			
+<a name="169" href="#169">169</a> 		} <em class="comment">// end supercontext checks</em>
+<a name="170" href="#170">170</a> 		
+<a name="171" href="#171">171</a> 		<strong>if</strong> (COORDINATION_TYPE__ATOMIC.equals(pOutcomeType)){
+<a name="172" href="#172">172</a> 			<strong>this</strong>.outcomeType = pOutcomeType;
+<a name="173" href="#173">173</a> 		}<strong>else</strong> <strong>if</strong> (COORDINATION_TYPE__MIXED.equals(pOutcomeType)){
+<a name="174" href="#174">174</a> 			<strong>this</strong>.outcomeType = pOutcomeType;
+<a name="175" href="#175">175</a> 		}<strong>else</strong> {
+<a name="176" href="#176">176</a> 			<strong>throw</strong> <strong>new</strong> <a href="../../../../../../org/apache/kandula/coordinator/ba/coordinator/InvalidOutcomeAssertion.html">InvalidOutcomeAssertion</a>();
+<a name="177" href="#177">177</a> 		}
+<a name="178" href="#178">178</a> 	}
+<a name="179" href="#179">179</a> 	
+<a name="180" href="#180">180</a> 	
+<a name="181" href="#181">181</a> 	<em>/**<em>*</em></em>
+<a name="182" href="#182">182</a> <em>	 * Check if a particular match code has already been asked for.</em>
+<a name="183" href="#183">183</a> <em>	 * @param matchcode The match code to check.</em>
+<a name="184" href="#184">184</a> <em>	 * @return true, if the match code is available; false, if not.</em>
+<a name="185" href="#185">185</a> <em>	 */</em>
+<a name="186" href="#186">186</a> 	<strong>protected</strong> <strong>boolean</strong> isMatchCodeAvailable(<strong>final</strong> String matchcode){
+<a name="187" href="#187">187</a> 		<strong>return</strong> (! <strong>this</strong>.participantMatchcodes.containsKey(matchcode));
+<a name="188" href="#188">188</a> 	}
+<a name="189" href="#189">189</a> 	
+<a name="190" href="#190">190</a> 	<em>/**<em>*</em></em>
+<a name="191" href="#191">191</a> <em>	 * Activate a particular matchcode. A matchcode is used by the initiator to identify</em>
+<a name="192" href="#192">192</a> <em>	 * the transaction's participants.</em>
+<a name="193" href="#193">193</a> <em>	 * By default, we only allow registrations for protocols that include a valid matchcode</em>
+<a name="194" href="#194">194</a> <em>	 * that is activated, but not yet taken.</em>
+<a name="195" href="#195">195</a> <em>	 * This method returns an registrationService endpoint that is already tagged with</em>
+<a name="196" href="#196">196</a> <em>	 * the requested matchcode, if it was available.</em>
+<a name="197" href="#197">197</a> <em>	 * If the requested matchcode has already been taken, an invalidargumentexception is thrown.</em>
+<a name="198" href="#198">198</a> <em>	 *  </em>
+<a name="199" href="#199">199</a> <em>	 * @param matchcode The match code to register and activate</em>
+<a name="200" href="#200">200</a> <em>	 * @return Endpoint to this context's registration service, tagged with the match code.</em>
+<a name="201" href="#201">201</a> <em>	 * @throws AxisFault A ready-made fault, if the match code is already reserved or taken.</em>
+<a name="202" href="#202">202</a> <em>	 */</em>
+<a name="203" href="#203">203</a> 	<strong>public</strong> <a href="../../../../../../org/apache/kandula/coordinator/CoordinationContext.html">CoordinationContext</a> registerMatchcode(<strong>final</strong> String matchcode) throws AxisFault{
+<a name="204" href="#204">204</a> 		<strong>synchronized</strong> (<strong>this</strong>.participantMatchcodes) {
+<a name="205" href="#205">205</a> 			<strong>if</strong> (matchcode == <strong>null</strong> || matchcode.length()==0 )
+<a name="206" href="#206">206</a> 				<strong>throw</strong> <strong>new</strong> IllegalArgumentException(<span class="string">"The matchcode must not be null or emtpy!"</span>);
+<a name="207" href="#207">207</a> 			
+<a name="208" href="#208">208</a> 			<strong>if</strong> (! <strong>this</strong>.isMatchCodeAvailable(matchcode)){
+<a name="209" href="#209">209</a> 				<strong>throw</strong> DUPLICATE_MATCHCODE_SOAP_FAULT(matchcode);
+<a name="210" href="#210">210</a> 			}
+<a name="211" href="#211">211</a> 			
+<a name="212" href="#212">212</a> 			<strong>this</strong>.participantMatchcodes.put(matchcode, <strong>null</strong>);
+<a name="213" href="#213">213</a> 			
+<a name="214" href="#214">214</a> 			<strong>return</strong> <strong>this</strong>.getCoordinationContext(matchcode);
+<a name="215" href="#215">215</a> 		} <em class="comment">// end synchronized participantMatchcodes</em>
+<a name="216" href="#216">216</a> 	}
+<a name="217" href="#217">217</a> 	<em>/**<em>*</em></em>
+<a name="218" href="#218">218</a> <em>	 * Register a participant for one of the BAwCC or BAwPC protocols and</em>
+<a name="219" href="#219">219</a> <em>	 * return the protocol service's endpoint reference.</em>
+<a name="220" href="#220">220</a> <em>	 * </em>
+<a name="221" href="#221">221</a> <em>	 * @param protocol The requested protocol.</em>
+<a name="222" href="#222">222</a> <em>	 * @param participantEndpoint The participant's endpoint.</em>
+<a name="223" href="#223">223</a> <em>	 * @param matchcode The match code the participant asked for.</em>
+<a name="224" href="#224">224</a> <em>	 * @return The endpoint reference of the coordinator's protocol service, tagged with the</em>
+<a name="225" href="#225">225</a> <em>	 *  participant and transaction identifiers.</em>
+<a name="226" href="#226">226</a> <em>	 *  </em>
+<a name="227" href="#227">227</a> <em>	 * @throws InvalidCoordinationProtocolException </em>
+<a name="228" href="#228">228</a> <em>	 */</em>
+<a name="229" href="#229">229</a> 	<strong>public</strong> EndpointReference register(
+<a name="230" href="#230">230</a> 			<strong>final</strong> String protocol, 
+<a name="231" href="#231">231</a> 			<strong>final</strong> EndpointReference participantEndpoint,
+<a name="232" href="#232">232</a> 			<strong>final</strong> String matchcode
+<a name="233" href="#233">233</a> 	) 
+<a name="234" href="#234">234</a> 	throws <a href="../../../../../../org/apache/kandula/coordinator/InvalidCoordinationProtocolException.html">InvalidCoordinationProtocolException</a> {
+<a name="235" href="#235">235</a> 		
+<a name="236" href="#236">236</a> 		<em class="comment">// Check, whether a "valid" callback was supplied</em>
+<a name="237" href="#237">237</a> 		<strong>if</strong> (participantEndpoint == <strong>null</strong>)
+<a name="238" href="#238">238</a> 			<strong>throw</strong> <strong>new</strong> IllegalArgumentException(<span class="string">"Register: Participant Endpoint must not be null"</span>);
+<a name="239" href="#239">239</a> 		
+<a name="240" href="#240">240</a> 		
+<a name="241" href="#241">241</a> 		<em class="comment">// Calculate the new participant's GUID</em>
+<a name="242" href="#242">242</a> 		<em class="comment">// The kandula coordination service</em>
+<a name="243" href="#243">243</a> 		<strong>final</strong> <a href="../../../../../../org/apache/kandula/coordinator/CoordinationService.html">CoordinationService</a> cs = CoordinationService.getInstance();
+<a name="244" href="#244">244</a> 		
+<a name="245" href="#245">245</a> 		<strong>final</strong> UUIDGen gen = UUIDGenFactory.getUUIDGen();
+<a name="246" href="#246">246</a> 		<strong>final</strong> String newRef = <span class="string">"uuid:"</span> + gen.nextUUID();
+<a name="247" href="#247">247</a> 		
+<a name="248" href="#248">248</a> 		<strong>final</strong> EndpointReference  epr;
+<a name="249" href="#249">249</a> 		
+<a name="250" href="#250">250</a> 		<strong>try</strong>{
+<a name="251" href="#251">251</a> 			<em class="comment">// Check whether a valid protocol was supplied and register</em>
+<a name="252" href="#252">252</a> 			<strong>if</strong> (protocol.equals(PROTOCOL_ID_INITIATOR)){
+<a name="253" href="#253">253</a> 				<em class="comment">// OK, register as initiator; synchronize and set the initiator fields</em>
+<a name="254" href="#254">254</a> 
+<a name="255" href="#255">255</a> 				<strong>synchronized</strong>(<strong>this</strong>){				
+<a name="256" href="#256">256</a> 					<strong>if</strong> (<strong>this</strong>.initiator != <strong>null</strong>)
+<a name="257" href="#257">257</a> 						<strong>throw</strong> <strong>new</strong> IllegalStateException(<span class="string">"Sorry, there already is an initiator registered!"</span>);
+<a name="258" href="#258">258</a> 					
+<a name="259" href="#259">259</a> 					<strong>this</strong>.initiator = <strong>new</strong> <a href="../../../../../../org/apache/kandula/coordinator/ba/coordinator/InitiatorProxy.html">InitiatorProxy</a>(<strong>new</strong>Ref, participantEndpoint);
+<a name="260" href="#260">260</a> 					epr = cs.getInitiatorCoordinatorService(<strong>this</strong>, newRef);
+<a name="261" href="#261">261</a> 				} <em class="comment">// end synchronized this</em>
+<a name="262" href="#262">262</a> 			}<strong>else</strong>{
+<a name="263" href="#263">263</a> 				<em class="comment">// Other protocols</em>
+<a name="264" href="#264">264</a> 				<strong>final</strong> <a href="../../../../../../org/apache/kandula/coordinator/ba/coordinator/AbstractCoordParticipant.html">AbstractCoordParticipant</a> newParticipant;
+<a name="265" href="#265">265</a> 				
+<a name="266" href="#266">266</a> 				<em class="comment">/*</em>
+<a name="267" href="#267">267</a> <em class="comment">				 * While registration is in progress, lock the match code table</em>
+<a name="268" href="#268">268</a> <em class="comment">				 * </em>
+<a name="269" href="#269">269</a> <em class="comment">				 */</em>
+<a name="270" href="#270">270</a> 				<strong>synchronized</strong>(<strong>this</strong>.participantMatchcodes){
+<a name="271" href="#271">271</a> 					<strong>if</strong> (! <strong>this</strong>.participantMatchcodes.containsKey(matchcode)){
+<a name="272" href="#272">272</a> 						<strong>throw</strong> <strong>new</strong> IllegalArgumentException(<span class="string">"Sorry, the matchcode "</span>+matchcode+<span class="string">" has not been activated."</span>);
+<a name="273" href="#273">273</a> 					}
+<a name="274" href="#274">274</a> 					<strong>if</strong> (<strong>this</strong>.participantMatchcodes.get(matchcode) != <strong>null</strong>){
+<a name="275" href="#275">275</a> 						<strong>final</strong> IllegalArgumentException x = <strong>new</strong> IllegalArgumentException(<span class="string">"Sorry, the matchcode "</span>+matchcode+<span class="string">" has already been taken."</span>);
+<a name="276" href="#276">276</a> 						<strong>throw</strong> x;
+<a name="277" href="#277">277</a> 					}
+<a name="278" href="#278">278</a> 	
+<a name="279" href="#279">279</a> 					<strong>if</strong> (! <strong>this</strong>.isRegistrationPossible() ){
+<a name="280" href="#280">280</a> 						<strong>final</strong> AxisFault af = CONTEXT_REFUSED_SOAP_FAULT();
+<a name="281" href="#281">281</a> 						af.addFaultDetailString(<span class="string">"The context exists, but work has progressed so far that no more registrations are accepted."</span>);
+<a name="282" href="#282">282</a> 						<strong>throw</strong> af;
+<a name="283" href="#283">283</a> 					}
+<a name="284" href="#284">284</a> 					
+<a name="285" href="#285">285</a> 					<strong>if</strong> (protocol.equals(ProtocolType.PROTOCOL_ID_CC.getNamespaceURI()+ProtocolType.PROTOCOL_ID_CC.getLocalPart())){
+<a name="286" href="#286">286</a> 						<em class="comment">// OK, register for Coordinator Completion </em>
+<a name="287" href="#287">287</a> 						
+<a name="288" href="#288">288</a> 						<strong>new</strong>Participant = <strong>new</strong> <a href="../../../../../../org/apache/kandula/coordinator/ba/coordinator/BAwCCCoordParticipant.html">BAwCCCoordParticipant</a>(<strong>new</strong>Ref, participantEndpoint, <strong>this</strong>, matchcode);
+<a name="289" href="#289">289</a> 					}<strong>else</strong> <strong>if</strong> (protocol.equals(ProtocolType.PROTOCOL_ID_PC.getNamespaceURI()+ProtocolType.PROTOCOL_ID_PC.getLocalPart())){
+<a name="290" href="#290">290</a> 						
+<a name="291" href="#291">291</a> 						<em class="comment">// OK, register for Participant Completion</em>
+<a name="292" href="#292">292</a> 						
+<a name="293" href="#293">293</a> 						<strong>new</strong>Participant = <strong>new</strong> <a href="../../../../../../org/apache/kandula/coordinator/ba/coordinator/BAwPCCoordParticipant.html">BAwPCCoordParticipant</a>(<strong>new</strong>Ref, participantEndpoint, <strong>this</strong>, matchcode);
+<a name="294" href="#294">294</a> 					}<strong>else</strong>{
+<a name="295" href="#295">295</a> 						<strong>throw</strong> <strong>new</strong> <a href="../../../../../../org/apache/kandula/coordinator/InvalidCoordinationProtocolException.html">InvalidCoordinationProtocolException</a>();
+<a name="296" href="#296">296</a> 					}
+<a name="297" href="#297">297</a> 					
+<a name="298" href="#298">298</a> 					<em class="comment">// Register participant object</em>
+<a name="299" href="#299">299</a> 					<strong>this</strong>.participantMatchcodes.put(matchcode, newParticipant);
+<a name="300" href="#300">300</a> 				} <em class="comment">// End synchronized (this.participantMatchcode)</em>
+<a name="301" href="#301">301</a> 
+<a name="302" href="#302">302</a> 				<em class="comment">/*</em>
+<a name="303" href="#303">303</a> <em class="comment">				 * Synchronize on both this (used by buildParticipantList) and this.participants</em>
+<a name="304" href="#304">304</a> <em class="comment">				 * (used by registration) to lock participant lists before adding</em>
+<a name="305" href="#305">305</a> <em class="comment">				 */</em>
+<a name="306" href="#306">306</a> 				<strong>synchronized</strong>(<strong>this</strong>){
+<a name="307" href="#307">307</a> 					<strong>synchronized</strong> (<strong>this</strong>.participants) {
+<a name="308" href="#308">308</a> 						<strong>this</strong>.participants.put(newRef, newParticipant);
+<a name="309" href="#309">309</a> 					}
+<a name="310" href="#310">310</a> 				}
+<a name="311" href="#311">311</a> 				epr = cs.getCoordinatorService(<strong>this</strong>, newRef, protocol);
+<a name="312" href="#312">312</a> 				CallbackRegistry.getInstance().registerCallback(newParticipant);
+<a name="313" href="#313">313</a> 			} <em class="comment">// End protocol switch </em>
+<a name="314" href="#314">314</a> 		}
+<a name="315" href="#315">315</a> 		<strong>catch</strong>(AxisFault f){
+<a name="316" href="#316">316</a> 			<strong>throw</strong> <strong>new</strong> IllegalArgumentException(<span class="string">"Sorry, could not instantiate a participant: "</span>+f);
+<a name="317" href="#317">317</a> 		}
+<a name="318" href="#318">318</a> 		<strong>return</strong> epr;
+<a name="319" href="#319">319</a> 	}
+<a name="320" href="#320">320</a> 	
+<a name="321" href="#321">321</a> 	<em>/**<em>*</em></em>
+<a name="322" href="#322">322</a> <em>	 * Check if enrolling a new participant is allowed in the current state</em>
+<a name="323" href="#323">323</a> <em>	 * of the transaction.</em>
+<a name="324" href="#324">324</a> <em>	 * @return false, if registration requests shall be rejected.</em>
+<a name="325" href="#325">325</a> <em>	 */</em>
+<a name="326" href="#326">326</a> 	<strong>abstract</strong> <strong>boolean</strong> isRegistrationPossible();
+<a name="327" href="#327">327</a> 
+<a name="328" href="#328">328</a> 
+<a name="329" href="#329">329</a> 	<em>/**<em>*</em></em>
+<a name="330" href="#330">330</a> <em>	 * Registers an incoming fault.</em>
+<a name="331" href="#331">331</a> <em>	 * @param code The fault code.</em>
+<a name="332" href="#332">332</a> <em>	 */</em>
+<a name="333" href="#333">333</a> 	<strong>public</strong> <strong>void</strong> onFault(Name code) {
+<a name="334" href="#334">334</a> 		<em class="comment">// TODO WSBA Handle faults</em>
+<a name="335" href="#335">335</a> 		
+<a name="336" href="#336">336</a> 		System.out.println(<span class="string">"[BACoordinator] onFault: "</span> + code);
+<a name="337" href="#337">337</a> 	}
+<a name="338" href="#338">338</a> 	
+<a name="339" href="#339">339</a> 	<em>/**<em>*</em></em>
+<a name="340" href="#340">340</a> <em>	 * The transaction context timed out. Notify all participants </em>
+<a name="341" href="#341">341</a> <em>	 * and get outta here!</em>
+<a name="342" href="#342">342</a> <em>	 * @throws TimedOutException ???</em>
+<a name="343" href="#343">343</a> <em>	 */</em>
+<a name="344" href="#344">344</a> 	<strong>public</strong> <strong>void</strong> timeout() throws TimedOutException {
+<a name="345" href="#345">345</a> 		<em class="comment">// TODO WSBA Handle timeouts</em>
+<a name="346" href="#346">346</a> 		
+<a name="347" href="#347">347</a> 		<strong>if</strong> (false)
+<a name="348" href="#348">348</a> 			<strong>throw</strong> <strong>new</strong> <a href="../../../../../../org/apache/kandula/coordinator/TimedOutException.html">TimedOutException</a>();
+<a name="349" href="#349">349</a> 	}
+<a name="350" href="#350">350</a> 	
+<a name="351" href="#351">351</a> 	<em>/**<em>*</em></em>
+<a name="352" href="#352">352</a> <em>	 * This coordinator's endpoint reference.</em>
+<a name="353" href="#353">353</a> <em>	 * (Seems to be an unused method, since there is always an UnsupportedOperationException thrown)</em>
+<a name="354" href="#354">354</a> <em>	 * @return ERROR !</em>
+<a name="355" href="#355">355</a> <em>	 */</em>
+<a name="356" href="#356">356</a> 	<strong>public</strong> EndpointReference getEndpointReference() {
+<a name="357" href="#357">357</a> 		<strong>throw</strong> <strong>new</strong> UnsupportedOperationException();
+<a name="358" href="#358">358</a> 	}
+<a name="359" href="#359">359</a> 	
+<a name="360" href="#360">360</a> 	<em>/**<em>*</em></em>
+<a name="361" href="#361">361</a> <em>	 * Returns this Coordinator's coordination type.</em>
+<a name="362" href="#362">362</a> <em>	 * </em>
+<a name="363" href="#363">363</a> <em>	 * @return One of COORDINATION_TYPE__ATOMIC and COORDINATION_TYPE__MIXED</em>
+<a name="364" href="#364">364</a> <em>	 * @see #COORDINATION_TYPE__ATOMIC</em>
+<a name="365" href="#365">365</a> <em>	 * @see #COORDINATION_TYPE__MIXED</em>
+<a name="366" href="#366">366</a> <em>	 */</em>
+<a name="367" href="#367">367</a> 	<strong>public</strong> String getOutcomeType() {
+<a name="368" href="#368">368</a> 		<strong>return</strong> <strong>this</strong>.outcomeType;
+<a name="369" href="#369">369</a> 	}
+<a name="370" href="#370">370</a> 	
+<a name="371" href="#371">371</a> 	<em>/**<em>*</em></em>
+<a name="372" href="#372">372</a> <em>	 * Check, if the given participant is a registered participant in this context.</em>
+<a name="373" href="#373">373</a> <em>	 * @param participant The participant.</em>
+<a name="374" href="#374">374</a> <em>	 * @return true, if the participant is registered in the current transaction; false, if not.</em>
+<a name="375" href="#375">375</a> <em>	 */</em>
+<a name="376" href="#376">376</a> 	<strong>public</strong> <strong>boolean</strong> containsParticipant(<strong>final</strong> <a href="../../../../../../org/apache/kandula/coordinator/ba/coordinator/AbstractCoordParticipant.html">AbstractCoordParticipant</a> participant){
+<a name="377" href="#377">377</a> 	
+<a name="378" href="#378">378</a> 		<em class="comment">// Doesn't need synchronization since de-registration is not possible</em>
+<a name="379" href="#379">379</a> 		
+<a name="380" href="#380">380</a> 		<strong>return</strong> <strong>this</strong>.participants.containsValue(participant);
+<a name="381" href="#381">381</a> 	}
+<a name="382" href="#382">382</a> 	
+<a name="383" href="#383">383</a> 	<em>/**<em>*</em></em>
+<a name="384" href="#384">384</a> <em>	 * This method is used by participant objects to signal state changes to the coordination context.</em>
+<a name="385" href="#385">385</a> <em>	 * It is synchronized to avoid any problems that may arise when multiple participants change</em>
+<a name="386" href="#386">386</a> <em>	 * states at the same time.</em>
+<a name="387" href="#387">387</a> <em>	 *</em>
+<a name="388" href="#388">388</a> <em>	 * This method contains any process logic that does not need business logic and hence may be </em>
+<a name="389" href="#389">389</a> <em>	 * implemented in the coordinator, e.g. automatically</em>
+<a name="390" href="#390">390</a> <em>	 * acknowledging state changes as ACTIVE->EXIT->EXITING->EXITED->ENDED .</em>
+<a name="391" href="#391">391</a> <em>	 * </em>
+<a name="392" href="#392">392</a> <em>	 * Any state change will also be automatically be forwarded to the initiator. For those state</em>
+<a name="393" href="#393">393</a> <em>	 * changes where the coordinator does not have sufficient knowledge of the initiator's goals to</em>
+<a name="394" href="#394">394</a> <em>	 * direct the participant to the next state, it will wait for the initiator to issue new commands.</em>
+<a name="395" href="#395">395</a> <em>	 * </em>
+<a name="396" href="#396">396</a> <em>	 * @param participant The participant that changed states</em>
+<a name="397" href="#397">397</a> <em>	 * @param newState The state after the transition (= current state of the participant)</em>
+<a name="398" href="#398">398</a> <em>	 * @throws RemoteException Exception while handling the transition. </em>
+<a name="399" href="#399">399</a> <em>	 */</em>
+<a name="400" href="#400">400</a> 	<strong>public</strong> <strong>void</strong> handleStateTransition(
+<a name="401" href="#401">401</a> 			<strong>final</strong> <a href="../../../../../../org/apache/kandula/coordinator/ba/coordinator/AbstractCoordParticipant.html">AbstractCoordParticipant</a> participant,
+<a name="402" href="#402">402</a> 			<strong>final</strong> QName newState
+<a name="403" href="#403">403</a> 	) throws RemoteException {
+<a name="404" href="#404">404</a> 		<em class="comment">// TODO WSBA Forward any state change to the initiator</em>
+<a name="405" href="#405">405</a> 
+<a name="406" href="#406">406</a> 		<em class="comment">// Ensure we may change participant states</em>
+<a name="407" href="#407">407</a> 		<em class="comment">// (this should be the case anyways)</em>
+<a name="408" href="#408">408</a> 		<strong>synchronized</strong>(<strong>this</strong>){
+<a name="409" href="#409">409</a> 			<strong>if</strong> (State.STATE_EXITING.equals(newState)){
+<a name="410" href="#410">410</a> 				<em class="comment">// Participant is in state EXITING, send EXITED and set state to ENDED.</em>
+<a name="411" href="#411">411</a> 				participant.tellExited();
+<a name="412" href="#412">412</a> 			}<strong>else</strong> <strong>if</strong> (false 
+<a name="413" href="#413">413</a> 					|| State.STATE_FAULTING.equals(newState)
+<a name="414" href="#414">414</a> 					|| State.STATE_FAULTING_ACTIVE.equals(newState)
+<a name="415" href="#415">415</a> 					|| State.STATE_FAULTING_COMPENSATING.equals(newState)
+<a name="416" href="#416">416</a> 			){
+<a name="417" href="#417">417</a> 				participant.tellFaulted();
+<a name="418" href="#418">418</a> 			}<strong>else</strong>{
+<a name="419" href="#419">419</a> 				System.out.println(<span class="string">"State transition to "</span>+newState+<span class="string">" must be handled by initiator!"</span>);
+<a name="420" href="#420">420</a> 			}
+<a name="421" href="#421">421</a> 
+<a name="422" href="#422">422</a> 			<em class="comment">/*</em>
+<a name="423" href="#423">423</a> <em class="comment">			 *  As soon as the ENDED state is reached, we no longer accept</em>
+<a name="424" href="#424">424</a> <em class="comment">			 *  messages from the client and hence remove them from the</em>
+<a name="425" href="#425">425</a> <em class="comment">			 *  callback registry. (This also aborts the timeout timertask.)</em>
+<a name="426" href="#426">426</a> <em class="comment">			 *  We dont remove them from the participants map, so the initiator</em>
+<a name="427" href="#427">427</a> <em class="comment">			 *  can still see the participant and their state.</em>
+<a name="428" href="#428">428</a> <em class="comment">			 */</em>
+<a name="429" href="#429">429</a> 			<strong>if</strong> (State.STATE_ENDED.equals(newState)){
+<a name="430" href="#430">430</a> 				CallbackRegistry.getInstance().remove(participant);
+<a name="431" href="#431">431</a> 			}
+<a name="432" href="#432">432</a> 		}
+<a name="433" href="#433">433</a> 	}
+<a name="434" href="#434">434</a> 	
+<a name="435" href="#435">435</a> 	
+<a name="436" href="#436">436</a> 	<em>/**<em>*</em></em>
+<a name="437" href="#437">437</a> <em>	 * Return a participant list. This method is synchronized on "this"</em>
+<a name="438" href="#438">438</a> <em>	 * and "this.participants" to ensure maximum consistency.</em>
+<a name="439" href="#439">439</a> <em>	 * </em>
+<a name="440" href="#440">440</a> <em>	 * @return An array of BAParticipantType objects.</em>
+<a name="441" href="#441">441</a> <em>	 */</em>
+<a name="442" href="#442">442</a> 	<strong>public</strong> BAParticipantType[] buildParticipantList() {
+<a name="443" href="#443">443</a> 		<strong>final</strong> BAParticipantType[] result ;
+<a name="444" href="#444">444</a> 		
+<a name="445" href="#445">445</a> 		<strong>synchronized</strong> (<strong>this</strong>){
+<a name="446" href="#446">446</a> 			<strong>synchronized</strong> (<strong>this</strong>.participants) {
+<a name="447" href="#447">447</a> 				result = <strong>new</strong> BAParticipantType[<strong>this</strong>.participants.size()];
+<a name="448" href="#448">448</a> 				
+<a name="449" href="#449">449</a> 				<strong>final</strong> Iterator it = <strong>this</strong>.participants.values().iterator();
+<a name="450" href="#450">450</a> 				<strong>int</strong> count   = 0;
+<a name="451" href="#451">451</a> 				
+<a name="452" href="#452">452</a> 				<em class="comment">// circle through the participants...</em>
+<a name="453" href="#453">453</a> 				<strong>while</strong>(it.hasNext()){
+<a name="454" href="#454">454</a> 					<strong>final</strong> <a href="../../../../../../org/apache/kandula/coordinator/ba/coordinator/AbstractCoordParticipant.html">AbstractCoordParticipant</a> participant = (AbstractCoordParticipant) it.next();
+<a name="455" href="#455">455</a> 					
+<a name="456" href="#456">456</a> 					<strong>final</strong> URI proto;
+<a name="457" href="#457">457</a> 					{
+<a name="458" href="#458">458</a> 						URI tmpProto = <strong>null</strong>;
+<a name="459" href="#459">459</a> 						<strong>try</strong>{
+<a name="460" href="#460">460</a> 							tmpProto = <strong>new</strong> org.apache.axis.types.URI(
+<a name="461" href="#461">461</a> 									participant.getProtocolIdentifier().getNamespaceURI()+
+<a name="462" href="#462">462</a> 									participant.getProtocolIdentifier().getLocalPart()
+<a name="463" href="#463">463</a> 							);
+<a name="464" href="#464">464</a> 						}
+<a name="465" href="#465">465</a> 						<strong>catch</strong>(MalformedURIException x){
+<a name="466" href="#466">466</a> 							<em class="comment">// forget it</em>
+<a name="467" href="#467">467</a> 						}
+<a name="468" href="#468">468</a> 						proto = tmpProto;
+<a name="469" href="#469">469</a> 					}
+<a name="470" href="#470">470</a> 					
+<a name="471" href="#471">471</a> 					<strong>final</strong> StateType resultState = StateType.fromValue(participant.getResultState());
+<a name="472" href="#472">472</a> 					
+<a name="473" href="#473">473</a> 					<em class="comment">// Fill all fields...</em>
+<a name="474" href="#474">474</a> 					result[count] = <strong>new</strong> BAParticipantType(
+<a name="475" href="#475">475</a> 							<strong>new</strong> BAParticipantReferenceType(participant.getMatchcode()),
+<a name="476" href="#476">476</a> 							<strong>new</strong> StatusType(StateType.fromValue(participant.getCurrentState()), <strong>null</strong>),
+<a name="477" href="#477">477</a> 							<strong>new</strong> StatusType(resultState, <strong>null</strong>),
+<a name="478" href="#478">478</a> 							proto
+<a name="479" href="#479">479</a> 					);
+<a name="480" href="#480">480</a> 					
+<a name="481" href="#481">481</a> 					count++;
+<a name="482" href="#482">482</a> 				}
+<a name="483" href="#483">483</a> 			} <em class="comment">// end synchronized this.participants</em>
+<a name="484" href="#484">484</a> 		} <em class="comment">// end synchronized this</em>
+<a name="485" href="#485">485</a> 		<strong>return</strong> result;
+<a name="486" href="#486">486</a> 	}
+<a name="487" href="#487">487</a> 	
+<a name="488" href="#488">488</a> 	<em>/**<em>*</em></em>
+<a name="489" href="#489">489</a> <em>	 * Fetches the participant associated to the given matchcode in the current context.</em>
+<a name="490" href="#490">490</a> <em>	 * Returns null if either the matchcode was not registered in the context, or </em>
+<a name="491" href="#491">491</a> <em>	 * the matchcode is valid but no participant has yet registered for it.</em>
+<a name="492" href="#492">492</a> <em>	 * @param matchCode</em>
+<a name="493" href="#493">493</a> <em>	 * @return The participant that registered for the requested matchcode, or null</em>
+<a name="494" href="#494">494</a> <em>	 * 	if the matchcode is either unused or no participant registered for it.</em>
+<a name="495" href="#495">495</a> <em>	 */</em>
+<a name="496" href="#496">496</a> 	<strong>public</strong> <a href="../../../../../../org/apache/kandula/coordinator/ba/coordinator/AbstractCoordParticipant.html">AbstractCoordParticipant</a> getParticipantByMatchcode(<strong>final</strong> String matchCode){
+<a name="497" href="#497">497</a> 		<strong>return</strong> (AbstractCoordParticipant) <strong>this</strong>.participantMatchcodes.get(matchCode);
+<a name="498" href="#498">498</a> 	}
+<a name="499" href="#499">499</a> 	
+<a name="500" href="#500">500</a> 	<em>/**<em>*</em></em>
+<a name="501" href="#501">501</a> <em>	 * Returns the collection of participants who are registered in the transaction. </em>
+<a name="502" href="#502">502</a> <em>	 * @return The participant collection.</em>
+<a name="503" href="#503">503</a> <em>	 */</em>
+<a name="504" href="#504">504</a> 	<strong>protected</strong> <strong>final</strong> Collection getParticipants(){
+<a name="505" href="#505">505</a> 		<strong>return</strong> <strong>this</strong>.participants.values();
+<a name="506" href="#506">506</a> 	}
+<a name="507" href="#507">507</a> 	
+<a name="508" href="#508">508</a> 	<em>/**<em>*</em></em>
+<a name="509" href="#509">509</a> <em>	 * Checks if the current request has all properties a request from the genuine</em>
+<a name="510" href="#510">510</a> <em>	 * initiator must have. At this time, we check that the @see </em>
+<a name="511" href="#511">511</a> <em>	 * @throws RemoteException</em>
+<a name="512" href="#512">512</a> <em>	 */</em>
+<a name="513" href="#513">513</a> 	<strong>public</strong> <strong>void</strong> ensureRequestOriginatesFromInitiatorOrThrowFault() throws RemoteException{
+<a name="514" href="#514">514</a> 		<strong>final</strong> String initiatorRef = CallbackRegistry.getRef(BACoordinator.INITIATOR_REF);
+<a name="515" href="#515">515</a> 		
+<a name="516" href="#516">516</a> 		<strong>if</strong> (initiatorRef != <strong>null</strong>
+<a name="517" href="#517">517</a> 				&amp;&amp; initiatorRef.equals(<strong>this</strong>.initiator.myID) 
+<a name="518" href="#518">518</a> 		){
+<a name="519" href="#519">519</a> 			<em class="comment">// OK</em>
+<a name="520" href="#520">520</a> 		}<strong>else</strong>{
+<a name="521" href="#521">521</a> 			<strong>throw</strong> Coordinator.CONTEXT_REFUSED_SOAP_FAULT();
+<a name="522" href="#522">522</a> 		}
+<a name="523" href="#523">523</a> 	}
+<a name="524" href="#524">524</a> 
+<a name="525" href="#525">525</a> }
+</pre>
+<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
+</html>
+

Added: webservices/kandula/site/1/xref/org/apache/kandula/coordinator/ba/coordinator/BACoordinatorService.html
URL: http://svn.apache.org/viewvc/webservices/kandula/site/1/xref/org/apache/kandula/coordinator/ba/coordinator/BACoordinatorService.html?rev=607143&view=auto
==============================================================================
--- webservices/kandula/site/1/xref/org/apache/kandula/coordinator/ba/coordinator/BACoordinatorService.html (added)
+++ webservices/kandula/site/1/xref/org/apache/kandula/coordinator/ba/coordinator/BACoordinatorService.html Thu Dec 27 16:03:17 2007
@@ -0,0 +1,258 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" /><title>BACoordinatorService xref</title>
+<link type="text/css" rel="stylesheet" href="../../../../../../stylesheet.css" />
+</head>
+<body>
+<div id="overview"><a href="../../../../../../../apidocs/org/apache/kandula/coordinator/ba/coordinator/BACoordinatorService.html">View Javadoc</a></div><pre>
+
+<a name="1" href="#1">1</a>   <em class="comment">/*</em>
+<a name="2" href="#2">2</a>   <em class="comment"> * Copyright 2007 The Apache Software Foundation.</em>
+<a name="3" href="#3">3</a>   <em class="comment"> * </em>
+<a name="4" href="#4">4</a>   <em class="comment"> * Licensed under the Apache License, Version 2.0 (the "License"); you may not</em>
+<a name="5" href="#5">5</a>   <em class="comment"> * use this file except in compliance with the License. You may obtain a copy of</em>
+<a name="6" href="#6">6</a>   <em class="comment"> * the License at</em>
+<a name="7" href="#7">7</a>   <em class="comment"> * </em>
+<a name="8" href="#8">8</a>   <em class="comment"> * <a href="http://www.apache.org/licenses/LICENSE-2.0" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></em>
+<a name="9" href="#9">9</a>   <em class="comment"> * </em>
+<a name="10" href="#10">10</a>  <em class="comment"> * Unless required by applicable law or agreed to in writing, software</em>
+<a name="11" href="#11">11</a>  <em class="comment"> * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT</em>
+<a name="12" href="#12">12</a>  <em class="comment"> * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the</em>
+<a name="13" href="#13">13</a>  <em class="comment"> * License for the specific language governing permissions and limitations under</em>
+<a name="14" href="#14">14</a>  <em class="comment"> * the License.</em>
+<a name="15" href="#15">15</a>  <em class="comment"> *</em>
+<a name="16" href="#16">16</a>  <em class="comment"> *  @author Hannes Erven, Georg Hicker</em>
+<a name="17" href="#17">17</a>  <em class="comment"> */</em>
+<a name="18" href="#18">18</a>  
+<a name="19" href="#19">19</a>  <strong>package</strong> <a href="../../../../../../org/apache/kandula/coordinator/ba/coordinator/package-summary.html">org.apache.kandula.coordinator.ba.coordinator</a>;
+<a name="20" href="#20">20</a>  
+<a name="21" href="#21">21</a>  <strong>import</strong> java.rmi.RemoteException;
+<a name="22" href="#22">22</a>  
+<a name="23" href="#23">23</a>  <strong>import</strong> javax.xml.namespace.QName;
+<a name="24" href="#24">24</a>  
+<a name="25" href="#25">25</a>  <strong>import</strong> org.apache.kandula.coordinator.Callback;
+<a name="26" href="#26">26</a>  <strong>import</strong> org.apache.kandula.coordinator.CallbackRegistry;
+<a name="27" href="#27">27</a>  <strong>import</strong> org.apache.kandula.coordinator.Coordinator;
+<a name="28" href="#28">28</a>  <strong>import</strong> org.apache.kandula.coordinator.ba.State;
+<a name="29" href="#29">29</a>  <strong>import</strong> org.apache.kandula.wsba.BusinessAgreementWithCoordinatorCompletionCoordinatorPortType;
+<a name="30" href="#30">30</a>  <strong>import</strong> org.apache.kandula.wsba.BusinessAgreementWithParticipantCompletionCoordinatorPortType;
+<a name="31" href="#31">31</a>  <strong>import</strong> org.apache.kandula.wsba.ExceptionType;
+<a name="32" href="#32">32</a>  <strong>import</strong> org.apache.kandula.wsba.NotificationType;
+<a name="33" href="#33">33</a>  <strong>import</strong> org.apache.kandula.wsba.StatusType;
+<a name="34" href="#34">34</a>  
+<a name="35" href="#35">35</a>  <em>/**<em>*</em></em>
+<a name="36" href="#36">36</a>  <em> * This is the class that represents the Business Activity protocol web service</em>
+<a name="37" href="#37">37</a>  <em> * to the client.</em>
+<a name="38" href="#38">38</a>  <em> * Internally, on an incoming message, it checks whether that message can be correlated</em>
+<a name="39" href="#39">39</a>  <em> * to an existing business activity, and forwards it to the BACoordinator object</em>
+<a name="40" href="#40">40</a>  <em> * managing that activity.</em>
+<a name="41" href="#41">41</a>  <em> * </em>
+<a name="42" href="#42">42</a>  <em> * </em>
+<a name="43" href="#43">43</a>  <em> * @author Hannes Erven, Georg Hicker (C) 2006</em>
+<a name="44" href="#44">44</a>  <em> * </em>
+<a name="45" href="#45">45</a>  <em> *</em>
+<a name="46" href="#46">46</a>  <em> */</em>
+<a name="47" href="#47">47</a>  <strong>public</strong> <strong>class</strong> <a href="../../../../../../org/apache/kandula/coordinator/ba/coordinator/BACoordinatorService.html">BACoordinatorService</a> implements
+<a name="48" href="#48">48</a>  		BusinessAgreementWithCoordinatorCompletionCoordinatorPortType,
+<a name="49" href="#49">49</a>  		BusinessAgreementWithParticipantCompletionCoordinatorPortType {
+<a name="50" href="#50">50</a>  
+<a name="51" href="#51">51</a>  	<em>/**<em>*</em></em>
+<a name="52" href="#52">52</a>  <em>	 * Retrieves the BACoordinator associated with the coordinator context attached to</em>
+<a name="53" href="#53">53</a>  <em>	 * the current message.</em>
+<a name="54" href="#54">54</a>  <em>	 * If no context could be associated, an exception is thrown. This method never returns null.</em>
+<a name="55" href="#55">55</a>  <em>	 * @return The BACoordinator.</em>
+<a name="56" href="#56">56</a>  <em>	 * @throws RemoteException</em>
+<a name="57" href="#57">57</a>  <em>	 */</em>
+<a name="58" href="#58">58</a>  	<strong>public</strong> <strong>static</strong> <a href="../../../../../../org/apache/kandula/coordinator/ba/coordinator/BACoordinator.html">BACoordinator</a> getBACoordinatorOrThrowFault() throws RemoteException{
+<a name="59" href="#59">59</a>  		<strong>final</strong> <a href="../../../../../../org/apache/kandula/coordinator/Callback.html">Callback</a> c = CallbackRegistry.getInstance().correlateMessage(
+<a name="60" href="#60">60</a>  				CallbackRegistry.CALLBACK_REF, false
+<a name="61" href="#61">61</a>  		);
+<a name="62" href="#62">62</a>  			
+<a name="63" href="#63">63</a>  		<strong>if</strong> (c == <strong>null</strong>)
+<a name="64" href="#64">64</a>  			<strong>throw</strong> Coordinator.CONTEXT_REFUSED_SOAP_FAULT();
+<a name="65" href="#65">65</a>  			
+<a name="66" href="#66">66</a>  		<strong>if</strong> (! (c instanceof BACoordinator) || c == <strong>null</strong>)
+<a name="67" href="#67">67</a>  			<strong>throw</strong> Coordinator.CONTEXT_REFUSED_SOAP_FAULT();
+<a name="68" href="#68">68</a>  		
+<a name="69" href="#69">69</a>  		<strong>return</strong> (BACoordinator) c;
+<a name="70" href="#70">70</a>  	}
+<a name="71" href="#71">71</a>  	
+<a name="72" href="#72">72</a>  	<em>/**<em>*</em></em>
+<a name="73" href="#73">73</a>  <em>	 * Retrieves the Participant who sent the current message.</em>
+<a name="74" href="#74">74</a>  <em>	 * @param context The current transaction's context.</em>
+<a name="75" href="#75">75</a>  <em>	 * @return The participant, if found</em>
+<a name="76" href="#76">76</a>  <em>	 * @throws RemoteException if no participant could be found</em>
+<a name="77" href="#77">77</a>  <em>	 */</em>
+<a name="78" href="#78">78</a>  	<strong>protected</strong> <strong>static</strong> <a href="../../../../../../org/apache/kandula/coordinator/ba/coordinator/AbstractCoordParticipant.html">AbstractCoordParticipant</a> getBAParticipantOrThrowFault(<strong>final</strong> <a href="../../../../../../org/apache/kandula/coordinator/ba/coordinator/BACoordinator.html">BACoordinator</a> context) throws RemoteException {
+<a name="79" href="#79">79</a>  		<strong>final</strong> <a href="../../../../../../org/apache/kandula/coordinator/ba/coordinator/AbstractCoordParticipant.html">AbstractCoordParticipant</a> p = (AbstractCoordParticipant) CallbackRegistry.getInstance().correlateMessage(
+<a name="80" href="#80">80</a>  				Coordinator.PARTICIPANT_REF, false
+<a name="81" href="#81">81</a>  		);
+<a name="82" href="#82">82</a>  
+<a name="83" href="#83">83</a>  		<em class="comment">// The message could not be correlated to a registered participant</em>
+<a name="84" href="#84">84</a>  		<strong>if</strong> (p == <strong>null</strong>){
+<a name="85" href="#85">85</a>  			<strong>throw</strong> Coordinator.CONTEXT_REFUSED_SOAP_FAULT() ;
+<a name="86" href="#86">86</a>  		}
+<a name="87" href="#87">87</a>  
+<a name="88" href="#88">88</a>  		<em class="comment">// The message contained a reference to a participant and a context,</em>
+<a name="89" href="#89">89</a>  		<em class="comment">// but the participant is not registered in the context</em>
+<a name="90" href="#90">90</a>  		<strong>if</strong> (! context.containsParticipant(p)){
+<a name="91" href="#91">91</a>  			<strong>throw</strong> Coordinator.CONTEXT_REFUSED_SOAP_FAULT();
+<a name="92" href="#92">92</a>  		}
+<a name="93" href="#93">93</a>  		
+<a name="94" href="#94">94</a>  		<strong>return</strong> p;
+<a name="95" href="#95">95</a>  	}
+<a name="96" href="#96">96</a>  
+<a name="97" href="#97">97</a>  	<em class="comment">/*</em>
+<a name="98" href="#98">98</a>  <em class="comment">	 * Below are the web service's methods </em>
+<a name="99" href="#99">99</a>  <em class="comment">	 */</em>
+<a name="100" href="#100">100</a> 	
+<a name="101" href="#101">101</a> 	<em>/**<em>*</em></em>
+<a name="102" href="#102">102</a> <em>	 * Completed.</em>
+<a name="103" href="#103">103</a> <em>	 * @param parameters Any parameters. </em>
+<a name="104" href="#104">104</a> <em>	 * @throws RemoteException Any fault thrown while processing the incoming message.</em>
+<a name="105" href="#105">105</a> <em>	 */</em>
+<a name="106" href="#106">106</a> 	<strong>public</strong> <strong>void</strong> completedOperation(<strong>final</strong> NotificationType parameters)
+<a name="107" href="#107">107</a> 			throws RemoteException {
+<a name="108" href="#108">108</a> 		handleIncomingMessage(State.MESSAGE_COMPLETED, parameters);
+<a name="109" href="#109">109</a> 	}
+<a name="110" href="#110">110</a> 
+<a name="111" href="#111">111</a> 	<em>/**<em>*</em></em>
+<a name="112" href="#112">112</a> <em>	 * Fault.</em>
+<a name="113" href="#113">113</a> <em>	 * @param parameters Any parameters. </em>
+<a name="114" href="#114">114</a> <em>	 * @throws RemoteException Any fault thrown while processing the incoming message.</em>
+<a name="115" href="#115">115</a> <em>	 */</em>
+<a name="116" href="#116">116</a> 	<strong>public</strong> <strong>void</strong> faultOperation(<strong>final</strong> ExceptionType parameters) throws RemoteException {
+<a name="117" href="#117">117</a> 		handleIncomingMessage(State.MESSAGE_FAULT, parameters);
+<a name="118" href="#118">118</a> 	}
+<a name="119" href="#119">119</a> 
+<a name="120" href="#120">120</a> 	<em>/**<em>*</em></em>
+<a name="121" href="#121">121</a> <em>	 * Compensated.</em>
+<a name="122" href="#122">122</a> <em>	 * @param parameters Any parameters. </em>
+<a name="123" href="#123">123</a> <em>	 * @throws RemoteException Any fault thrown while processing the incoming message.</em>
+<a name="124" href="#124">124</a> <em>	 */</em>
+<a name="125" href="#125">125</a> 	<strong>public</strong> <strong>void</strong> compensatedOperation(<strong>final</strong> NotificationType parameters)
+<a name="126" href="#126">126</a> 			throws RemoteException {
+<a name="127" href="#127">127</a> 		handleIncomingMessage(State.MESSAGE_COMPENSATED, parameters);
+<a name="128" href="#128">128</a> 	}
+<a name="129" href="#129">129</a> 
+<a name="130" href="#130">130</a> 	<em>/**<em>*</em></em>
+<a name="131" href="#131">131</a> <em>	 * Closed</em>
+<a name="132" href="#132">132</a> <em>	 * @param parameters Any parameters. </em>
+<a name="133" href="#133">133</a> <em>	 * @throws RemoteException Any fault thrown while processing the incoming message.</em>
+<a name="134" href="#134">134</a> <em>	 */</em>
+<a name="135" href="#135">135</a> 	<strong>public</strong> <strong>void</strong> closedOperation(<strong>final</strong> NotificationType parameters)
+<a name="136" href="#136">136</a> 			throws RemoteException {
+<a name="137" href="#137">137</a> 		handleIncomingMessage(State.MESSAGE_CLOSED, parameters);
+<a name="138" href="#138">138</a> 	}
+<a name="139" href="#139">139</a> 
+<a name="140" href="#140">140</a> 	<em>/**<em>*</em></em>
+<a name="141" href="#141">141</a> <em>	 * Canceled</em>
+<a name="142" href="#142">142</a> <em>	 * @param parameters Any parameters. </em>
+<a name="143" href="#143">143</a> <em>	 * @throws RemoteException Any fault thrown while processing the incoming message.</em>
+<a name="144" href="#144">144</a> <em>	 */</em>
+<a name="145" href="#145">145</a> 	<strong>public</strong> <strong>void</strong> canceledOperation(<strong>final</strong> NotificationType parameters)
+<a name="146" href="#146">146</a> 			throws RemoteException {
+<a name="147" href="#147">147</a> 		handleIncomingMessage(State.MESSAGE_CANCELED, parameters);
+<a name="148" href="#148">148</a> 	}
+<a name="149" href="#149">149</a> 
+<a name="150" href="#150">150</a> 	<em>/**<em>*</em></em>
+<a name="151" href="#151">151</a> <em>	 * Exit</em>
+<a name="152" href="#152">152</a> <em>	 * @param parameters Any parameters. </em>
+<a name="153" href="#153">153</a> <em>	 * @throws RemoteException Any fault thrown while processing the incoming message.</em>
+<a name="154" href="#154">154</a> <em>	 */</em>
+<a name="155" href="#155">155</a> 	<strong>public</strong> <strong>void</strong> exitOperation(<strong>final</strong> NotificationType parameters)
+<a name="156" href="#156">156</a> 			throws RemoteException {
+<a name="157" href="#157">157</a> 		handleIncomingMessage(State.MESSAGE_EXIT, parameters);
+<a name="158" href="#158">158</a> 	}
+<a name="159" href="#159">159</a> 
+<a name="160" href="#160">160</a> 	<em>/**<em>*</em></em>
+<a name="161" href="#161">161</a> <em>	 * GetStatus</em>
+<a name="162" href="#162">162</a> <em>	 * @param parameters Any parameters. </em>
+<a name="163" href="#163">163</a> <em>	 * @throws RemoteException Any fault thrown while processing the incoming message.</em>
+<a name="164" href="#164">164</a> <em>	 */</em>
+<a name="165" href="#165">165</a> 	<strong>public</strong> <strong>void</strong> getStatusOperation(<strong>final</strong> NotificationType parameters)
+<a name="166" href="#166">166</a> 			throws RemoteException {
+<a name="167" href="#167">167</a> 		handleIncomingMessage(State.MESSAGE_GETSTATUS, parameters);
+<a name="168" href="#168">168</a> 	}
+<a name="169" href="#169">169</a> 
+<a name="170" href="#170">170</a> 	<em>/**<em>*</em></em>
+<a name="171" href="#171">171</a> <em>	 * Status</em>
+<a name="172" href="#172">172</a> <em>	 * @param parameters Any parameters. </em>
+<a name="173" href="#173">173</a> <em>	 * @throws RemoteException Any fault thrown while processing the incoming message.</em>
+<a name="174" href="#174">174</a> <em>	 */</em>
+<a name="175" href="#175">175</a> 	<strong>public</strong> <strong>void</strong> statusOperation(<strong>final</strong> StatusType parameters) throws RemoteException {
+<a name="176" href="#176">176</a> 		handleIncomingMessage(State.MESSAGE_STATUS, parameters);
+<a name="177" href="#177">177</a> 	}
+<a name="178" href="#178">178</a> 
+<a name="179" href="#179">179</a> 	<em class="comment">/*</em>
+<a name="180" href="#180">180</a> <em class="comment">	 * End Web Service Methods</em>
+<a name="181" href="#181">181</a> <em class="comment">	 */</em>
+<a name="182" href="#182">182</a> 	
+<a name="183" href="#183">183</a> 	
+<a name="184" href="#184">184</a> 	<em>/**<em>*</em></em>
+<a name="185" href="#185">185</a> <em>	 * Handle an incoming messages. That is, fetch the coordination context associated </em>
+<a name="186" href="#186">186</a> <em>	 * with the given coordination context references; fetch the participant associated</em>
+<a name="187" href="#187">187</a> <em>	 * with the given participant references;</em>
+<a name="188" href="#188">188</a> <em>	 * and pass further message processing to the coordinator-side participant object.</em>
+<a name="189" href="#189">189</a> <em>	 * @param messageType The message's type. @see CoordinationStates</em>
+<a name="190" href="#190">190</a> <em>	 * @param params The message's parameters.</em>
+<a name="191" href="#191">191</a> <em>	 * @throws RemoteException If context or participant could not be created, or message processing</em>
+<a name="192" href="#192">192</a> <em>	 *   by the participant was not successfull, we throw an error back to the calling party.</em>
+<a name="193" href="#193">193</a> <em>	 */</em>
+<a name="194" href="#194">194</a> 	<strong>protected</strong> <strong>void</strong> handleIncomingMessage(<strong>final</strong> QName messageType, <strong>final</strong> NotificationType params) throws RemoteException{
+<a name="195" href="#195">195</a> 
+<a name="196" href="#196">196</a> 		<strong>final</strong> <a href="../../../../../../org/apache/kandula/coordinator/ba/coordinator/BACoordinator.html">BACoordinator</a> coord = getBACoordinatorOrThrowFault();
+<a name="197" href="#197">197</a> 		<strong>final</strong> <a href="../../../../../../org/apache/kandula/coordinator/ba/coordinator/AbstractCoordParticipant.html">AbstractCoordParticipant</a> part = getBAParticipantOrThrowFault(coord);
+<a name="198" href="#198">198</a> 
+<a name="199" href="#199">199</a> 		System.out.println(<span class="string">"+++ CoordIncoming: "</span>+messageType+<span class="string">" ("</span>+params+<span class="string">"+ in TX "</span>+coord+<span class="string">" from participant "</span>+part);
+<a name="200" href="#200">200</a> 	
+<a name="201" href="#201">201</a> 		<strong>if</strong> (messageType.equals(State.MESSAGE_GETSTATUS)){
+<a name="202" href="#202">202</a> 			<em class="comment">// Reply with the status</em>
+<a name="203" href="#203">203</a> 			
+<a name="204" href="#204">204</a> 			part.tellStatus();
+<a name="205" href="#205">205</a> 		}<strong>else</strong>{
+<a name="206" href="#206">206</a> 			part.handleIncomingMessage(messageType, params);
+<a name="207" href="#207">207</a> 		}
+<a name="208" href="#208">208</a> 	}
+<a name="209" href="#209">209</a> 	<em>/**<em>*</em></em>
+<a name="210" href="#210">210</a> <em>	 * Handle an incoming messages. That is, fetch the coordination context associated </em>
+<a name="211" href="#211">211</a> <em>	 * with the given coordination context references; fetch the participant associated</em>
+<a name="212" href="#212">212</a> <em>	 * with the given participant references;</em>
+<a name="213" href="#213">213</a> <em>	 * and pass further message processing to the coordinator-side participant object.</em>
+<a name="214" href="#214">214</a> <em>	 * @param messageType The message's type. @see CoordinationStates</em>
+<a name="215" href="#215">215</a> <em>	 * @param params The message's parameters.</em>
+<a name="216" href="#216">216</a> <em>	 * @throws RemoteException If context or participant could not be created, or message processing</em>
+<a name="217" href="#217">217</a> <em>	 *   by the participant was not successfull, we throw an error back to the calling party.</em>
+<a name="218" href="#218">218</a> <em>	 */</em>
+<a name="219" href="#219">219</a> 	<strong>protected</strong> <strong>void</strong> handleIncomingMessage(<strong>final</strong> QName messageType, <strong>final</strong> ExceptionType params) throws RemoteException{
+<a name="220" href="#220">220</a> 
+<a name="221" href="#221">221</a> 		<strong>final</strong> <a href="../../../../../../org/apache/kandula/coordinator/ba/coordinator/BACoordinator.html">BACoordinator</a> coord = getBACoordinatorOrThrowFault();
+<a name="222" href="#222">222</a> 		<strong>final</strong> <a href="../../../../../../org/apache/kandula/coordinator/ba/coordinator/AbstractCoordParticipant.html">AbstractCoordParticipant</a> part = getBAParticipantOrThrowFault(coord);
+<a name="223" href="#223">223</a> 
+<a name="224" href="#224">224</a> 		System.out.println(<span class="string">"+++ CoordIncoming: "</span>+messageType+<span class="string">" ("</span>+params+<span class="string">"+ in TX "</span>+coord+<span class="string">" from participant "</span>+part);
+<a name="225" href="#225">225</a> 		part.handleIncomingMessage(messageType, params);		
+<a name="226" href="#226">226</a> 	}
+<a name="227" href="#227">227</a> 	<em>/**<em>*</em></em>
+<a name="228" href="#228">228</a> <em>	 * Handle an incoming messages. That is, fetch the coordination context associated </em>
+<a name="229" href="#229">229</a> <em>	 * with the given coordination context references; fetch the participant associated</em>
+<a name="230" href="#230">230</a> <em>	 * with the given participant references;</em>
+<a name="231" href="#231">231</a> <em>	 * and pass further message processing to the coordinator-side participant object.</em>
+<a name="232" href="#232">232</a> <em>	 * @param messageType The message's type. @see CoordinationStates</em>
+<a name="233" href="#233">233</a> <em>	 * @param params The message's parameters.</em>
+<a name="234" href="#234">234</a> <em>	 * @throws RemoteException If context or participant could not be created, or message processing</em>
+<a name="235" href="#235">235</a> <em>	 *   by the participant was not successfull, we throw an error back to the calling party.</em>
+<a name="236" href="#236">236</a> <em>	 */</em>
+<a name="237" href="#237">237</a> 	<strong>protected</strong> <strong>void</strong> handleIncomingMessage(<strong>final</strong> QName messageType, <strong>final</strong> StatusType params) throws RemoteException{
+<a name="238" href="#238">238</a> 
+<a name="239" href="#239">239</a> 		<strong>final</strong> <a href="../../../../../../org/apache/kandula/coordinator/ba/coordinator/BACoordinator.html">BACoordinator</a> coord = getBACoordinatorOrThrowFault();
+<a name="240" href="#240">240</a> 		<strong>final</strong> <a href="../../../../../../org/apache/kandula/coordinator/ba/coordinator/AbstractCoordParticipant.html">AbstractCoordParticipant</a> part = getBAParticipantOrThrowFault(coord);
+<a name="241" href="#241">241</a> 
+<a name="242" href="#242">242</a> 		System.out.println(<span class="string">"+++ CoordIncoming: "</span>+messageType+<span class="string">" ("</span>+params+<span class="string">"+ in TX "</span>+coord+<span class="string">" from participant "</span>+part);
+<a name="243" href="#243">243</a> 		part.handleIncomingMessage(messageType, params);
+<a name="244" href="#244">244</a> 	}
+<a name="245" href="#245">245</a> }
+</pre>
+<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
+</html>
+

Added: webservices/kandula/site/1/xref/org/apache/kandula/coordinator/ba/coordinator/BAwCCCoordParticipant.html
URL: http://svn.apache.org/viewvc/webservices/kandula/site/1/xref/org/apache/kandula/coordinator/ba/coordinator/BAwCCCoordParticipant.html?rev=607143&view=auto
==============================================================================
--- webservices/kandula/site/1/xref/org/apache/kandula/coordinator/ba/coordinator/BAwCCCoordParticipant.html (added)
+++ webservices/kandula/site/1/xref/org/apache/kandula/coordinator/ba/coordinator/BAwCCCoordParticipant.html Thu Dec 27 16:03:17 2007
@@ -0,0 +1,124 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" /><title>BAwCCCoordParticipant xref</title>
+<link type="text/css" rel="stylesheet" href="../../../../../../stylesheet.css" />
+</head>
+<body>
+<div id="overview"><a href="../../../../../../../apidocs/org/apache/kandula/coordinator/ba/coordinator/BAwCCCoordParticipant.html">View Javadoc</a></div><pre>
+
+<a name="1" href="#1">1</a>   <em class="comment">/*</em>
+<a name="2" href="#2">2</a>   <em class="comment"> * Copyright 2007 The Apache Software Foundation.</em>
+<a name="3" href="#3">3</a>   <em class="comment"> * </em>
+<a name="4" href="#4">4</a>   <em class="comment"> * Licensed under the Apache License, Version 2.0 (the "License"); you may not</em>
+<a name="5" href="#5">5</a>   <em class="comment"> * use this file except in compliance with the License. You may obtain a copy of</em>
+<a name="6" href="#6">6</a>   <em class="comment"> * the License at</em>
+<a name="7" href="#7">7</a>   <em class="comment"> * </em>
+<a name="8" href="#8">8</a>   <em class="comment"> * <a href="http://www.apache.org/licenses/LICENSE-2.0" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></em>
+<a name="9" href="#9">9</a>   <em class="comment"> * </em>
+<a name="10" href="#10">10</a>  <em class="comment"> * Unless required by applicable law or agreed to in writing, software</em>
+<a name="11" href="#11">11</a>  <em class="comment"> * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT</em>
+<a name="12" href="#12">12</a>  <em class="comment"> * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the</em>
+<a name="13" href="#13">13</a>  <em class="comment"> * License for the specific language governing permissions and limitations under</em>
+<a name="14" href="#14">14</a>  <em class="comment"> * the License.</em>
+<a name="15" href="#15">15</a>  <em class="comment"> *</em>
+<a name="16" href="#16">16</a>  <em class="comment"> *  @author Hannes Erven, Georg Hicker</em>
+<a name="17" href="#17">17</a>  <em class="comment"> */</em>
+<a name="18" href="#18">18</a>  
+<a name="19" href="#19">19</a>  <strong>package</strong> <a href="../../../../../../org/apache/kandula/coordinator/ba/coordinator/package-summary.html">org.apache.kandula.coordinator.ba.coordinator</a>;
+<a name="20" href="#20">20</a>  
+<a name="21" href="#21">21</a>  <strong>import</strong> java.net.MalformedURLException;
+<a name="22" href="#22">22</a>  <strong>import</strong> java.rmi.RemoteException;
+<a name="23" href="#23">23</a>  
+<a name="24" href="#24">24</a>  <strong>import</strong> javax.xml.namespace.QName;
+<a name="25" href="#25">25</a>  
+<a name="26" href="#26">26</a>  <strong>import</strong> org.apache.axis.AxisFault;
+<a name="27" href="#27">27</a>  <strong>import</strong> org.apache.axis.message.addressing.EndpointReference;
+<a name="28" href="#28">28</a>  <strong>import</strong> org.apache.kandula.coordinator.ba.ProtocolType;
+<a name="29" href="#29">29</a>  <strong>import</strong> org.apache.kandula.coordinator.ba.State;
+<a name="30" href="#30">30</a>  
+<a name="31" href="#31">31</a>  
+<a name="32" href="#32">32</a>  <em>/**<em>*</em></em>
+<a name="33" href="#33">33</a>  <em> * A server-side WS-BA transaction particpant, registered for the</em>
+<a name="34" href="#34">34</a>  <em> * CoordinatorCompletion Protocol.</em>
+<a name="35" href="#35">35</a>  <em> * </em>
+<a name="36" href="#36">36</a>  <em> * @author Hannes Erven, Georg Hicker (C) 2006</em>
+<a name="37" href="#37">37</a>  <em> *</em>
+<a name="38" href="#38">38</a>  <em> */</em>
+<a name="39" href="#39">39</a>  <strong>public</strong> <strong>class</strong> <a href="../../../../../../org/apache/kandula/coordinator/ba/coordinator/BAwCCCoordParticipant.html">BAwCCCoordParticipant</a> <strong>extends</strong> <a href="../../../../../../org/apache/kandula/coordinator/ba/coordinator/AbstractCoordParticipant.html">AbstractCoordParticipant</a> {
+<a name="40" href="#40">40</a>  
+<a name="41" href="#41">41</a>  	<strong>private</strong> <strong>final</strong> <a href="../../../../../../org/apache/kandula/coordinator/ba/coordinator/BAwCCParticipantProxy.html">BAwCCParticipantProxy</a> myPCProxy;
+<a name="42" href="#42">42</a>  	
+<a name="43" href="#43">43</a>  	<em>/**<em>*</em></em>
+<a name="44" href="#44">44</a>  <em>	 * The default constructor for the new participant.</em>
+<a name="45" href="#45">45</a>  <em>	 * </em>
+<a name="46" href="#46">46</a>  <em>	 * @param participantID The participant's ID.</em>
+<a name="47" href="#47">47</a>  <em>	 * @param participantEPR The participant's protocol service endpoint reference.</em>
+<a name="48" href="#48">48</a>  <em>	 * @param coordinationContext The coordination context the participant is registered in.</em>
+<a name="49" href="#49">49</a>  <em>	 * @param matchcode The matchcode the participant was given by the initiator.</em>
+<a name="50" href="#50">50</a>  <em>	 * @throws AxisFault Any fault while initializing the participant object.</em>
+<a name="51" href="#51">51</a>  <em>	 */</em>
+<a name="52" href="#52">52</a>  	<strong>public</strong> <a href="../../../../../../org/apache/kandula/coordinator/ba/coordinator/BAwCCCoordParticipant.html">BAwCCCoordParticipant</a>(
+<a name="53" href="#53">53</a>  			<strong>final</strong> String participantID, 
+<a name="54" href="#54">54</a>  			<strong>final</strong> EndpointReference participantEPR,
+<a name="55" href="#55">55</a>  			<strong>final</strong> <a href="../../../../../../org/apache/kandula/coordinator/ba/coordinator/BACoordinator.html">BACoordinator</a> coordinationContext, 
+<a name="56" href="#56">56</a>  			<strong>final</strong> String matchcode
+<a name="57" href="#57">57</a>  			
+<a name="58" href="#58">58</a>  	) throws AxisFault {
+<a name="59" href="#59">59</a>  		<strong>super</strong>(participantID, participantEPR, coordinationContext, matchcode);
+<a name="60" href="#60">60</a>  		
+<a name="61" href="#61">61</a>  		<strong>try</strong> {
+<a name="62" href="#62">62</a>  			<strong>this</strong>.myPCProxy = <strong>new</strong> <a href="../../../../../../org/apache/kandula/coordinator/ba/coordinator/BAwCCParticipantProxy.html">BAwCCParticipantProxy</a>(participantID, participantEPR);
+<a name="63" href="#63">63</a>  		} <strong>catch</strong> (MalformedURLException e) {
+<a name="64" href="#64">64</a>  			<strong>throw</strong> <strong>new</strong> AxisFault(<span class="string">"ERROR!!! "</span>+e);
+<a name="65" href="#65">65</a>  		}
+<a name="66" href="#66">66</a>  	}
+<a name="67" href="#67">67</a>  
+<a name="68" href="#68">68</a>  	<em>/**<em>*</em></em>
+<a name="69" href="#69">69</a>  <em>	 * As this is a CC participant, always returns CC.</em>
+<a name="70" href="#70">70</a>  <em>	 * @return This particpant's protocol identifier.</em>
+<a name="71" href="#71">71</a>  <em>	 * @see ProtocolType#PROTOCOL_ID_CC</em>
+<a name="72" href="#72">72</a>  <em>	 */</em>
+<a name="73" href="#73">73</a>  	<strong>public</strong> QName getProtocolIdentifier() {
+<a name="74" href="#74">74</a>  		<strong>return</strong> ProtocolType.PROTOCOL_ID_CC;
+<a name="75" href="#75">75</a>  	}
+<a name="76" href="#76">76</a>  
+<a name="77" href="#77">77</a>  	<em class="comment">/*</em>
+<a name="78" href="#78">78</a>  <em class="comment">	 * Methods for the PC participant</em>
+<a name="79" href="#79">79</a>  <em class="comment">	 */</em>
+<a name="80" href="#80">80</a>  	
+<a name="81" href="#81">81</a>  	<em>/**<em>*</em></em>
+<a name="82" href="#82">82</a>  <em>	 * Tell the participant to complete</em>
+<a name="83" href="#83">83</a>  <em>	 * @throws java.rmi.RemoteException A fault from the participant.</em>
+<a name="84" href="#84">84</a>  <em>	 */</em>
+<a name="85" href="#85">85</a>  	<strong>public</strong> <strong>void</strong> tellComplete() throws RemoteException {
+<a name="86" href="#86">86</a>  		<strong>this</strong>.tell(State.MESSAGE_COMPLETE);
+<a name="87" href="#87">87</a>  	}
+<a name="88" href="#88">88</a>  	
+<a name="89" href="#89">89</a>  	<em>/**<em>*</em></em>
+<a name="90" href="#90">90</a>  <em>	 * Return the participant proxy</em>
+<a name="91" href="#91">91</a>  <em>	 * @return The participant proxy.</em>
+<a name="92" href="#92">92</a>  <em>	 */</em>
+<a name="93" href="#93">93</a>  	<strong>public</strong> <a href="../../../../../../org/apache/kandula/coordinator/ba/coordinator/AbstractCoordParticipantProxy.html">AbstractCoordParticipantProxy</a> getParticipantProxy() {
+<a name="94" href="#94">94</a>  		<strong>return</strong> <strong>this</strong>.myPCProxy;
+<a name="95" href="#95">95</a>  	}
+<a name="96" href="#96">96</a>  	
+<a name="97" href="#97">97</a>  	<em>/**<em>*</em></em>
+<a name="98" href="#98">98</a>  <em>	 * Overrides @see AbstractCoordParticipant#tellAgain(QName) , as the BAwCC participant</em>
+<a name="99" href="#99">99</a>  <em>	 * needs an additional message: @see State#MESSAGE_COMPLETED</em>
+<a name="100" href="#100">100</a> <em>	 * @param message The message type to send.</em>
+<a name="101" href="#101">101</a> <em>	 * @throws java.rmi.RemoteException A fault from the participant.</em>
+<a name="102" href="#102">102</a> <em>	 */</em>
+<a name="103" href="#103">103</a> 	<strong>protected</strong> <strong>void</strong> tellAgain(<strong>final</strong> QName message) throws RemoteException {
+<a name="104" href="#104">104</a> 		<strong>if</strong> (State.MESSAGE_COMPLETE.equals(message)){
+<a name="105" href="#105">105</a> 			<strong>this</strong>.myPCProxy.completeOperation(<strong>null</strong>);
+<a name="106" href="#106">106</a> 		}<strong>else</strong>{
+<a name="107" href="#107">107</a> 			<strong>super</strong>.tellAgain(message);
+<a name="108" href="#108">108</a> 		}
+<a name="109" href="#109">109</a> 	}
+<a name="110" href="#110">110</a> 
+<a name="111" href="#111">111</a> }
+</pre>
+<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
+</html>
+



---------------------------------------------------------------------
To unsubscribe, e-mail: kandula-dev-unsubscribe@ws.apache.org
For additional commands, e-mail: kandula-dev-help@ws.apache.org


Mime
View raw message