juddi-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From alexo...@apache.org
Subject svn commit: r1479003 [4/5] - in /juddi/branches/juddi-3.2.x: juddi-client/src/main/java/org/apache/juddi/v3/client/ uddi-ws/src/main/java/org/uddi/v3_service/
Date Fri, 03 May 2013 23:23:28 GMT
Modified: juddi/branches/juddi-3.2.x/uddi-ws/src/main/java/org/uddi/v3_service/UDDIReplicationPortType.java
URL: http://svn.apache.org/viewvc/juddi/branches/juddi-3.2.x/uddi-ws/src/main/java/org/uddi/v3_service/UDDIReplicationPortType.java?rev=1479003&r1=1479002&r2=1479003&view=diff
==============================================================================
--- juddi/branches/juddi-3.2.x/uddi-ws/src/main/java/org/uddi/v3_service/UDDIReplicationPortType.java
(original)
+++ juddi/branches/juddi-3.2.x/uddi-ws/src/main/java/org/uddi/v3_service/UDDIReplicationPortType.java
Fri May  3 23:23:27 2013
@@ -14,8 +14,6 @@
  * limitations under the License.
  *
  */
-
-
 package org.uddi.v3_service;
 
 import java.math.BigInteger;
@@ -37,14 +35,36 @@ import org.uddi.repl_v3.HighWaterMarkVec
 import org.uddi.repl_v3.NotifyChangeRecordsAvailable;
 import org.uddi.repl_v3.TransferCustody;
 
-
 /**
  * This portType defines all of the UDDI replication operations.
- * 
- * This class was generated by the JAX-WS RI.
- * JAX-WS RI 2.1.5-b03-
- * Generated source version: 2.1
- * 
+ *
+ * This class was generated by the JAX-WS RI. JAX-WS RI 2.1.5-b03- Generated
+ * source version: 2.1
+ *
+ * <p class="MsoBodyText">UDDI Replication defines four APIs. The first two
+ * presented here are used to perform replication and issue notifications. The
+ * latter ancillary APIs provide support for other aspects of UDDI
+ * Replication.</p>
+ *
+ * <p class="MsoBodyText" style="margin-left:1.0in;text-indent:-.25in"><span
+ * style="font-family:Symbol">·<span style="font:7.0pt &quot;Times New
+ * Roman&quot;">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
+ * </span></span>get_changeRecords</p>
+ *
+ * <p class="MsoBodyText" style="margin-left:1.0in;text-indent:-.25in"><span
+ * style="font-family:Symbol">·<span style="font:7.0pt &quot;Times New
+ * Roman&quot;">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
+ * </span></span>notify_changeRecordsAvailable</p>
+ *
+ * <p class="MsoBodyText" style="margin-left:1.0in;text-indent:-.25in"><span
+ * style="font-family:Symbol">·<span style="font:7.0pt &quot;Times New
+ * Roman&quot;">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
+ * </span></span>do_ping</p>
+ *
+ * <p class="MsoBodyText" style="margin-left:1.0in;text-indent:-.25in"><span
+ * style="font-family:Symbol">·<span style="font:7.0pt &quot;Times New
+ * Roman&quot;">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
+ * </span></span>get_highWaterMarks</p>
  */
 @WebService(name = "UDDI_Replication_PortType", targetNamespace = "urn:uddi-org:v3_service")
 @XmlSeeAlso({
@@ -59,90 +79,322 @@ import org.uddi.repl_v3.TransferCustody;
     org.uddi.policy_v3.ObjectFactory.class,
     org.uddi.policy_v3_instanceparms.ObjectFactory.class
 })
-public interface UDDIReplicationPortType extends Remote{
-
+public interface UDDIReplicationPortType extends Remote {
 
     /**
-     * 
-     * @param responseLimitVector
-     * @param requestingNode
-     * @param changesAlreadySeen
-     * @param responseLimitCount
-     * @return
-     *     returns java.util.List<org.uddi.repl_v3.ChangeRecord>
-     * @throws DispositionReportFaultMessage, RemoteException
+     * The get_changeRecords message is used to initiate the replication of
+     * change records from one node to another. The caller, who wishes to
+     * receive new change records, provides as part of the message a high water
+     * mark vector. This is used by the replication source node to determine
+     * what change records satisfy the caller’s request. <p
+     * class="MsoBodyText">More specifically, the recipient determines the
+     * particular change records that are returned by comparing the originating
+     * USNs in the caller’s high water mark vector with the originating USNs of
+     * each of the changes the recipient has seen from others or generated by
+     * itself.&nbsp; The recipient SHOULD only return change records that have
+     * originating USNs that are greater than those listed in the
+     * changesAlreadySeen highWaterMarkVector and less than the limit required
+     * by either the responseLimitCount or the responseLimitVector.</p>
+     *
+     * <p class="MsoBodyText">In nodes that support pre-bundled replication
+     * responses, the recipient of the get_changeRecords message MAY return more
+     * change records than requested by the caller.&nbsp; In this scenario, the
+     * caller MUST also be prepared to deal with such redundant changes where a
+     * USN is less than the USN specified in the changesAlreadySeen
+     * highWaterMarkVector. </p>
+     *
+     * <p class="MsoBodyText">The response to a get_changeRecords message is a
+     * changeRecords element. Under all circumstances, all change records
+     * returned therein by the message recipient MUST be returned sorted in
+     * increasing order according to the recipient’s local USN.</p>
+     *
+     * @param responseLimitVector responseLimitCount or responseLimitVector: A
+     * caller MAY place an upper bound on the number of change records he wishes
+     * to receive in response to this message by either providing a integer
+     * responseLimitCount, or, using responseLimitVector, indicating for each
+     * node in the graph the first change originating there that he does not
+     * wish to be returned.
+     * @param requestingNode requestingNode: The requestingNode element provides
+     * the identity of the calling node. This is the unique key for the calling
+     * node and SHOULD be specified within the Replication Configuration
+     * Structure.
+     * @param changesAlreadySeen changesAlreadySeen: The changesAlreadySeen
+     * element, if present, indicates changes from each node that the requestor
+     * has successfully processed, and thus which should not be resent, if
+     * possible.
+     * @param responseLimitCount responseLimitCount or responseLimitVector: A
+     * caller MAY place an upper bound on the number of change records he wishes
+     * to receive in response to this message by either providing a integer
+     * responseLimitCount, or, using responseLimitVector, indicating for each
+     * node in the graph the first change originating there that he does not
+     * wish to be returned.
+     * @return returns java.util.List<org.uddi.repl_v3.ChangeRecord> A node will
+     * respond with the corresponding changeRecords.
+     * @throws DispositionReportFaultMessage, RemoteException Processing an
+     * inbound replication message may fail due to a server internal error. The
+     * common behavior for all error cases is to return an E_fatalError error
+     * code. Error reporting SHALL be that specified by Section 4.8 – Success
+     * and Error Reporting of this specification.
      */
     @WebMethod(operationName = "get_changeRecords", action = "get_changeRecords")
     @WebResult(name = "changeRecord", targetNamespace = "urn:uddi-org:repl_v3")
     @RequestWrapper(localName = "get_changeRecords", targetNamespace = "urn:uddi-org:repl_v3",
className = "org.uddi.repl_v3.GetChangeRecords")
     @ResponseWrapper(localName = "changeRecords", targetNamespace = "urn:uddi-org:repl_v3",
className = "org.uddi.repl_v3.ChangeRecords")
     public List<ChangeRecord> getChangeRecords(
-        @WebParam(name = "requestingNode", targetNamespace = "urn:uddi-org:repl_v3")
-        String requestingNode,
-        @WebParam(name = "changesAlreadySeen", targetNamespace = "urn:uddi-org:repl_v3")
-        HighWaterMarkVectorType changesAlreadySeen,
-        @WebParam(name = "responseLimitCount", targetNamespace = "urn:uddi-org:repl_v3")
-        BigInteger responseLimitCount,
-        @WebParam(name = "responseLimitVector", targetNamespace = "urn:uddi-org:repl_v3")
-        HighWaterMarkVectorType responseLimitVector)
-        throws DispositionReportFaultMessage, RemoteException
-    ;
+            @WebParam(name = "requestingNode", targetNamespace = "urn:uddi-org:repl_v3")
String requestingNode,
+            @WebParam(name = "changesAlreadySeen", targetNamespace = "urn:uddi-org:repl_v3")
HighWaterMarkVectorType changesAlreadySeen,
+            @WebParam(name = "responseLimitCount", targetNamespace = "urn:uddi-org:repl_v3")
BigInteger responseLimitCount,
+            @WebParam(name = "responseLimitVector", targetNamespace = "urn:uddi-org:repl_v3")
HighWaterMarkVectorType responseLimitVector)
+            throws DispositionReportFaultMessage, RemoteException;
 
     /**
-     * 
-     * @param body
-     * @throws DispositionReportFaultMessage, RemoteException
+     * <p class="MsoBodyText">Nodes can inform other nodes that they have new
+     * change records available for consumption by replication by using this
+     * message. This provides a proactive means through which replication can be
+     * initiated, potentially reducing the latency of the dissemination of
+     * changes throughout the set of UDDI nodes.&nbsp; The
+     * notify_changeRecordsAvailable message is the predecessor to the
+     * get_changeRecords message.</p>
+     *
+     * <p class="MsoBodyText">Each node MUST respond with the message defined
+     * within the Section <a href="#_Ref8980611 ">7.4.2.3</a> <i>Returns</i>
+     * when a valid notify_changeRecordsAvailable message is received.&nbsp;
+     * </p>
+     *
+     * <p class="MsoBodyText">At an interval set by policy after the origination
+     * of new change records within its node, a node SHOULD send this message to
+     * each of the other nodes with which it is configured to communicate this
+     * message according to the currently configured communication graph. It
+     * SHOULD ignore any response (errors or otherwise) returned by such
+     * invocations.</p>
+     *
+     * @param body <p class="MsoBodyText"
+     * style="margin-left:1.0in;text-indent:-.25in"><span
+     * style="font-family:Symbol">·<span style="font:7.0pt &quot;Times New
+     * Roman&quot;">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
+     * </span></span><b><i>notifyingNode</i></b>: The
parameter to this message
+     * indicates that the notifyingNode has available the indicated set of
+     * changes for request via get_changeRecords. </p>
+     *
+     * <p class="MsoBodyText" style="margin-left:1.0in;text-indent:-.25in"><span
+     * style="font-family:Symbol">·<span style="font:7.0pt &quot;Times New
+     * Roman&quot;">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
+     * </span></span><b><i>changesAvailable</i></b>:
When sending the
+     * notify_changeRecordsAvailable message, a node shall provide a high water
+     * mark vector identifying what changes it knows to exist both locally and
+     * on other nodes with which it might have had communications. Typically, no
+     * communication graph restrictions are present for the
+     * notify_changeRecordsAvailable message.&nbsp; In the event that the
+     * sending node does not know the USN for a specific node within the
+     * CommunicationGraph, the changesAvailable element MAY contain a
+     * highWaterMark for that node with an unspecified nodeID element. </p>
+     *
+     * <span
+     * style="font-size:10.0pt;font-family:Arial;letter-spacing:-.25pt"></span>
+     * @return Success reporting SHALL be that specified by Section 4.8 –
+     * Success and Error Reporting of this specification.
+     * @throws DispositionReportFaultMessage, RemoteException Processing an
+     * inbound replication message may fail due to a server internal error. The
+     * common behavior for all error cases is to return an E_fatalError error
+     * code. Error reporting SHALL be that specified by Section 4.8 – Success
+     * and Error Reporting of this specification.
      */
     @WebMethod(operationName = "notify_changeRecordsAvailable", action = "notify_changeRecordsAvailable")
     @SOAPBinding(parameterStyle = SOAPBinding.ParameterStyle.BARE)
     public void notifyChangeRecordsAvailable(
-        @WebParam(name = "notify_changeRecordsAvailable", targetNamespace = "urn:uddi-org:repl_v3",
partName = "body")
-        NotifyChangeRecordsAvailable body)
-        throws DispositionReportFaultMessage, RemoteException
-    ;
+            @WebParam(name = "notify_changeRecordsAvailable", targetNamespace = "urn:uddi-org:repl_v3",
partName = "body") NotifyChangeRecordsAvailable body)
+            throws DispositionReportFaultMessage, RemoteException;
 
     /**
-     * 
+     * This UDDI API message provides the means by which the current existence
+     * and replication readiness of a node may be obtained.
+     *
      * @param body
-     * @return
-     *     returns java.lang.String
-     * @throws DispositionReportFaultMessage, RemoteException
+     * @return returns java.lang.String The response to this message must
+     * contain the operatorNodeID element of the pinged node.
+     * @throws DispositionReportFaultMessage, RemoteException Processing an
+     * inbound replication message may fail due to a server internal error. The
+     * common behavior for all error cases is to return an E_fatalError error
+     * code. Error reporting SHALL be that specified by Section 4.8 – Success
+     * and Error Reporting of this specification.
      */
     @WebMethod(operationName = "do_ping", action = "do_ping")
     @WebResult(name = "operatorNodeID", targetNamespace = "urn:uddi-org:repl_v3", partName
= "body")
     @SOAPBinding(parameterStyle = SOAPBinding.ParameterStyle.BARE)
     public String doPing(
-        @WebParam(name = "do_ping", targetNamespace = "urn:uddi-org:repl_v3", partName =
"body")
-        DoPing body)
-        throws DispositionReportFaultMessage, RemoteException
-    ;
+            @WebParam(name = "do_ping", targetNamespace = "urn:uddi-org:repl_v3", partName
= "body") DoPing body)
+            throws DispositionReportFaultMessage, RemoteException;
 
     /**
-     * 
-     * @return
-     *     returns java.util.List<org.uddi.repl_v3.ChangeRecordIDType>
-     * @throws DispositionReportFaultMessage, RemoteException
+     * This UDDI API message provides a means to obtain a list of highWaterMark
+     * element containing the highest known USN for all nodes in the replication
+     * graph.
+     *
+     * @return returns java.util.List<org.uddi.repl_v3.ChangeRecordIDType> <p
+     * class="MsoBodyText">A highWaterMarks element is returned that contains a
+     * list of highWaterMark elements listing the highest known USN for all
+     * nodes in the replication communication graph. See Section <a
+     * href="#_Ref52863431 ">7.2.4</a> <i>High Water Mark Vector</i>
for
+     * details.</p>
+     *
+     * <p class="MsoBodyText"><img
+     * src="http://uddi.org/pubs/uddi-v3.0.2-20041019_files/image129.gif"
+     * border="0" height="88" width="349"></p>
+     *
+     * <p class="MsoBodyText">If the highest originatingUSN for a specific node
+     * within the registry is not known, then the responding node MUST return a
+     * highWaterMark for that node with an originatingUSN of 0 (zero).</p>
+     *
+     * <p class="codeSample">&lt;highWaterMark&gt;</p>
+     *
+     * <p class="codeSample">&nbsp;&nbsp; &lt;nodeID&gt;…&lt;/nodeID&gt;</p>
+     *
+     * <p class="codeSample">&nbsp;&nbsp;
+     * &lt;originatingUSN&gt;<b>0</b>&lt;/originatingUSN&gt;</p>
+     *
+     * <p class="codeSample">&lt;/highWaterMark&gt;</p>
+     * @throws DispositionReportFaultMessage, RemoteException Processing an
+     * inbound replication message may fail due to a server internal error. The
+     * common behavior for all error cases is to return an E_fatalError error
+     * code. Error reporting SHALL be that specified by Section 4.8 – Success
+     * and Error Reporting of this specification.
      */
     @WebMethod(operationName = "get_highWaterMarks", action = "get_highWaterMarks")
     @WebResult(name = "highWaterMark", targetNamespace = "urn:uddi-org:repl_v3")
     @RequestWrapper(localName = "get_highWaterMarks", targetNamespace = "urn:uddi-org:repl_v3",
className = "org.uddi.repl_v3.GetHighWaterMarks")
     @ResponseWrapper(localName = "highWaterMarks", targetNamespace = "urn:uddi-org:repl_v3",
className = "org.uddi.repl_v3.HighWaterMarkVectorType")
     public List<ChangeRecordIDType> getHighWaterMarks()
-        throws DispositionReportFaultMessage, RemoteException
-    ;
+            throws DispositionReportFaultMessage, RemoteException;
 
     /**
-     * 
-     * @param body
-     * @throws DispositionReportFaultMessage, RemoteException
+     * Invoked by the target node in a custody transfer operation in response to
+     * transfer_entities, this API is used by the custodial node to ensure that
+     * permission has been granted to transfer custody of the entities that the
+     * target publisher has requested. The transfer_custody API is in the
+     * replication namespace since it is sent from one node to another node in a
+     * registry using replication.
+     *
+     * @param body <p class="MsoBodyText"
+     * style="margin-left:1.0in;text-indent:-.25in"><span
+     * style="font-family:Symbol">·<span style="font:7.0pt &quot;Times New
+     * Roman&quot;">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
+     * </span></span><b><i>transferToken</i></b>: Required
argument obtained
+     * from the custodial node via a call to get_transferToken by the publisher
+     * requesting a transfer of custody. The transferToken contains an opaque
+     * token, an expiration date, and the identity of the custodial node.&nbsp;
+     * The transferToken represents permission to transfer the entities that
+     * have been identified via a prior call to the get_transferToken API. The
+     * custodial node MUST verify that the transferToken has not expired and
+     * that the businessKey and tModelKey elements that the target publisher has
+     * provided in transfer_entities are allowed to be transferred as captured
+     * in the transfer token’s opaqueToken.</p>
+     *
+     * <p class="MsoBodyText" style="margin-left:1.0in;text-indent:-.25in"><span
+     * style="font-family:Symbol">·<span style="font:7.0pt &quot;Times New
+     * Roman&quot;">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
+     * </span></span><b><i>keyBag</i></b>: One or more
uddiKeys associated with
+     * businessEntity or tModel entities that the target publisher is requesting
+     * ownership of at the target node in the registry. The set of keys must be
+     * the same as the set of keys in the keyBag of the get_transferToken API
+     * call from which the given transferToken was once obtained.</p>
+     *
+     * <p class="MsoBodyText" style="margin-left:1.0in;text-indent:-.25in"><span
+     * style="font-family:Symbol">·<span style="font:7.0pt &quot;Times New
+     * Roman&quot;">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
+     * </span></span><b><i>transferOperationalInfo</i></b>:
Required argument.
+     * The accepting publisher’s authorizedName and the accepting node’s nodeID
+     * are provided on input to the relinquishing custodial node to allow it to
+     * update the operationalInfo associated with the entities whose custody is
+     * being transferred. The authorizedName and nodeID elements are both
+     * required. The accepting node’s nodeID is obtained via the Replication
+     * Configuration structure as described in Section <a href="#_Ref8979701
+     * ">7.5.2</a> <i>Configuration of a UDDI Node – operator element</i>.
The
+     * authorizedName is obtained from the call to transfer_entities by the
+     * requesting publisher.</p>
+     * @return <p class="MsoBodyText">The custodial node must verify that it has
+     * granted permission to transfer the entities identified and that this
+     * permission is still valid.&nbsp; This operation is comprised of two
+     * steps:</p>
+     *
+     * <p class="MsoBodyText"
+     * style="margin-left:1.0in;text-indent:-.25in">1.<span style="font:7.0pt
+     * &quot;Times New Roman&quot;">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
+     * </span>Verification that the transferToken was issued by it, that it has
+     * not expired, that it represents the authority to transfer no more and no
+     * less than those entities identified by the businessKey and tModelKey
+     * elements and that all these entities are still valid and not yet
+     * transferred. The transferToken is invalidated if any of these conditions
+     * are not met.</p>
+     *
+     * <p class="MsoBodyText"
+     * style="margin-left:1.0in;text-indent:-.25in">2.<span style="font:7.0pt
+     * &quot;Times New Roman&quot;">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
+     * </span>If the conditions above are met, the custodial node will prevent
+     * any further changes to the entities identified by the businessKey and
+     * tModelKey elements identified. The entity will remain in this state until
+     * the replication stream indicates it has been successfully processed via
+     * the replication stream.&nbsp; </p>
+     *
+     * <p class="MsoBodyText">Upon successful verification of the custody
+     * transfer request by the custodial node, an empty message is returned by
+     * it indicating the success of the request and acknowledging the custody
+     * transfer.&nbsp; </p>
+     *
+     * <p class="MsoBodyText">Following the issue of the empty message, the
+     * custodial node will submit into the replication stream a
+     * changeRecordNewData providing in the operationalInfo, the nodeID
+     * accepting custody of the datum and the authorizedName of the publisher
+     * accepting ownership. The acknowledgmentRequested attribute of this change
+     * record MUST be set to "true".</p>
+     *
+     * <p class="MsoBodyText">Finally, the custodial node invalidates the
+     * transferToken in order to prevent additional calls of the
+     * transfer_entities API.</p>
+     * @throws DispositionReportFaultMessage, RemoteException <p
+     * class="MsoBodyText">If an error occurs in processing this API call, a
+     * dispositionReport structure MUST be returned to the caller in a SOAP
+     * Fault. See Section <a href="#_Ref8979747 ">4.8</a> <i>Success and
Error
+     * Reporting.&nbsp; </i>In addition to the errors common to all APIs, the
+     * following error information is relevant here:</p>
+     *
+     * <p class="MsoBodyText" style="margin-left:1.0in;text-indent:-.25in"><span
+     * style="font-family:Symbol">·<span style="font:7.0pt &quot;Times New
+     * Roman&quot;">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
+     * </span></span><b>E_transferNotAllowed</b>: signifies that
the transfer of
+     * one or more entities has been rejected by the custodial node.&nbsp;
+     * Reasons for rejection include expiration of the transferToken and
+     * attempts to transfer a set of entities that does not match the one
+     * represented by the transferToken. The reason for rejecting the custody
+     * transfer SHOULD be clearly indicated in the error text.<a
+     * name="_Toc528997532"></a><a name="_Toc525464292"></a><a
+     * name="_Toc535517200"></a></p>
+     *
+     * <p class="MsoBodyText" style="margin-left:1.0in;text-indent:-.25in"><a
+     * name="_Toc42047326"><span style="font-family:Symbol">·<span
+     * style="font:7.0pt &quot;Times New
+     * Roman&quot;">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
+     * </span></span><b>E_invalidKeyPassed</b>: signifies that one
of the
+     * <i>uddiKey</i> values passed for entities to be transferred did not match
+     * with any known businessKey or tModelKey values. The key and element or
+     * attribute that caused the problem SHOULD be clearly indicated in the
+     * error text.</a></p>
+     *     
+* <h3><a name="_Toc45095949">Security Configuration for
+     * transfer_custody</a></h3>
+     *
+     * <p class="MsoBodyText">The use of mutual authentication of UDDI nodes in
+     * conjunction with the transfer_custody API is RECOMMENDED. This MAY be
+     * achieved using mutual X.509v3 certificate-based authentication as
+     * described in the Secure Sockets Layer (SSL) 3.0 protocol.&nbsp; SSL 3.0
+     * with mutual authentication is represented by the tModel
+     * uddi-org:mutualAuthenticatedSSL3 as described within Section <a
+     * href="#_Ref8980795 ">11.3.2</a> <i>Secure Sockets Layer Version 3 with
+     * Mutual Authentication</i>.</p>
      */
     @WebMethod(operationName = "transfer_custody", action = "transfer_custody")
     @SOAPBinding(parameterStyle = SOAPBinding.ParameterStyle.BARE)
     public void transferCustody(
-        @WebParam(name = "transfer_custody", targetNamespace = "urn:uddi-org:repl_v3", partName
= "body")
-        TransferCustody body)
-        throws DispositionReportFaultMessage, RemoteException
-    ;
-
+            @WebParam(name = "transfer_custody", targetNamespace = "urn:uddi-org:repl_v3",
partName = "body") TransferCustody body)
+            throws DispositionReportFaultMessage, RemoteException;
 }
 
\ No newline at end of file

Modified: juddi/branches/juddi-3.2.x/uddi-ws/src/main/java/org/uddi/v3_service/UDDISecurityPortType.java
URL: http://svn.apache.org/viewvc/juddi/branches/juddi-3.2.x/uddi-ws/src/main/java/org/uddi/v3_service/UDDISecurityPortType.java?rev=1479003&r1=1479002&r2=1479003&view=diff
==============================================================================
--- juddi/branches/juddi-3.2.x/uddi-ws/src/main/java/org/uddi/v3_service/UDDISecurityPortType.java
(original)
+++ juddi/branches/juddi-3.2.x/uddi-ws/src/main/java/org/uddi/v3_service/UDDISecurityPortType.java
Fri May  3 23:23:27 2013
@@ -14,8 +14,6 @@
  * limitations under the License.
  *
  */
-
-
 package org.uddi.v3_service;
 
 import java.rmi.Remote;
@@ -31,14 +29,48 @@ import org.uddi.api_v3.AuthToken;
 import org.uddi.api_v3.DiscardAuthToken;
 import org.uddi.api_v3.GetAuthToken;
 
-
 /**
  * This portType defines all of the UDDI security operations.
- * 
- * This class was generated by the JAX-WS RI.
- * JAX-WS RI 2.1.5-b03-
- * Generated source version: 2.1
- * 
+ *
+ * This class was generated by the JAX-WS RI. JAX-WS RI 2.1.5-b03- Generated
+ * source version: 2.1
+ *
+ * <p class="MsoBodyText">The security API includes the following API calls:</p>
+ *
+ * <p class="MsoBodyText" style="margin-left:1.0in;text-indent:-.25in"><span
+ * style="font-family:Symbol">·<span style="font:7.0pt &quot;Times New
+ * Roman&quot;">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
+ * </span></span><b>discard_authToken</b>: Used to inform a node
that a
+ * previously obtained authentication token is no longer required and should be
+ * considered invalid if used after this message is received.</p>
+ *
+ * <p class="MsoBodyText" style="margin-left:1.0in;text-indent:-.25in"><span
+ * style="font-family:Symbol">·<span style="font:7.0pt &quot;Times New
+ * Roman&quot;">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
+ * </span></span><b>get_authToken</b>: Used to request an authentication
token
+ * in the form of an authInfo element from a UDDI node.&nbsp; An authInfo
+ * element MAY be required when using the API calls defined in Section <a
+ * href="#_Ref8979317 ">5.1</a> <i>Inquiry API Set</i>, Section <a
+ * href="#_Ref8979330 ">5.2</a> <i>Publication API Set</i>, Section
<a
+ * href="#_Ref8979371 ">5.4</a> <i>Custody and Ownership Transfer API Set,
+ * </i>and Section <a href="#_Ref8979423 ">5.5</a> <i>Subscription
API
+ * Set</i>.</p>
+ *
+ * <p class="MsoBodyText">Whether authInfo elements are required on API calls is
+ * determined by node policy as described in Section <a href="#_Ref8979130
+ * ">4.8</a> <i>About Access Control and the authInfo Element</i>. In
the event
+ * that an authInfo element is not discarded, a node MAY choose to expire the
+ * authentication token so it is no longer valid for authentication in API calls
+ * after a period of time.&nbsp; If an expired token is passed to an API call
+ * other than discard_authToken, the error E_authTokenExpired will be returned
+ * as described in Chapter 12, <i>Error Codes</i>.</p>
+ *
+ * <p class="MsoBodyText">A UDDI node typically does not support the Security
+ * API set if it does not support using an authInfo element in any API set. If
+ * the node does support using an authInfo element in any of the API set
+ * provided by the node, it SHOULD support the Security API set.&nbsp; A node
+ * MAY provide an alternative mechanism for obtaining authInfo elements.&nbsp;
+ * </p>
  */
 @WebService(name = "UDDI_Security_PortType", targetNamespace = "urn:uddi-org:v3_service")
 @SOAPBinding(parameterStyle = SOAPBinding.ParameterStyle.BARE)
@@ -54,35 +86,83 @@ import org.uddi.api_v3.GetAuthToken;
     org.uddi.policy_v3.ObjectFactory.class,
     org.uddi.policy_v3_instanceparms.ObjectFactory.class
 })
-public interface UDDISecurityPortType extends Remote{
-
+public interface UDDISecurityPortType extends Remote {
 
     /**
-     * 
-     * @param body
-     * @throws DispositionReportFaultMessage
+     * The discard_authToken API call is used to inform a node that the passed
+     * authentication token is to be discarded, effectively ending the session.
+     *
+     * @param body <span style="font-family:Symbol">·<span style="font:7.0pt
+     * &quot;Times New
+     * Roman&quot;">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
+     * </span></span><b><i>authInfo</i></b>: This required
argument is an
+     * element that contains an authentication token.&nbsp; Authentication
+     * tokens are obtained using the get_authToken API call. Discarding an
+     * expired authToken is processed and reported as a success condition.
+     * @throws DispositionReportFaultMessage Upon successful completion, an
+     * empty message is returned. See section 4.8 Success and Error Reporting.
+     * If an error occurs in processing this API call, a dispositionReport
+     * structure will be returned to the caller in a SOAP Fault.
      */
     @WebMethod(operationName = "discard_authToken", action = "discard_authToken")
     public void discardAuthToken(
-        @WebParam(name = "discard_authToken", targetNamespace = "urn:uddi-org:api_v3", partName
= "body")
-        DiscardAuthToken body)
-        throws DispositionReportFaultMessage, RemoteException
-    ;
+            @WebParam(name = "discard_authToken", targetNamespace = "urn:uddi-org:api_v3",
partName = "body") DiscardAuthToken body)
+            throws DispositionReportFaultMessage, RemoteException;
 
     /**
-     * 
-     * @param body
-     * @return
-     *     returns org.uddi.api_v3.AuthToken
-     * @throws DispositionReportFaultMessage
+     * The get_authToken API call is used to obtain an authentication token. An
+     * authToken element MAY be required when using the API calls defined in
+     * Section 5.1 Inquiry API Set, Section 5.2 Publication API Set, Section 5.4
+     * Custody and Ownership Transfer API Set, and Section 5.5 Subscription API
+     * Set.
+     *
+     * @param body <p class="MsoBodyText"
+     * style="margin-left:1.0in;text-indent:-.25in"><span
+     * style="font-family:Symbol">·<span style="font:7.0pt &quot;Times New
+     * Roman&quot;">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
+     * </span></span><b><i>userID</i></b>: This required
attribute argument is
+     * the user identifier that an individual authorized user was assigned by a
+     * UDDI node.&nbsp; Nodes SHOULD provide a means for individuals to obtain a
+     * userID and password credentials that will be valid at the given node.</p>
+     *
+     * <p class="MsoBodyText" style="margin-left:1.0in;text-indent:-.25in"><span
+     * style="font-family:Symbol">·<span style="font:7.0pt &quot;Times New
+     * Roman&quot;">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
+     * </span></span><b><i>cred</i></b>: This required
attribute argument is the
+     * password or credential that is associated with the user.</p>
+     * @return returns org.uddi.api_v3.AuthToken Upon successful completion this
+     * API call returns an authToken structure that contains a valid authInfo
+     * element that can be used in subsequent calls to API calls that require an
+     * authInfo value.
+     *
+     * The authToken message has the form: <img
+     * src="http://uddi.org/pubs/uddi-v3.0.2-20041019_files/image085.gif">
+     *     
+* The authToken structure contains a single authInfo element that
+     * represents a token that is to be passed back in API calls that require
+     * one. This structure is always returned as a synchronous response to the
+     * get_authToken message.
+     *
+     *
+     * @throws DispositionReportFaultMessage <p class="MsoBodyText">If an error
+     * occurs in processing this API call, a dispositionReport element will be
+     * returned to the caller within a SOAP Fault.&nbsp; In addition to the
+     * errors common to all APIs, the following error information is relevant
+     * here:</p>
+     *
+     * <p class="MsoBodyText" style="margin-left:1.0in;text-indent:-.25in"><span
+     * style="font-family:Symbol">·<span style="font:7.0pt &quot;Times New
+     * Roman&quot;">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
+     * </span></span><b>E_unknownUser</b>: Signifies that the UDDI
node that
+     * received the request does not accept the userID and/or cred argument
+     * values passed as valid credentials.</p>
+     *
+     * <p class="MsoBodyText">&nbsp;</p>
      */
     @WebMethod(operationName = "get_authToken", action = "get_authToken")
     @WebResult(name = "authToken", targetNamespace = "urn:uddi-org:api_v3", partName = "body")
     public AuthToken getAuthToken(
-        @WebParam(name = "get_authToken", targetNamespace = "urn:uddi-org:api_v3", partName
= "body")
-        GetAuthToken body)
-        throws DispositionReportFaultMessage, RemoteException
-    ;
-
+            @WebParam(name = "get_authToken", targetNamespace = "urn:uddi-org:api_v3", partName
= "body") GetAuthToken body)
+            throws DispositionReportFaultMessage, RemoteException;
 }
 
\ No newline at end of file

Modified: juddi/branches/juddi-3.2.x/uddi-ws/src/main/java/org/uddi/v3_service/UDDISubscriptionListenerPortType.java
URL: http://svn.apache.org/viewvc/juddi/branches/juddi-3.2.x/uddi-ws/src/main/java/org/uddi/v3_service/UDDISubscriptionListenerPortType.java?rev=1479003&r1=1479002&r2=1479003&view=diff
==============================================================================
--- juddi/branches/juddi-3.2.x/uddi-ws/src/main/java/org/uddi/v3_service/UDDISubscriptionListenerPortType.java
(original)
+++ juddi/branches/juddi-3.2.x/uddi-ws/src/main/java/org/uddi/v3_service/UDDISubscriptionListenerPortType.java
Fri May  3 23:23:27 2013
@@ -14,8 +14,6 @@
  * limitations under the License.
  *
  */
-
-
 package org.uddi.v3_service;
 
 import java.rmi.Remote;
@@ -30,14 +28,51 @@ import javax.xml.bind.annotation.XmlSeeA
 import org.uddi.api_v3.DispositionReport;
 import org.uddi.subr_v3.NotifySubscriptionListener;
 
-
 /**
  * This portType defines all of the UDDI subscriptionListener operations.
+ *
+ * This class was generated by the JAX-WS RI. JAX-WS RI 2.1.5-b03- Generated
+ * source version: 2.1
  * 
- * This class was generated by the JAX-WS RI.
- * JAX-WS RI 2.1.5-b03-
- * Generated source version: 2.1
+ * <h1>Notes from the jUDDI development team</h1>
+ * To implement a callback for UDDI subscriptions:
+ * <ol><li>Implement your own instance of this class.</li>
+ * <li>Decide whether or not you want to host your implementation within a web servlet
container. If the answer is yes, follow standard procedures for doing so.</li>
+ * <li>If you're hosting it yourself, try out the following code. You'll need either
JDK 1.6+ or Apache CXF with the Jetty libraries within your classpath
+ * <pre>
+     String url = "http://localhost:7777/uddi_subscription_back";
+     Endpoint ep = Endpoint.publish(url, new ClientSubscriptionCallback(this));
+</pre><br>
+* Where "ClientSubscriptionCallback" is your implementation class for this interface
+* </li>
+* </ol>
  * 
+ * <h1>Notes from the UDDI Spec</h1>
+ * This API, when implemented by a subscriber and specified in a subscription,
+ * enables the node to deliver notifications to subscription listeners by
+ * invoking a Web service. New, modified, and deleted data that matches the
+ * subscription is passed to notify_subscriptionListener. If the brief attribute
+ * of the subscription is "true", then only the relevant keys will be sent; full
+ * details of the changed data can be accomplished via the standard get_xx API’s
+ * if required. If a particular item that matches the subscription criteria is
+ * deleted during the notificationInterval, or is changed in such a way that it
+ * no longer matches the criterion defined for the subscription, then these
+ * entities are included in a keyBag containing a deleted element with a value
+ * of "true".
+ *
+ * To allow subscribers to determine whether a notification has been lost, the
+ * coverage period of the notification is included. A date/time indicating the
+ * date/time values corresponding to the start and end points of this is
+ * provided. The start date/time used in this call SHOULD align with the end
+ * date/time of the previous call and so fourth.  *
+ * If the maxEntities option was specified in the save_subscription call, the
+ * response supplied via this call is limited to that number of entities. If the
+ * node cannot send all of the results in a single notify_subscriptionListener
+ * call, then the node repeatedly invokes the notify_subscriptionListener
+ * service until all information has been transmitted. In no case will the data
+ * sent to notify_subscriptionListener exceed the maximum message size per the
+ * policy of the node.
+ *
  */
 @WebService(name = "UDDI_SubscriptionListener_PortType", targetNamespace = "urn:uddi-org:v3_service")
 @XmlSeeAlso({
@@ -52,24 +87,84 @@ import org.uddi.subr_v3.NotifySubscripti
     org.uddi.policy_v3.ObjectFactory.class,
     org.uddi.policy_v3_instanceparms.ObjectFactory.class
 })
-public interface UDDISubscriptionListenerPortType extends Remote{
-
+public interface UDDISubscriptionListenerPortType extends Remote {
 
     /**
-     * 
-     * @param body
-     * @return
-     *     returns org.uddi.api_v3.DispositionReport
-     * @throws DispositionReportFaultMessage
+     * This API, when implemented by a subscriber and specified in a
+     * subscription, enables the node to deliver notifications to subscription
+     * listeners by invoking a Web service. New, modified, and deleted data that
+     * matches the subscription is passed to notify_subscriptionListener. If the
+     * brief attribute of the subscription is "true", then only the relevant
+     * keys will be sent; full details of the changed data can be accomplished
+     * via the standard get_xx API’s if required. If a particular item that
+     * matches the subscription criteria is deleted during the
+     * notificationInterval, or is changed in such a way that it no longer
+     * matches the criterion defined for the subscription, then these entities
+     * are included in a keyBag containing a deleted element with a value of
+     * "true".
+     *
+     * To allow subscribers to determine whether a notification has been lost,
+     * the coverage period of the notification is included. A date/time
+     * indicating the date/time values corresponding to the start and end points
+     * of this is provided. The start date/time used in this call SHOULD align
+     * with the end date/time of the previous call and so fourth.      *
+     * If the maxEntities option was specified in the save_subscription call,
+     * the response supplied via this call is limited to that number of
+     * entities. If the node cannot send all of the results in a single
+     * notify_subscriptionListener call, then the node repeatedly invokes the
+     * notify_subscriptionListener service until all information has been
+     * transmitted. In no case will the data sent to notify_subscriptionListener
+     * exceed the maximum message size per the policy of the node.
+     *
+     * @param body <p class="MsoBodyText"
+     * style="margin-left:1.0in;text-indent:-.25in"><span
+     * style="font-family:Symbol">·<span style="font:7.0pt &quot;Times New
+     * Roman&quot;">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
+     * </span></span><b><i>authInfo</i></b>:&nbsp;
This optional argument is an
+     * element that contains an authentication token.&nbsp; Subscription
+     * listener services that wish to restrict who can transmit subscription
+     * data MAY require authInfo for this call, though this is a matter of
+     * client policy.</p>
+     *
+     * <p class="MsoBodyText" style="margin-left:1.0in;text-indent:-.25in"><span
+     * style="font-family:Symbol">·<span style="font:7.0pt &quot;Times New
+     * Roman&quot;">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
+     * </span></span><b><i>subscriptionResultsList</i></b>:&nbsp;
This list
+     * contains the results for this notification, which consist of the result
+     * structures which are normally returned for standard find_xx or get_xx
+     * APIs, based upon the criteria saved in the subscriptionFilter for the
+     * subscription which is generating this notification. Note that the
+     * chunkToken is not returned with this structure for this API.&nbsp; The
+     * subscriptionResultsList also contains a coveragePeriod structure which
+     * defines the time period over which the node data is compared with the
+     * subscription criterion in order to produce the result set. It provides
+     * the start and end date/time information according to the format described
+     * in Section <a href="#_Ref3402225 ">5.5.4</a> <i>Subscription Coverage
+     * Period</i>.&nbsp; The "current" state of registry entries pertaining to
+     * the subscription referenced by the subscriptionKey provided are returned
+     * if they were last changed during the specified time period. See Section
+     * <a href="#_Ref42320503 ">5.5.11.3</a> <i>Returns</i> for more
information
+     * on the subscriptionResultsList’s content.</p>
+     * @return returns org.uddi.api_v3.DispositionReport Upon successful
+     * completion, notify_subscriptionListener returns an empty message. Note
+     * that this is being returned by the client supported API.
+     * @throws DispositionReportFaultMessage <p class="MsoBodyText">If an error
+     * occurs in processing this API call, a dispositionReport structure is
+     * returned to the caller in a SOAP Fault.&nbsp; In addition to the errors
+     * common to all APIs, the following error information is relevant here:</p>
+     *
+     * <p class="MsoBodyText" style="margin-left:1.0in;text-indent:-.25in"><span
+     * style="font-family:Symbol">·<span style="font:7.0pt &quot;Times New
+     * Roman&quot;">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
+     * </span></span><b>E_fatalError:&nbsp; </b>signifies the
client’s failure
+     * to receive notification data.&nbsp;&nbsp; The node is not obligated to
+     * retry.</p>
      */
     @WebMethod(operationName = "notify_subscriptionListener", action = "notify_subscriptionListener")
     @WebResult(name = "dispositionReport", targetNamespace = "urn:uddi-org:api_v3", partName
= "body")
     @SOAPBinding(parameterStyle = SOAPBinding.ParameterStyle.BARE)
     public DispositionReport notifySubscriptionListener(
-        @WebParam(name = "notify_subscriptionListener", targetNamespace = "urn:uddi-org:subr_v3",
partName = "body")
-        NotifySubscriptionListener body)
-        throws DispositionReportFaultMessage, RemoteException
-    ;
-
+            @WebParam(name = "notify_subscriptionListener", targetNamespace = "urn:uddi-org:subr_v3",
partName = "body") NotifySubscriptionListener body)
+            throws DispositionReportFaultMessage, RemoteException;
 }
 
\ No newline at end of file



---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@juddi.apache.org
For additional commands, e-mail: commits-help@juddi.apache.org


Mime
View raw message