juddi-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From alexo...@apache.org
Subject svn commit: r1479003 [1/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
Author: alexoree
Date: Fri May  3 23:23:27 2013
New Revision: 1479003

URL: http://svn.apache.org/r1479003
Log:
Adding UDDI v3 documentation right into the javadocs JIRA JUDDI-601

Modified:
    juddi/branches/juddi-3.2.x/juddi-client/src/main/java/org/apache/juddi/v3/client/UDDIConstants.java
    juddi/branches/juddi-3.2.x/uddi-ws/src/main/java/org/uddi/v3_service/UDDICustodyTransferPortType.java
    juddi/branches/juddi-3.2.x/uddi-ws/src/main/java/org/uddi/v3_service/UDDIInquiryPortType.java
    juddi/branches/juddi-3.2.x/uddi-ws/src/main/java/org/uddi/v3_service/UDDIPublicationPortType.java
    juddi/branches/juddi-3.2.x/uddi-ws/src/main/java/org/uddi/v3_service/UDDIReplicationPortType.java
    juddi/branches/juddi-3.2.x/uddi-ws/src/main/java/org/uddi/v3_service/UDDISecurityPortType.java
    juddi/branches/juddi-3.2.x/uddi-ws/src/main/java/org/uddi/v3_service/UDDISubscriptionListenerPortType.java
    juddi/branches/juddi-3.2.x/uddi-ws/src/main/java/org/uddi/v3_service/UDDISubscriptionPortType.java
    juddi/branches/juddi-3.2.x/uddi-ws/src/main/java/org/uddi/v3_service/UDDIValueSetCachingPortType.java
    juddi/branches/juddi-3.2.x/uddi-ws/src/main/java/org/uddi/v3_service/UDDIValueSetValidationPortType.java

Modified: juddi/branches/juddi-3.2.x/juddi-client/src/main/java/org/apache/juddi/v3/client/UDDIConstants.java
URL: http://svn.apache.org/viewvc/juddi/branches/juddi-3.2.x/juddi-client/src/main/java/org/apache/juddi/v3/client/UDDIConstants.java?rev=1479003&r1=1479002&r2=1479003&view=diff
==============================================================================
--- juddi/branches/juddi-3.2.x/juddi-client/src/main/java/org/apache/juddi/v3/client/UDDIConstants.java (original)
+++ juddi/branches/juddi-3.2.x/juddi-client/src/main/java/org/apache/juddi/v3/client/UDDIConstants.java Fri May  3 23:23:27 2013
@@ -7,77 +7,501 @@ package org.apache.juddi.v3.client;
  */
 public interface UDDIConstants {
 
+    /**
+     * andAllKeys: this changes the behavior for identifierBag to AND keys
+     * rather than OR them. This is already the default for categoryBag and
+     * tModelBag.
+     */
     public static final String AND_ALL_KEYS = "andAllKeys";
+    /**
+     * andAllKeys: this changes the behavior for identifierBag to AND keys
+     * rather than OR them. This is already the default for categoryBag and
+     * tModelBag.
+     */
     public static final String AND_ALL_KEYS_TMODEL = "uddi:uddi.org:findqualifier:andallkeys";
+    /**
+     * approximateMatch: signifies that wildcard search behavior is desired.
+     * This behavior is defined by the uddi-org:approximatematch:SQL99 tModel
+     * and means "approximate matching as defined for the character like
+     * predicate in ISO/IEC9075-2:1999(E) Section 8.5 like predicate, where the
+     * percent sign (%) indicates any number of characters and an underscore (_)
+     * indicates any single character. The backslash character (\) is used as an
+     * escape character for the percent sign, underscore and backslash
+     * characters. This find qualifier adjusts the matching behavior for name,
+     * keyValue and keyName (where applicable).
+     */
     public static final String APPROXIMATE_MATCH = "approximateMatch";
+    /**
+     * approximateMatch: signifies that wildcard search behavior is desired.
+     * This behavior is defined by the uddi-org:approximatematch:SQL99 tModel
+     * and means "approximate matching as defined for the character like
+     * predicate in ISO/IEC9075-2:1999(E) Section 8.5 like predicate, where the
+     * percent sign (%) indicates any number of characters and an underscore (_)
+     * indicates any single character. The backslash character (\) is used as an
+     * escape character for the percent sign, underscore and backslash
+     * characters. This find qualifier adjusts the matching behavior for name,
+     * keyValue and keyName (where applicable).
+     */
     public static final String APPROXIMATE_MATCH_TMODEL = "uddi:uddi.org:findqualifier:approximatematch";
+    /**
+     * binarySort: this qualifier allows for greater speed in sorting. It causes
+     * a binary sort by name, as represented in Unicode codepoints.
+     */
     public static final String BINARY_SORT = "binarySort";
+    /**
+     * binarySort: this qualifier allows for greater speed in sorting. It causes
+     * a binary sort by name, as represented in Unicode codepoints.
+     */
     public static final String BINARY_SORT_TMODEL = "uddi:uddi.org:sortorder:binarysort";
+    /**
+     * bindingSubset: this is used in the find_business API or the find_service
+     * API and is used only in conjunction with a categoryBag argument. It
+     * causes the component of the search that involves categorization to use
+     * only the categoryBag elements from contained bindingTemplate elements
+     * within the registered data and ignores any entries found in the
+     * categoryBag which are not direct descendent elements of registered
+     * businessEntity elements or businessService elements. The resulting
+     * businessList or serviceList return those businesses or services that
+     * matched based on this modified behavior, in conjunction with any other
+     * search arguments provided. Additionally, in the case of the returned
+     * businessList from a find_business, the contained serviceInfos elements
+     * will only reflect summary data (in a serviceInfo element) for those
+     * services (contained or referenced) that contained a binding that matched
+     * on one of the supplied categoryBag arguments.
+     */
     public static final String BINDING_SUBSET = "bindingSubset";
+    /**
+     * bindingSubset: this is used in the find_business API or the find_service
+     * API and is used only in conjunction with a categoryBag argument. It
+     * causes the component of the search that involves categorization to use
+     * only the categoryBag elements from contained bindingTemplate elements
+     * within the registered data and ignores any entries found in the
+     * categoryBag which are not direct descendent elements of registered
+     * businessEntity elements or businessService elements. The resulting
+     * businessList or serviceList return those businesses or services that
+     * matched based on this modified behavior, in conjunction with any other
+     * search arguments provided. Additionally, in the case of the returned
+     * businessList from a find_business, the contained serviceInfos elements
+     * will only reflect summary data (in a serviceInfo element) for those
+     * services (contained or referenced) that contained a binding that matched
+     * on one of the supplied categoryBag arguments.
+     */
     public static final String BINDING_SUBSET_TMODEL = "uddi:uddi.org:findqualifier:bindingsubset";
+    /**
+     * caseInsensitiveSort: signifies that the result set should be sorted
+     * without regard to case. This overrides the default case sensitive sorting
+     * behavior.
+     */
     public static final String CASE_INSENSITIVE_SORT = "caseInsensitiveSort";
+    /**
+     * caseInsensitiveSort: signifies that the result set should be sorted
+     * without regard to case. This overrides the default case sensitive sorting
+     * behavior.
+     */
     public static final String CASE_INSENSITIVE_SORT_TMODEL = "uddi:uddi.org:findqualifier:caseinsensitivesort";
+    /**
+     * caseInsensitiveMatch: signifies that the matching behavior for name,
+     * keyValue and keyName (where applicable) should be performed without
+     * regard to case.
+     */
     public static final String CASE_INSENSITIVE_MATCH = "caseInsensitiveMatch";
+    /**
+     * caseInsensitiveMatch: signifies that the matching behavior for name,
+     * keyValue and keyName (where applicable) should be performed without
+     * regard to case.
+     */
     public static final String CASE_INSENSITIVE_MATCH_TMODEL = "uddi:uddi.org:findqualifier:caseinsensitivematch";
+    /**
+     * caseSensitiveSort: signifies that the result set should be sorted with
+     * regard to case. This is the default behavior.
+     */
     public static final String CASE_SENSITIVE_SORT = "caseSensitiveSort";
+    /**
+     * caseSensitiveSort: signifies that the result set should be sorted with
+     * regard to case. This is the default behavior.
+     */
     public static final String CASE_SENSITIVE_SORT_TMODEL = "uddi:uddi.org:findqualifier:casesensitivesort";
+    /**
+     * caseSensitiveMatch: signifies that the matching behavior for name,
+     * keyValue and keyName (where applicable) should be performed with regard
+     * to case. This is the default behavior.
+     */
     public static final String CASE_SENSITIVE_MATCH = "caseSensitiveMatch";
+    /**
+     * caseSensitiveMatch: signifies that the matching behavior for name,
+     * keyValue and keyName (where applicable) should be performed with regard
+     * to case. This is the default behavior.
+     */
     public static final String CASE_SENSITIVE_MATCH_TMODEL = "uddi:uddi.org:findqualifier:casesensitivematch";
+    /**
+     * combineCategoryBags: this may only be used in the find_business and
+     * find_service calls. In the case of find_business, this qualifier makes
+     * the categoryBag entries for the full businessEntity element behave as
+     * though all categoryBag elements found at the businessEntity level and in
+     * all contained or referenced businessService elements and bindingTemplate
+     * elements were combined. Searching for a category will yield a positive
+     * match on a registered business if any of the categoryBag elements
+     * contained within the full businessEntity element (including the
+     * categoryBag elements within contained or referenced businessService
+     * elements or bindingTemplate elements) contains the filter criteria. In
+     * the case of find_service, this qualifier makes the categoryBag entries
+     * for the full businessService element behave as though all categoryBag
+     * elements found at the businessService level and in all contained or
+     * referenced elements in the bindingTemplate elements were combined.
+     * Searching for a category will yield a positive match on a registered
+     * service if any of the categoryBag elements contained within the full
+     * businessService element (including the categoryBag elements within
+     * contained or referenced bindingTemplate elements) contains the filter
+     * criteria. This find qualifier does not cause the keyedReferences in
+     * categoryBags to be combined with the keyedReferences in
+     * keyedReferenceGroups in categoryBags when performing the comparison. The
+     * keyedReferences are combined with each other, and the
+     * keyedReferenceGroups are combined with each other.
+     */
     public static final String COMBINE_CATEGORY_BAGS = "combineCategoryBags";
+    /**
+     * combineCategoryBags: this may only be used in the find_business and
+     * find_service calls. In the case of find_business, this qualifier makes
+     * the categoryBag entries for the full businessEntity element behave as
+     * though all categoryBag elements found at the businessEntity level and in
+     * all contained or referenced businessService elements and bindingTemplate
+     * elements were combined. Searching for a category will yield a positive
+     * match on a registered business if any of the categoryBag elements
+     * contained within the full businessEntity element (including the
+     * categoryBag elements within contained or referenced businessService
+     * elements or bindingTemplate elements) contains the filter criteria. In
+     * the case of find_service, this qualifier makes the categoryBag entries
+     * for the full businessService element behave as though all categoryBag
+     * elements found at the businessService level and in all contained or
+     * referenced elements in the bindingTemplate elements were combined.
+     * Searching for a category will yield a positive match on a registered
+     * service if any of the categoryBag elements contained within the full
+     * businessService element (including the categoryBag elements within
+     * contained or referenced bindingTemplate elements) contains the filter
+     * criteria. This find qualifier does not cause the keyedReferences in
+     * categoryBags to be combined with the keyedReferences in
+     * keyedReferenceGroups in categoryBags when performing the comparison. The
+     * keyedReferences are combined with each other, and the
+     * keyedReferenceGroups are combined with each other.
+     */
     public static final String COMBINE_CATEGORY_BAGS_TMODEL = "uddi:uddi.org:findqualifier:combinecategorybags";
+    /**
+     * diacriticInsensitiveMatch: signifies that matching behavior for name,
+     * keyValue and keyName (where applicable) should be performed without
+     * regard to diacritics. Support for this findQualifier by nodes is
+     * OPTIONAL.
+     */
     public static final String DIACRITIC_INSENSITIVE_MATCH = "diacriticInsensitiveMatch";
+    /**
+     * diacriticInsensitiveMatch: signifies that matching behavior for name,
+     * keyValue and keyName (where applicable) should be performed without
+     * regard to diacritics. Support for this findQualifier by nodes is
+     * OPTIONAL.
+     */
     public static final String DIACRITIC_INSENSITIVE_MATCH_TMODEL = "uddi:uddi.org:findqualifier:diacriticsinsensitivematch";
+    /**
+     * diacriticSensitiveMatch: signifies that the matching behavior for name,
+     * keyValue and keyName (where applicable) should be performed with regard
+     * to diacritics. This is the default behavior.
+     */
     public static final String DIACRITIC_SENSITIVE_MATCH = "diacriticSensitiveMatch";
+    /**
+     * diacriticSensitiveMatch: signifies that the matching behavior for name,
+     * keyValue and keyName (where applicable) should be performed with regard
+     * to diacritics. This is the default behavior.
+     */
     public static final String DIACRITIC_SENSITIVE_MATCH_TMODEL = "uddi:uddi.org:findqualifier:diacriticssensitivematch";
+    /**
+     * exactMatch: signifies that only entries with names, keyValues and
+     * keyNames (where applicable) that exactly match the name argument passed
+     * in, after normalization, will be returned. This qualifier is sensitive to
+     * case and diacritics where applicable. This qualifier represents the
+     * default behavior.
+     */
     public static final String EXACT_MATCH = "exactMatch";
+    /**
+     * exactMatch: signifies that only entries with names, keyValues and
+     * keyNames (where applicable) that exactly match the name argument passed
+     * in, after normalization, will be returned. This qualifier is sensitive to
+     * case and diacritics where applicable. This qualifier represents the
+     * default behavior.
+     */
     public static final String EXACT_MATCH_TMODEL = "uddi:uddi.org:findqualifier:exactmatch";
+    /**
+     * signaturePresent: this is used with any find_xx API to restrict the
+     * result set to entities which either contain an XML Digital Signature
+     * element, or are contained in an entity which contains one. The Signature
+     * element is retrieved using a get_xx API call and SHOULD be verified by
+     * the client. A UDDI node may or may not verify the signature and therefore
+     * use of this find qualifier, or the presence of a Signature element SHOULD
+     * only be for the refinement of the result set from the find_xx API and
+     * SHOULD not be used as a verification mechanism by UDDI clients.
+     */
     public static final String SIGNATURE_PRESENT = "signaturePresent";
+    /**
+     * signaturePresent: this is used with any find_xx API to restrict the
+     * result set to entities which either contain an XML Digital Signature
+     * element, or are contained in an entity which contains one. The Signature
+     * element is retrieved using a get_xx API call and SHOULD be verified by
+     * the client. A UDDI node may or may not verify the signature and therefore
+     * use of this find qualifier, or the presence of a Signature element SHOULD
+     * only be for the refinement of the result set from the find_xx API and
+     * SHOULD not be used as a verification mechanism by UDDI clients.
+     */
     public static final String SIGNATURE_PRESENT_TMODEL = "uddi:uddi.org:findqualifier:signaturepresent";
+    /**
+     * orAllKeys: this changes the behavior for tModelBag and categoryBag to OR
+     * the keys within a bag, rather than to AND them. Using this findQualifier
+     * with both a categoryBag and a tModelBag, will cause all of the keys in
+     * BOTH the categoryBag and the tModelBag to be OR’d together rather than
+     * AND’d. It is not possible to OR the categories and retain the default AND
+     * behavior of the tModels. The behavior of keyedReferenceGroups in a
+     * categoryBag is analogous to that of individual keyedReferences, that is,
+     * the complete categoryBag is changed to OR the keys.
+     */
     public static final String OR_ALL_KEYS = "orAllKeys";
+    /**
+     * orAllKeys: this changes the behavior for tModelBag and categoryBag to OR
+     * the keys within a bag, rather than to AND them. Using this findQualifier
+     * with both a categoryBag and a tModelBag, will cause all of the keys in
+     * BOTH the categoryBag and the tModelBag to be OR’d together rather than
+     * AND’d. It is not possible to OR the categories and retain the default AND
+     * behavior of the tModels. The behavior of keyedReferenceGroups in a
+     * categoryBag is analogous to that of individual keyedReferences, that is,
+     * the complete categoryBag is changed to OR the keys.
+     */
     public static final String OR_ALL_KEYS_TMODEL = "uddi:uddi.org:findqualifier:orallkeys";
+    /**
+     * orLikeKeys: when a bag container (i.e. categoryBag or identifierBag)
+     * contains multiple keyedReference elements, any keyedReference filters
+     * that come from the same namespace (e.g. have the same tModelKey value)
+     * are OR’d together rather than AND’d. For example "find any of these four
+     * values from this namespace, and any of these two values from this
+     * namespace". The behavior of keyedReferenceGroups is analogous to that of
+     * keyedReferences, that is, keyedReferenceGroups that have the same
+     * tModelKey value are OR’d together rather than AND’d.
+     */
     public static final String OR_LIKE_KEYS = "orLikeKeys";
+    /**
+     * orLikeKeys: when a bag container (i.e. categoryBag or identifierBag)
+     * contains multiple keyedReference elements, any keyedReference filters
+     * that come from the same namespace (e.g. have the same tModelKey value)
+     * are OR’d together rather than AND’d. For example "find any of these four
+     * values from this namespace, and any of these two values from this
+     * namespace". The behavior of keyedReferenceGroups is analogous to that of
+     * keyedReferences, that is, keyedReferenceGroups that have the same
+     * tModelKey value are OR’d together rather than AND’d.
+     */
     public static final String OR_LIKE_KEYS_TMODEL = "uddi:uddi.org:findqualifier:orlikekeys";
+    /**
+     * serviceSubset: this is used only with the find_business API and is used
+     * only in conjunction with a categoryBag argument. It causes the component
+     * of the search that involves categorization to use only the categoryBag
+     * elements from contained or referenced businessService elements within the
+     * registered data and ignores any entries found in the categoryBag which
+     * are not direct descendent elements of registered businessEntity elements.
+     * The resulting businessList structure contains those businesses that
+     * matched based on this modified behavior, in conjunction with any other
+     * search arguments provided. Additionally, the contained serviceInfos
+     * elements will only reflect summary data (in a serviceInfo element) for
+     * those services (contained or referenced) that matched on one of the
+     * supplied categoryBag arguments.
+     */
     public static final String SERVICE_SUBSET = "serviceSubset";
+    /**
+     * serviceSubset: this is used only with the find_business API and is used
+     * only in conjunction with a categoryBag argument. It causes the component
+     * of the search that involves categorization to use only the categoryBag
+     * elements from contained or referenced businessService elements within the
+     * registered data and ignores any entries found in the categoryBag which
+     * are not direct descendent elements of registered businessEntity elements.
+     * The resulting businessList structure contains those businesses that
+     * matched based on this modified behavior, in conjunction with any other
+     * search arguments provided. Additionally, the contained serviceInfos
+     * elements will only reflect summary data (in a serviceInfo element) for
+     * those services (contained or referenced) that matched on one of the
+     * supplied categoryBag arguments.
+     */
     public static final String SERVICE_SUBSET_TMODEL = "uddi:uddi.org:findqualifier:servicesubset";
+    /**
+     * sortByNameAsc: causes the result set returned by a find_xx or get_xx
+     * inquiry APIs to be sorted on the name field in ascending order. This sort
+     * is applied prior to any truncation of result sets. It is only applicable
+     * to queries that return a name element in the top-most detail level of the
+     * result set and if no conflicting sort qualifier is specified, this is the
+     * default sorting direction. This findQualifier takes precedence over
+     * sortByDateAsc and sortByDateDesc qualifiers, but if a sortByDateXxx
+     * findQualifier is used without a sortByNameXxx qualifier, sorting is
+     * performed based on date with or without regard to name.
+     */
     public static final String SORT_BY_NAME_ASC = "sortByNameAsc";
+    /**
+     * sortByNameAsc: causes the result set returned by a find_xx or get_xx
+     * inquiry APIs to be sorted on the name field in ascending order. This sort
+     * is applied prior to any truncation of result sets. It is only applicable
+     * to queries that return a name element in the top-most detail level of the
+     * result set and if no conflicting sort qualifier is specified, this is the
+     * default sorting direction. This findQualifier takes precedence over
+     * sortByDateAsc and sortByDateDesc qualifiers, but if a sortByDateXxx
+     * findQualifier is used without a sortByNameXxx qualifier, sorting is
+     * performed based on date with or without regard to name.
+     */
     public static final String SORT_BY_NAME_ASC_TMODEL = "uddi:uddi.org:findqualifier:sortbynameasc";
+    /**
+     * sortByNameDesc: causes the result set returned by a find_xx or get_xx
+     * inquiry call to be sorted on the name field in descending order. This
+     * sort is applied prior to any truncation of result sets. It is only
+     * applicable to queries that return a name element in the top-most detail
+     * level of the result set. This is the reverse of the default sorting
+     * direction. This findQualifier takes precedence over sortByDateAsc and
+     * sortByDateDesc qualifiers but if a sortByDateXxx findQualifier is used
+     * without a sortByNameXxx qualifier, sorting is performed based on date
+     * with or without regard to name.
+     */
     public static final String SORT_BY_NAME_DESC = "sortByNameDesc";
+    /**
+     * sortByNameDesc: causes the result set returned by a find_xx or get_xx
+     * inquiry call to be sorted on the name field in descending order. This
+     * sort is applied prior to any truncation of result sets. It is only
+     * applicable to queries that return a name element in the top-most detail
+     * level of the result set. This is the reverse of the default sorting
+     * direction. This findQualifier takes precedence over sortByDateAsc and
+     * sortByDateDesc qualifiers but if a sortByDateXxx findQualifier is used
+     * without a sortByNameXxx qualifier, sorting is performed based on date
+     * with or without regard to name.
+     */
     public static final String SORT_BY_NAME_DESC_TMODEL = "uddi:uddi.org:findqualifier:sortbynamedesc";
+    /**
+     * sortByDateAsc: causes the result set returned by a find_xx or get_xx
+     * inquiry call to be sorted based on the most recent date when each entity,
+     * or any entities they contain, were last updated, in ascending
+     * chronological order (oldest are returned first). When names are included
+     * in the result set returned, this find qualifier may also be used in
+     * conjunction with either the sortByNameAsc or sortByNameDesc
+     * findQualifiers. When so combined, the date-based sort is secondary to the
+     * name-based sort (results are sorted within name by date, oldest to
+     * newest).
+     */
     public static final String SORT_BY_DATE_ASC = "sortByDateAsc";
+    /**
+     * sortByDateAsc: causes the result set returned by a find_xx or get_xx
+     * inquiry call to be sorted based on the most recent date when each entity,
+     * or any entities they contain, were last updated, in ascending
+     * chronological order (oldest are returned first). When names are included
+     * in the result set returned, this find qualifier may also be used in
+     * conjunction with either the sortByNameAsc or sortByNameDesc
+     * findQualifiers. When so combined, the date-based sort is secondary to the
+     * name-based sort (results are sorted within name by date, oldest to
+     * newest).
+     */
     public static final String SORT_BY_DATE_ASC_TMODEL = "uddi:uddi.org:findqualifier:sortbydateasc";
+    /**
+     * sortByDateDesc: causes the result set returned by a find_xx or get_xx
+     * inquiry call to be sorted based on the most recent date when each entity,
+     * or any entities they contain, were last updated, in descending
+     * chronological order (most recently changed are returned first. When names
+     * are included in the result set returned, this find qualifier may also be
+     * used in conjunction with either the sortByNameAsc or sortByNameDesc find
+     * qualifiers. When so combined, the date-based sort is secondary to the
+     * name-based sort (results are sorted within name by date, newest to
+     * oldest).
+     */
     public static final String SORT_BY_DATE_DESC = "sortByDateDesc";
+    /**
+     * sortByDateDesc: causes the result set returned by a find_xx or get_xx
+     * inquiry call to be sorted based on the most recent date when each entity,
+     * or any entities they contain, were last updated, in descending
+     * chronological order (most recently changed are returned first. When names
+     * are included in the result set returned, this find qualifier may also be
+     * used in conjunction with either the sortByNameAsc or sortByNameDesc find
+     * qualifiers. When so combined, the date-based sort is secondary to the
+     * name-based sort (results are sorted within name by date, newest to
+     * oldest).
+     */
     public static final String SORT_BY_DATE_DESC_TMODEL = "uddi:uddi.org:findqualifier:sortbydatedesc";
+    /**
+     * suppressProjectedServices: signifies that service projections MUST NOT be
+     * returned by the find_service or find_business APIs with which this
+     * findQualifier is associated. This findQualifier is automatically enabled
+     * by default whenever find_service is used without a businessKey.
+     */
     public static final String SUPPRESS_PROJECTED_SERVICES = "suppressProjectedServices";
+    /**
+     * suppressProjectedServices: signifies that service projections MUST NOT be
+     * returned by the find_service or find_business APIs with which this
+     * findQualifier is associated. This findQualifier is automatically enabled
+     * by default whenever find_service is used without a businessKey.
+     */
     public static final String SUPPRESS_PROJECTED_SERVICES_TMODEL = "uddi:uddi.org:findqualifier:suppressprojectedservices";
+    /**
+     * UTS-10: this is used to cause sorting of results based on the Unicode
+     * Collation Algorithm on elements normalized according to Unicode
+     * Normalization Form C. When this qualifier is referenced, a sort is
+     * performed according to the Unicode Collation Element Table in conjunction
+     * with the Unicode Collation Algorithm on the name field, normalized using
+     * Unicode Normalization Form C. Support of this findQualifier by nodes is
+     * OPTIONAL.
+     */
     public static final String UTS_10 = "UTS-10";
+    /**
+     * UTS-10: this is used to cause sorting of results based on the Unicode
+     * Collation Algorithm on elements normalized according to Unicode
+     * Normalization Form C. When this qualifier is referenced, a sort is
+     * performed according to the Unicode Collation Element Table in conjunction
+     * with the Unicode Collation Algorithm on the name field, normalized using
+     * Unicode Normalization Form C. Support of this findQualifier by nodes is
+     * OPTIONAL.
+     */
     public static final String UTS_10_TMODEL = "uddi:uddi.org:sortorder:uts-10";
-    public static String CLAUSE_WHERE = "where";
-    public static String CLAUSE_GROUPBY = "group by";
-    public static String CLAUSE_ORDERBY = "order by";
-    public static String CLAUSE_HAVING = "having";
-    public static String OPERATOR_OR = "or";
-    public static String OPERATOR_AND = "and";
-    public static String PREDICATE_EQUALS = "=";
-    public static String PREDICATE_NOTEQUALS = "<>";
-    public static String PREDICATE_LIKE = "like";
-    public static String PREDICATE_IN = "in";
-    public static String PREDICATE_GREATERTHAN = ">";
-    public static String PREDICATE_LESSTHAN = "<";
-    public static String SORT_ASC = "asc";
-    public static String SORT_DESC = "desc";
+    /**
+     * This is the Wild card field used by UDDI, represents any number of
+     * characters Wildcards, when they are allowed, may occur at any position in
+     * the string of characters that constitutes the argument value and may
+     * occur more than once. Wildcards are denoted with a percent sign (%) to
+     * indicate any value for any number of characters and an underscore (_) to
+     * indicate any value for a single character. The backslash character (\) is
+     * used as an escape character for the percent sign, underscore and
+     * backslash characters. Use of the "exactMatch" findQualifier will cause
+     * wildcard characters to be interpreted literally, and as such should not
+     * also be combined with the escape character.
+     */
     public static String WILDCARD = "%";
     /**
-     * Category system consisting of namespace identifiers and the keywords
-     * associated with the namespaces.
+     * Presents any SINGLE character<br>
+     * Wildcards, when they are allowed, may occur at any position in the string
+     * of characters that constitutes the argument value and may occur more than
+     * once. Wildcards are denoted with a percent sign (%) to indicate any value
+     * for any number of characters and an underscore (_) to indicate any value
+     * for a single character. The backslash character (\) is used as an escape
+     * character for the percent sign, underscore and backslash characters. Use
+     * of the "exactMatch" findQualifier will cause wildcard characters to be
+     * interpreted literally, and as such should not also be combined with the
+     * escape character.
+     */
+    public static String WILDCARD_CHAR = "_";
+    /**
+     * unchecked: Marking a tModel with this categorization asserts that it represents a value set or category group system whose use, through keyedReferences, is not checked.
      */
     public static String TMODEL_GENERAL_KEYWORDS = "uddi:uddi.org:categorization:general_keywords";
+    /**
+     * An unchecked value set is one that allows unrestricted references to its values.  A UDDI registry is REQUIRED to have a policy to differentiate between unchecked value sets and checked value sets.  UDDI registries MUST allow unchecked value sets to be referred to in keyedReferences. tModels that represent unchecked value sets SHOULD be categorized with the unchecked value from the uddi-org:types category system.
+     */
     public static String UNCHECKED = "uddi-org:types:unchecked";
+    /**
+     * checked: Marking a tModel with this categorization asserts that it represents a value set or category group system whose use, through keyedReferences, may be checked.  Registry, and possibly node policy determines when and how a checked value set is supported.
+     */
     public static String CHECKED = "uddi-org:types:checked";
+    /**
+     * uncacheable: Marking a tModel with this categorization asserts that it represents a checked value set or category group system whose values must not be cached for validation.  The validation algorithm for a supported uncacheable checked value set must be specified and associated with the tModel marked with this categorization and may consider contextual criteria involving the entity associated with the reference.
+     */
     public static String UNCACHEABLE = "uddi-org:types:uncacheable";
     /**
      * Basic types of business relationships
      */
     public static String RELATIONSHIPS = "uddi:uddi.org:relationships";
+    /**
+     *  keyGenerator: Marking a tModel with this categorization designates it as one whose tModelKey identifies a key generator partition that can be used by its owner to derive and assign other entity keys. This categorization is reserved for key generator tModels. Any attempt to use this categorization for something other than a key generator tModel will fail with E_valueNotAllowed returned.
+     */
     public static String KEY_GENERATOR = "uddi:uddi.org:keygenerator";
     /**
      * Identifier system used to point to the UDDI entity, using UDDI keys, that

Modified: juddi/branches/juddi-3.2.x/uddi-ws/src/main/java/org/uddi/v3_service/UDDICustodyTransferPortType.java
URL: http://svn.apache.org/viewvc/juddi/branches/juddi-3.2.x/uddi-ws/src/main/java/org/uddi/v3_service/UDDICustodyTransferPortType.java?rev=1479003&r1=1479002&r2=1479003&view=diff
==============================================================================
--- juddi/branches/juddi-3.2.x/uddi-ws/src/main/java/org/uddi/v3_service/UDDICustodyTransferPortType.java (original)
+++ juddi/branches/juddi-3.2.x/uddi-ws/src/main/java/org/uddi/v3_service/UDDICustodyTransferPortType.java Fri May  3 23:23:27 2013
@@ -50,14 +50,14 @@ import org.uddi.custody_v3.TransferEntit
  * ownership of these structures from one publisher to another. Associated
  * entities of a businessEntity such as its businessService, bindingTemplate,
  * and publisherAssertion structures are transferred as part of the custody
- * transfer of the business entity.  *
- * From a custody transfer point of view, the publishers are always distinct,
- * though it may be the case that the publishers are the same person. Also, the
- * two nodes may or may not be distinct; intra-node transfer between two
- * publishers is simply a degenerate case in which node custody does not change.
- * Thus, in the case of an inter-node transfer, ownership transfer is implied.
- * In the case of an intra-node transfer the behavior results in the transfer of
- * ownership between two publishers.
+ * transfer of the business entity. * From a custody transfer point of view, the
+ * publishers are always distinct, though it may be the case that the publishers
+ * are the same person. Also, the two nodes may or may not be distinct;
+ * intra-node transfer between two publishers is simply a degenerate case in
+ * which node custody does not change. Thus, in the case of an inter-node
+ * transfer, ownership transfer is implied. In the case of an intra-node
+ * transfer the behavior results in the transfer of ownership between two
+ * publishers.
  *
  * For example, one UDDI registry, UDDI-1, MAY allow each node in UDDI-1
  * (composed of nodes 1A, 1B and 1C) to define its own policies for
@@ -166,8 +166,8 @@ import org.uddi.custody_v3.TransferEntit
  * get_transferToken and transfer_entities; in short, this constitutes the
  * Ownership Transfer API portion of this API set. The inter-node-API is
  * transfer_ custody which when combined with replication makes up the Custody
- * Transfer API portion of this API set.  *
- * The overall flow of custody and ownership transfer is as follows:
+ * Transfer API portion of this API set. * The overall flow of custody and
+ * ownership transfer is as follows:
  *
  * Publisher P1 invokes get_transferToken on N1, specifying the keys K1…Kn of
  * the entities E1…En that are to be transferred. If P1 is authorized to do this
@@ -274,8 +274,54 @@ public interface UDDICustodyTransferPort
      * Keys in the keyBag argument that do not have a corresponding token are
      * ignored.
      *
-     * @param body
-     * @throws DispositionReportFaultMessage, RemoteException
+     * @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>: This OPTIONAL argument is an
+     * element that contains an authentication token.&nbsp; Authentication
+     * tokens are obtained using the get_authToken API call or through some
+     * other means external to this specification, and represent the identity of
+     * the publisher at a UDDI 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>transferToken</i></b>: This is a known transferToken
+     * obtained by a publisher at the node where the get_transferToken API was
+     * invoked.</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
+     * either with businessEntity or tModel entities owned by the publisher that
+     * were to be transferred to some other publisher and/or node in the
+     * registry as the result of invocation of get_transferToken.&nbsp; At least
+     * one businessKey or tModelKey must be provided in a keyBag.</p>
+     * @return Upon successful completion, an empty message is returned. See
+     * section 4.8 Success and Error Reporting.
+     *
+     * No error will be reported if the transferToken provided in the call does
+     * not match an existing token. No error will be reported if a token is not
+     * found for a particular key in the keyBag.
+     * @throws DispositionReportFaultMessage
+     * @throws 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="#_Ref8979716
+     * ">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><span
+     * style="font-size:7.0pt;font-family: &quot;Times New
+     * Roman&quot;">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
+     * </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.&nbsp; The key and element
+     * or attribute that caused the problem SHOULD be clearly indicated in the
+     * error text.</p>
      */
     @WebMethod(operationName = "discard_transferToken", action = "discard_transferToken")
     @SOAPBinding(parameterStyle = SOAPBinding.ParameterStyle.BARE)
@@ -284,14 +330,74 @@ public interface UDDICustodyTransferPort
             throws DispositionReportFaultMessage, RemoteException;
 
     /**
+     * The get_transferToken API is a client API used to initiate the transfer
+     * of custody of one or more businessEntity or tModel entities from one node
+     * to another. As previously stated, the two nodes may or may not be
+     * distinct; intra-node transfer between two publishers is simply a
+     * degenerate case in which node custody does not change. No actual transfer
+     * takes place with the invocation of this API. Instead, this API obtains
+     * permission from the custodial node, in the form of a transferToken, to
+     * perform the transfer. The publisher who will be recipient of the
+     * transferToken returned by this API must invoke the transfer_entities API
+     * on the target custodial node to actually transfer the entities.
      *
-     * @param authInfo
-     * @param keyBag
-     * @param nodeID
-     * @param expirationTime
-     * @param opaqueToken
+     * @param authInfo · authInfo: This OPTIONAL argument is an element that
+     * contains an authentication token. Authentication tokens are obtained
+     * using the get_authToken API call or through some other means external to
+     * this specification and represent the identity of the publisher at a UDDI
+     * node.
+     * @param keyBag keyBag: One or more key (of type uddi:uddiKey) associated
+     * either with businessEntity or tModel entities owned by the publisher that
+     * are to be transferred to some other publisher and/or node in the
+     * registry. At least one businessKey or tModelKey must be provided.
+     * @param nodeID this is a return value. The transfer token consists of a
+     * nodeID, an expirationTime and an opaqueToken. The nodeID is used during
+     * the transfer_entities API by the recipient node to confirm with the
+     * relinquishing custodial node that the custody transfer is authorized and
+     * still valid. The nodeID of the transferToken is the value of the nodeID
+     * element of the Replication Configuration Structure. Refer to Section
+     * 7.5.2 Configuration of a UDDI Node – operator Element.
+     * @param expirationTime this is a return value. The expirationTime, defined
+     * as xsd:dateTime, represents the time at which the transfer token is no
+     * longer valid.
+     * @param opaqueToken this is a return value. The opaqueToken is only
+     * meaningful to the node that issues it. The opaqueToken is defined as
+     * xsd:base64Binary to allow for a RECOMMENDED encryption of the token under
+     * the relinquishing custody node’s own encryption key.
      * @throws DispositionReportFaultMessage
-     * @throws RemoteException
+     * @throws 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="#_Ref8979716
+     * ">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_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.&nbsp; The key and element
+     * or attribute that caused the problem SHOULD be clearly indicated in the
+     * error text.</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_tokenAlreadyExists</b>: signifies that one or more of
+     * the businessKey or tModelKey elements that identify entities to be
+     * transferred are associated with a transferToken that is still valid and
+     * has not been discarded, used or expired.&nbsp; The error text SHOULD
+     * clearly indicate which entity keys caused the error.</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_userMismatch</b>: signifies that one or more of the
+     * businessKey or tModelKey elements that identify entities to be
+     * transferred are not owned by the publisher identified by the
+     * <i>authInfo</i> element.&nbsp; The error text SHOULD clearly indicate
+     * which entity keys caused the error</p>
      */
     @WebMethod(operationName = "get_transferToken", action = "get_transferToken")
     @RequestWrapper(localName = "get_transferToken", targetNamespace = "urn:uddi-org:custody_v3", className = "org.uddi.custody_v3.GetTransferToken")
@@ -328,7 +434,88 @@ public interface UDDICustodyTransferPort
      * 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.
-     * @throws DispositionReportFaultMessage, RemoteException
+     * @return <p class="MsoBodyText">The target node responds to this API by
+     * performing the transfer operation.&nbsp; This operation is comprised of
+     * four steps:</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>Verification that the entity keys are valid.</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>Verification that ownership of the entities by the
+     * recipient publisher is allowed and would not violate any policies at the
+     * target node related to publisher limits.</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>Verification with the custodial node that the transfer of
+     * the designated entities is allowed.&nbsp; This is accomplished by
+     * invoking transfer_custody on the custodial node that is identified by the
+     * nodeID element in the transferToken.&nbsp; Any errors returned by the
+     * custodial node cause this API to fail and are propagated to the
+     * caller.</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>Changing custody and ownership of the designated entities
+     * and entering these changes into the replication stream.</p>
+     *
+     * <p class="MsoBodyText">Upon successful completion, an empty message is
+     * returned indicating the success of the transfer operation. In the case of
+     * an inter-node custody transfer, while the transfer is in process, the
+     * entities being transferred are not available for modification. To
+     * determine the state of the data, UDDI clients can use the
+     * get_operationalInfo API to determine when custody and ownership transfer
+     * has taken place. A change in the nodeID of the operationalInfo provides
+     * such an indication.</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="#_Ref8979732 ">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_accountLimitExceeded</b>: signifies that the target
+     * node has determined that the transfer of custody of the identified
+     * entities would result in the target publisher exceeding policy limits for
+     * the number of owned entities.&nbsp; The error text SHOULD clearly
+     * indicate which entities cause the publishers limits to be exceeded. It is
+     * possible for a publisher to come into possession of more data than the
+     * target node’s policy allows. The condition and node behavior under these
+     * circumstances are described in Section <a href="#_Ref11680087
+     * ">5.4.3</a><i>Transfer Execution.</i></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_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.&nbsp; The key and element
+     * or attribute that caused the problem SHOULD be clearly indicated in the
+     * error text.</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 target node or the
+     * custodial node.&nbsp; Reasons for rejection include expiration of the
+     * transferToken, use of an invalid 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.</p>
+     *
+     * <span
+     * style="font-size:10.0pt;font-family:Arial;letter-spacing:-.25pt"></span>
      */
     @WebMethod(operationName = "transfer_entities", action = "transfer_entities")
     @SOAPBinding(parameterStyle = SOAPBinding.ParameterStyle.BARE)



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


Mime
View raw message