| org.cougaar.yp.YPProxy
All known Subclasses: org.cougaar.yp.YPProxyImpl,
| YPProxy | | public interface YPProxy (Code) | | This is the primary mechanism for constructing and executing YP queries.
The interface is essentially a clone of the UDDI4J UDDIProxy API
except that it takes the approach of asynchronous operations rather
than synchronous operations.
|
| Inner Class :public class SearchMode | |
| Method Summary | |
| YPFuture | add_publisherAssertions(String authInfo, PublisherAssertion publisherAssertion)
The add_publisherAssertions message is used to add relationship assertions to the
existing set of assertions.
Parameters:
authInfo - Contains an authentication token. | | YPFuture | add_publisherAssertions(String authInfo, Vector publisherAssertion)
The add_publisherAssertions message is used to add relationship assertions to the
existing set of assertions.
Parameters:
authInfo - Contains an authentication token. | | YPFuture | delete_binding(String authInfo, String bindingKey)
The delete_binding message causes one or more bindingTemplate to be deleted.
Parameters:
authInfo - Contains an authentication token. | | YPFuture | delete_binding(String authInfo, Vector bindingKeyStrings)
The delete_binding message causes one or more bindingTemplate to be deleted.
Parameters:
authInfo - Contains an authentication token. | | YPFuture | delete_business(String authInfo, String businessKey)
The delete_business message is used to remove one or more
businessEntity structures.
Parameters:
authInfo - Contains an authentication token. | | YPFuture | delete_business(String authInfo, Vector businessKeyStrings)
The delete_business message is used to remove one or more
businessEntity structures.
Parameters:
authInfo - Contains an authentication token. | | YPFuture | delete_publisherAssertions(String authInfo, PublisherAssertion publisherAssertion)
The delete_publisherAssertions message is used to delete specific publisher assertions
from the assertion collection controlled by a particular publisher account. | | YPFuture | delete_publisherAssertions(String authInfo, Vector publisherAssertion)
The delete_publisherAssertions message is used to delete specific publisher assertions
from the assertion collection controlled by a particular publisher account. | | YPFuture | delete_service(String authInfo, String serviceKey)
The delete_service message is used to remove one or more
businessService structures.
Parameters:
authInfo - Contains an authentication token. | | YPFuture | delete_service(String authInfo, Vector serviceKeyStrings)
The delete_service message is used to remove one or more
businessService structures.
Parameters:
authInfo - Contains an authentication token. | | YPFuture | delete_tModel(String authInfo, String tModelKey)
The delete_tModel message is used to remove or retire one or more
tModel structures.
Parameters:
authInfo - Contains an authentication token. | | YPFuture | delete_tModel(String authInfo, Vector tModelKeyStrings)
The delete_tModel message is used to remove or retire one or more
tModel structures.
Parameters:
authInfo - Contains an authentication token. | | YPFuture | discard_authToken(String authInfo)
The discard_authToken message is used to inform an Operator Site that the
authentication token can be discarded. | | YPFuture | discard_authToken(AuthInfo authInfo)
The discard_authToken message is used to inform an Operator Site that the
authentication token can be discarded. | | YPFuture | execute(YPFuture pendingQuery)
| | YPFuture | find_binding(FindQualifiers findQualifiers, String serviceKey, TModelBag tModelBag, int maxRows)
The find_binding method returns a bindingDetail message that contains
a bindingTemplates structure with zero or more bindingTemplate structures
matching the criteria specified in the argument list.
Parameters:
findQualifiers - This collection of findQualifier elements can be used to alter the defaultbehavior of search functionality.
Parameters:
serviceKey - Used to specify a particular instance of a businessService elementin the registered data. | | YPFuture | find_business(Vector names, DiscoveryURLs discoveryURLs, IdentifierBag identifierBag, CategoryBag categoryBag, TModelBag tModelBag, FindQualifiers findQualifiers, int maxRows)
The find_business message returns a businessList message that matches
the conditions specified in the arguments.
Parameters:
names - vector of Name objects .
Parameters:
discoveryURLs - This is a list of URL's to be matched against the data associatedwith the discoveryURL's contents of registered businessEntity information.To search for URL without regard to useType attribute values, passthe useType component of the discoveryURL elements as empty attributes.If useType values are included, then the match will be made only onregistered information that match both the useType and URL value.The returned businessList contains businessInfo structures matchingany of the URL's passed (logical OR).
Parameters:
identifierBag - This is a list of business identifier references. | | YPFuture | find_relatedBusinesses(String businessKey, KeyedReference keyedReference, FindQualifiers findQualifiers, int maxRows)
The find_relatedBusinesses API call is used to locate information about businessEntity
registrations that are related to a specific business entity whose key is passed in the
inquiry. | | YPFuture | find_service(String businessKey, Vector names, CategoryBag categoryBag, TModelBag tModelBag, FindQualifiers findQualifiers, int maxRows)
This function returns a YPFuture wrapping a serviceList on success. | | YPFuture | find_tModel(String name, CategoryBag categoryBag, IdentifierBag identifierBag, FindQualifiers findQualifiers, int maxRows)
This find_tModel message is for locating a list of tModel entries
that match a set of specific criteria. | | public int | getSearchMode()
Describes the search mode used to find YPServers -
NO_SEARCH - YPProxy does not use the community structure to
find the YPServer.
HIERARCHICAL_COMMUNITY_SEARCH - Query progresses
up the community structure of YP servers until either a match is found or
search has reached the topmost community. | | YPFuture | get_assertionStatusReport(String authInfo, String completionStatus)
The get_assertionStatusReport message is used to request a status
report containing publisher assertions and status information. | | YPFuture | get_assertionStatusReport(String authInfo, CompletionStatus completionStatus)
The get_assertionStatusReport message is used to request a status
report containing publisher assertions and status information. | | YPFuture | get_authToken(String userid, String cred)
The get_authToken message is used to obtain an authentication token.
Authentication tokens are opaque values that are required for all
other publisher API calls. | | YPFuture | get_bindingDetail(String bindingKey)
The get_bindingDetail message is for requesting the run-time
bindingTemplate information location information for the purpose of
invoking a registered business API.
Parameters:
bindingKey - uuid_key string that represent specific instanceof known bindingTemplate data. | | YPFuture | get_bindingDetail(Vector bindingKeyStrings)
The get_bindingDetail message is for requesting the run-time
bindingTemplate information location information for the purpose of
invoking a registered business API.
Parameters:
bindingKeyStrings - Vector of uuid_key strings that represent specific instancesof known bindingTemplate data. | | YPFuture | get_businessDetail(String businessKey)
The get_businessDetail message returns complete businessEntity information
for one or more specified businessEntitys
Parameters:
businessKey - A uuid_key string that represents a specific instance of knownbusinessEntity data. | | YPFuture | get_businessDetail(Vector businessKeyStrings)
The get_businessDetail message returns complete businessEntity information
for one or more specified businessEntitys
Parameters:
businessKeyStrings - Vector of uuid_key strings that represent specific instances of knownbusinessEntity data. | | YPFuture | get_businessDetailExt(String businessKey)
The get_businessDetailExt message returns extended businessEntity
information for one or more specified businessEntitys. | | YPFuture | get_businessDetailExt(Vector businessKeyStrings)
The get_businessDetailExt message returns extended businessEntity
information for one or more specified businessEntitys. | | YPFuture | get_publisherAssertions(String authInfo)
The get_publisherAssertions message is used to get a list of active
publisher assertions that are controlled by an individual publisher account.
Parameters:
authInfo - Contains an authentication token. | | YPFuture | get_registeredInfo(String authInfo)
The get_registeredInfo message is used to get an abbreviated list
of all businessEntity keys and tModel keys that are controlled by
the individual associated the credentials passed.
Parameters:
authInfo - Contains an authentication token. | | YPFuture | get_serviceDetail(String serviceKey)
The get_serviceDetail message is used to request full information
about a known businessService structure.
Parameters:
serviceKey - A uuid_key string that represents a specific instance ofknown businessService data. | | YPFuture | get_serviceDetail(Vector serviceKeyStrings)
The get_serviceDetail message is used to request full information
about a known businessService structure.
Parameters:
serviceKeyStrings - A vector of uuid_key strings that represent specific instances ofknown businessService data. | | YPFuture | get_tModelDetail(String tModelKey)
The get_tModelDetail message is used to request full information
about a known tModel structure.
Parameters:
tModelKey - A URN qualified uuid_key string that represent a specificinstance of known tModel data. | | YPFuture | get_tModelDetail(Vector tModelKeyStrings)
The get_tModelDetail message is used to request full information
about a known tModel structure.
Parameters:
tModelKeyStrings - A Vector of URN qualified uuid_key strings that represent specificinstances of known tModel data. | | YPFuture | save_binding(String authInfo, Vector bindingTemplates)
The save_binding message is used to save or update a complete
bindingTemplate structure. | | YPFuture | save_business(String authInfo, Vector businessEntities)
The save_business message is used to save or update information about a
complete businessEntity structure. | | YPFuture | save_service(String authInfo, Vector businessServices)
The save_service message adds or updates one or more businessService
structures.
Parameters:
authInfo - Contains an authentication token. | | YPFuture | save_tModel(String authInfo, Vector tModels)
The save_tModel message adds or updates one or more tModel structures.
Parameters:
authInfo - Contains an authentication token. | | YPFuture | send(UDDIElement el, boolean inquiry)
Sends a UDDIElement to either the inquiry or publish URL. | | YPFuture | send(Element el, boolean inquiry)
Sends an XML DOM tree indentified by the given element to either the
inquiry or publish URL. | | YPFuture | set_publisherAssertions(String authInfo, PublisherAssertion pub)
The set_publisherAssertions message is used to save the complete set of publisher
assertions for an individual publisher account. | | YPFuture | set_publisherAssertions(String authInfo, Vector publisherAssertion)
The set_publisherAssertions message is used to save the complete set of publisher
assertions for an individual publisher account. | | YPFuture | validate_values_businessEntity(Vector businessEntity)
A UDDI operator sends the validate_values message to the appropriate external service, whenever a
publisher saves data that uses a categorization value or identifier whose use is regulated by the
external party who controls that service. | | YPFuture | validate_values_businessService(Vector businessService)
A UDDI operator sends the validate_values message to the appropriate external service, whenever a
publisher saves data that uses a categorization value or identifier whose use is regulated by the
external party who controls that service. | | YPFuture | validate_values_tModel(Vector tModel)
A UDDI operator sends the validate_values message to the appropriate external service, whenever a
publisher saves data that uses a categorization value or identifier whose use is regulated by the
external party who controls that service. |
| DEFAULT_UDDI_PASSWORD | | final public static String DEFAULT_UDDI_PASSWORD(Code) | | |
| DEFAULT_UDDI_USERNAME | | final public static String DEFAULT_UDDI_USERNAME(Code) | | |
| add_publisherAssertions | | YPFuture add_publisherAssertions(String authInfo, PublisherAssertion publisherAssertion)(Code) | | The add_publisherAssertions message is used to add relationship assertions to the
existing set of assertions.
Parameters:
authInfo - Contains an authentication token. Authentication tokens are obtainedusing the get_authToken method.
Parameters:
publisherAssertion - Contains a relationship assertion. This function returns a YPFuture wrapping a DispositionReport with a single success indicator. |
| add_publisherAssertions | | YPFuture add_publisherAssertions(String authInfo, Vector publisherAssertion)(Code) | | The add_publisherAssertions message is used to add relationship assertions to the
existing set of assertions.
Parameters:
authInfo - Contains an authentication token. Authentication tokens are obtainedusing the get_authToken method.
Parameters:
publisherAssertion - Vector of publisherAssertion object. Each publisherAssertioncontains a relationship assertion. This function returns a YPFuture wrapping a DispositionReport with a single success indicator. |
| delete_binding | | YPFuture delete_binding(String authInfo, String bindingKey)(Code) | | The delete_binding message causes one or more bindingTemplate to be deleted.
Parameters:
authInfo - Contains an authentication token. Authentication tokens are obtainedusing the get_authToken method.
Parameters:
bindingKey - A uuid_key value that represents a specific instance ofknown bindingTemplate data. Upon successful completion, a dispositionReport is returned with asingle success indicator. |
| delete_binding | | YPFuture delete_binding(String authInfo, Vector bindingKeyStrings)(Code) | | The delete_binding message causes one or more bindingTemplate to be deleted.
Parameters:
authInfo - Contains an authentication token. Authentication tokens are obtainedusing the get_authToken method.
Parameters:
bindingKeyStrings - A vector of uuid_key strings that represents specific instances ofknown bindingTemplate data. Upon successful completion, a dispositionReport is returned with asingle success indicator |
| delete_business | | YPFuture delete_business(String authInfo, String businessKey)(Code) | | The delete_business message is used to remove one or more
businessEntity structures.
Parameters:
authInfo - Contains an authentication token. Authentication tokens are obtainedusing the get_authToken method.
Parameters:
businessKey - Uuid_key string that represents specific instance of knownbusinessEntity data. Upon successful completion, a dispositionReport is returned with asingle success indicator |
| delete_business | | YPFuture delete_business(String authInfo, Vector businessKeyStrings)(Code) | | The delete_business message is used to remove one or more
businessEntity structures.
Parameters:
authInfo - Contains an authentication token. Authentication tokens are obtainedusing the get_authToken method.
Parameters:
businessKeyStrings - Vector of uuid_key strings that represent specific instances of knownbusinessEntity data. Upon successful completion, a dispositionReport is returned with asingle success indicator |
| delete_publisherAssertions | | YPFuture delete_publisherAssertions(String authInfo, PublisherAssertion publisherAssertion) throws UDDIException(Code) | | The delete_publisherAssertions message is used to delete specific publisher assertions
from the assertion collection controlled by a particular publisher account. Deleting assertions from
the assertion collection will affect the visibility of business relationships. Deleting an assertion
will cause any relationships based on that assertion to be invalidated.
Parameters:
authInfo - Contains an authentication token. Authentication tokens are obtainedusing the get_authToken method.
Parameters:
publisherAssertion - Contains a relationship assertion. Upon successful completion, a dispositionReport is returned with asingle success indicator |
| delete_publisherAssertions | | YPFuture delete_publisherAssertions(String authInfo, Vector publisherAssertion) throws UDDIException(Code) | | The delete_publisherAssertions message is used to delete specific publisher assertions
from the assertion collection controlled by a particular publisher account. Deleting assertions from
the assertion collection will affect the visibility of business relationships. Deleting an assertion
will cause any relationships based on that assertion to be invalidated.
Parameters:
authInfo - Contains an authentication token. Authentication tokens are obtainedusing the get_authToken method.
Parameters:
publisherAssertion - Is a vector of publisherAssertion values. Each publisherAssertioncontains a relationship assertion. Upon successful completion, a dispositionReport is returned with asingle success indicator |
| delete_service | | YPFuture delete_service(String authInfo, String serviceKey)(Code) | | The delete_service message is used to remove one or more
businessService structures.
Parameters:
authInfo - Contains an authentication token. Authentication tokens are obtainedusing the get_authToken method.
Parameters:
serviceKey - uuid_key string that represents specific instance of knownbusinessService data. Upon successful completion, a dispositionReport is returned with asingle success indicator |
| delete_service | | YPFuture delete_service(String authInfo, Vector serviceKeyStrings)(Code) | | The delete_service message is used to remove one or more
businessService structures.
Parameters:
authInfo - Contains an authentication token. Authentication tokens are obtainedusing the get_authToken method.
Parameters:
serviceKeyStrings - Vector of uuid_key strings that represent specific instances of knownbusinessService data. Upon successful completion, a dispositionReport is returned with asingle success indicator |
| delete_tModel | | YPFuture delete_tModel(String authInfo, String tModelKey)(Code) | | The delete_tModel message is used to remove or retire one or more
tModel structures.
Parameters:
authInfo - Contains an authentication token. Authentication tokens are obtainedusing the get_authToken method.
Parameters:
tModelKey - uuid_key string that represents specific instance of knowntModel data. Upon successful completion, a dispositionReport is returned with asingle success indicator |
| delete_tModel | | YPFuture delete_tModel(String authInfo, Vector tModelKeyStrings)(Code) | | The delete_tModel message is used to remove or retire one or more
tModel structures.
Parameters:
authInfo - Contains an authentication token. Authentication tokens are obtainedusing the get_authToken method.
Parameters:
tModelKeyStrings - Vector of uuid_key strings that represent specific instances of knowntModel data. Upon successful completion, a dispositionReport is returned with asingle success indicator |
| discard_authToken | | YPFuture discard_authToken(String authInfo)(Code) | | The discard_authToken message is used to inform an Operator Site that the
authentication token can be discarded. Subsequent calls that use the
same authToken may be rejected. This message is optional for Operator
Sites that do not manage session state or that do not support the
get_authToken message.
Parameters:
authInfo - Contains an String authentication token. Authentication tokens are obtainedusing the get_authToken method. Upon successful completion, a dispositionReport is returned with asingle success indicator. Discarding an expired authToken will beprocessed and reported as a success condition. |
| discard_authToken | | YPFuture discard_authToken(AuthInfo authInfo)(Code) | | The discard_authToken message is used to inform an Operator Site that the
authentication token can be discarded. Subsequent calls that use the
same authToken may be rejected. This message is optional for Operator
Sites that do not manage session state or that do not support the
get_authToken message.
Parameters:
authInfo - Contains an authentication token. Authentication tokens are obtainedusing the get_authToken method. Upon successful completion, a dispositionReport is returned with asingle success indicator. Discarding an expired authToken will beprocessed and reported as a success condition. |
| find_binding | | YPFuture find_binding(FindQualifiers findQualifiers, String serviceKey, TModelBag tModelBag, int maxRows)(Code) | | The find_binding method returns a bindingDetail message that contains
a bindingTemplates structure with zero or more bindingTemplate structures
matching the criteria specified in the argument list.
Parameters:
findQualifiers - This collection of findQualifier elements can be used to alter the defaultbehavior of search functionality.
Parameters:
serviceKey - Used to specify a particular instance of a businessService elementin the registered data. Only bindings in the specific businessServicedata identified by the serviceKey passed will be searched.
Parameters:
tModelBag - This is a list of tModel uuid_key values that represent the technicalfingerprint to locate in a bindingTemplate structure contained withinthe businessService instance specified by the serviceKey value. If morethan one tModel key is specified in this structure, only bindingTemplateinformation that exactly matches all of the tModel keys specified willbe returned (logical AND). The order of the keys in the tModelBag isnot relevant. All tModelKey values begin with a uuid URN qualifier(e.g. "uuid:" followed by a known tModel UUID value.
Parameters:
maxRows - This optional integer value allows the requesting program to limitthe number of results returned. This function returns a YPFuture wrapping a bindingDetail message on success. In the event that no matches werelocated for the specified criteria, the bindingDetail structure returned in the response the will beempty (e.g. contain no bindingTemplate data.)In the even of a large number of matches, an Operator Site may truncate the result set. Ifthis occurs, the response message will contain the truncated attribute with the value of this attributeset to true.Searching using tModelBag will also return any bindingTemplate information that matches due tohostingRedirector references. The resolved bindingTemplate structure will be returned, even if thatbindingTemplate is owned by a different businessService structure. |
| find_business | | YPFuture find_business(Vector names, DiscoveryURLs discoveryURLs, IdentifierBag identifierBag, CategoryBag categoryBag, TModelBag tModelBag, FindQualifiers findQualifiers, int maxRows)(Code) | | The find_business message returns a businessList message that matches
the conditions specified in the arguments.
Parameters:
names - vector of Name objects .
Parameters:
discoveryURLs - This is a list of URL's to be matched against the data associatedwith the discoveryURL's contents of registered businessEntity information.To search for URL without regard to useType attribute values, passthe useType component of the discoveryURL elements as empty attributes.If useType values are included, then the match will be made only onregistered information that match both the useType and URL value.The returned businessList contains businessInfo structures matchingany of the URL's passed (logical OR).
Parameters:
identifierBag - This is a list of business identifier references. The returned businessListcontains businessInfo structures matching any of the identifiers passed(logical OR).
Parameters:
categoryBag - This is a list of category references. The returned businessListcontains businessInfo structures matching all of the categoriespassed (logical AND).
Parameters:
tModelBag - The registered businessEntity data contains bindingTemplates that in turncontain specific tModel references. The tModelBag argument lets yousearch for businesses that have bindings that are compatible with aspecific tModel pattern. The returned businessList contains businessInfostructures that match all of the tModel keys passed (logical AND).tModelKey values must be formatted as URN qualified UUID values(e.g. prefixed with "uuid:")
Parameters:
findQualifiers - can be used to alter the default behavior of search functionality.
Parameters:
maxRows - allows the requesting program to limit the number of results returned. This function returns a YPFuture wrapping a businessList on success. In the event that nomatches were located for the specified criteria, a businessListstructure with zero businessInfo structures is returned. |
| find_relatedBusinesses | | YPFuture find_relatedBusinesses(String businessKey, KeyedReference keyedReference, FindQualifiers findQualifiers, int maxRows)(Code) | | The find_relatedBusinesses API call is used to locate information about businessEntity
registrations that are related to a specific business entity whose key is passed in the
inquiry. The Related Businesses feature is used to manage registration of business units and
subsequently relate them based on organizational hierarchies or business partner relationships.
This returns zero or more relatedBusinessInfo structures .For the businessEntity specified in the
the response reports complete business relationships with other businessEntity
registrations. Business relationships are complete between two businessEntity registrations when the
publishers controlling each of the businessEntity structures involved in the relationship set
assertions affirming that relationship.
Parameters:
businessKey - This is used to specify a particular BusinessEntity instance.
Parameters:
keyedReference - This is a single, optional keyedReference element that is used tospecify that only businesses that are related to the focal pointin a specific way should be included in the results.
Parameters:
findQualifiers - Can be used to alter the default behavior of search functionality.
Parameters:
maxRows - allows the requesting program to limit the number of results returned. This function returns a YPFuture wrapping a RelatedBusinessesList on success. |
| find_service | | YPFuture find_service(String businessKey, Vector names, CategoryBag categoryBag, TModelBag tModelBag, FindQualifiers findQualifiers, int maxRows)(Code) | | This function returns a YPFuture wrapping a serviceList on success. In the event that no
matches were located for the specified criteria, the serviceList
structure returned will contain an empty businessServices structure.
Parameters:
businessKey - This optional uuid_key is used to specify a particularBusinessEntity instance. This argument may be used tospecify an existing businessEntity in the registry ormay be specified as null or "" (empty string) to indicatethat all businessEntities are to be searched.
Parameters:
names - This optional Vector of Name objects represents one or more partial names qualifiedwith xml:lang attributes. Any businessService data contained in the specifiedbusinessEntity with a matching partial name value gets returned. A wildcard character %may be used to signify any number of any characters. Up to 5 name values may bespecified. If multiple name values are passed, the match occurs on a logical OR basiswithin any names supplied (e.g. any match on name/language pairs will cause aregistered service to be included in the final result set).
Parameters:
categoryBag - : This is a list of category references. The returned serviceList containsbusinessInfo structures matching all of the categories passed (logical AND bydefault).
Parameters:
tModelBag - This is a list of tModel uuid_key values that represent the technical fingerprint ofa bindingTemplate structure to find. Version 2.0 defines a way to associatebusinessService structures with more than one businessEntity. All bindingTemplatestructures within any businessService associated with the businessEntity specified bythe businessKey argument will be searched. If more than one tModel key is specifiedin this structure, only businessService structures that contain bindingTemplatestructures with fingerprint information that matches all of the tModel keys specifiedwill be returned (logical AND only).
Parameters:
findQualifiers - used to alter the default behavior of search functionality.
Parameters:
maxRows - allows the requesting program to limit the number of results returned. This function returns a YPFuture wrapping a serviceList on success. In the event that nomatches were located for the specified criteria, the serviceListstructure returned will contain an empty businessServices structure. |
| find_tModel | | YPFuture find_tModel(String name, CategoryBag categoryBag, IdentifierBag identifierBag, FindQualifiers findQualifiers, int maxRows)(Code) | | This find_tModel message is for locating a list of tModel entries
that match a set of specific criteria. The response will be a list
of abbreviated information about tModels that match the criteria (tModelList).
Parameters:
name - This string value represents a partial name. Since tModel data only has a single name,only a single name may be passed. A wildcard character % may be used to signify anynumber of any characters. The returned tModelList contains tModelInfo elements fortModels whose name matches the value passed (via lexical-order - i.e., leftmost inleft-to-right languages - partial match or wild card treatment).
Parameters:
categoryBag - This is a list of category references. The returned tModelList contains tModelInfoelements matching all of the categories passed (logical AND by default). FindQualifiercan be used to alter this logical AND behavior.
Parameters:
identifierBag - This is a list of business identifier references. The returned tModelListcontains tModelInfo structures matching any of the identifierspassed (logical OR).
Parameters:
findQualifiers - used to alter the default behavior of search functionality.
Parameters:
maxRows - allows the requesting program to limit the number of results returned. This function returns a YPFuture wrapping a tModelList on success. In the event that nomatches were located for the specified criteria, an empty tModelListobject will be returned (e.g. will contain zero tModelInfo objects).This signifies zero matches. |
| getSearchMode | | public int getSearchMode()(Code) | | Describes the search mode used to find YPServers -
NO_SEARCH - YPProxy does not use the community structure to
find the YPServer.
HIERARCHICAL_COMMUNITY_SEARCH - Query progresses
up the community structure of YP servers until either a match is found or
search has reached the topmost community.
SINGLE_COMMUNITY_SEARCH - Query is applied only to the
YP server in the specified YP community context.
|
| get_assertionStatusReport | | YPFuture get_assertionStatusReport(String authInfo, String completionStatus)(Code) | | The get_assertionStatusReport message is used to request a status
report containing publisher assertions and status information. This contains
all complete and incomplete assertions and serves an administrative use including
the determination if there are any outstanding, incomplete assertions about relationships
involving businesses the publisher account is associated with.
Parameters:
authInfo - Contains an authentication token. Authentication tokens are obtainedusing the get_authToken method.
Parameters:
completionStatus - This argument (String) lets the publisher restrict the result setto only those relationships that have the status value specified. Upon successful completion, an assertionStatusReport message is returnedcontaining assertion status information. |
| get_assertionStatusReport | | YPFuture get_assertionStatusReport(String authInfo, CompletionStatus completionStatus)(Code) | | The get_assertionStatusReport message is used to request a status
report containing publisher assertions and status information. This contains
all complete and incomplete assertions and serves an administrative use including
the determination if there are any outstanding, incomplete assertions about relationships
involving businesses the publisher account is associated with.
Parameters:
authInfo - Contains an authentication token. Authentication tokens are obtainedusing the get_authToken method.
Parameters:
completionStatus - This argument lets the publisher restrict the result set toonly those relationships that have the status value specified. Upon successful completion, an assertionStatusReport message is returnedcontaining assertion status information. |
| get_authToken | | YPFuture get_authToken(String userid, String cred)(Code) | | The get_authToken message is used to obtain an authentication token.
Authentication tokens are opaque values that are required for all
other publisher API calls. This message is not required for Operator
Sites that have an external mechanism defined for users to get an
authentication token. This API is provided for implementations that
do not have some other method of obtaining an authentication token or
certificate, or that choose to use userID and Password based authentication.
Parameters:
userid - user that an individual authorized user was assigned by an Operator Site.Operator Sites will each provide a way for individuals to obtain a UserIDand password that will be valid only at the given Operator Site.
Parameters:
cred - password or credential that is associated with the user. This function returns a YPFuture wrapping an authToken object that contains a validauthInfo object that can be used in subsequent calls to publisherAPI calls that require an authInfo value. |
| get_bindingDetail | | YPFuture get_bindingDetail(String bindingKey)(Code) | | The get_bindingDetail message is for requesting the run-time
bindingTemplate information location information for the purpose of
invoking a registered business API.
Parameters:
bindingKey - uuid_key string that represent specific instanceof known bindingTemplate data. This function returns a YPFuture wrapping a bindingDetail message on successful match |
| get_bindingDetail | | YPFuture get_bindingDetail(Vector bindingKeyStrings)(Code) | | The get_bindingDetail message is for requesting the run-time
bindingTemplate information location information for the purpose of
invoking a registered business API.
Parameters:
bindingKeyStrings - Vector of uuid_key strings that represent specific instancesof known bindingTemplate data. This function returns a YPFuture wrapping a bindingDetail message on successful match of oneor more bindingKey values. If multiple bindingKey values were passed, theresults will be returned in the same order as the keys passed. |
| get_businessDetail | | YPFuture get_businessDetail(String businessKey)(Code) | | The get_businessDetail message returns complete businessEntity information
for one or more specified businessEntitys
Parameters:
businessKey - A uuid_key string that represents a specific instance of knownbusinessEntity data. This function returns a YPFuture wrapping a businessDetail object on successful matchof one or more businessKey values. If multiple businessKey valueswere passed, the results will be returned in the same order as thekeys passed. |
| get_businessDetail | | YPFuture get_businessDetail(Vector businessKeyStrings)(Code) | | The get_businessDetail message returns complete businessEntity information
for one or more specified businessEntitys
Parameters:
businessKeyStrings - Vector of uuid_key strings that represent specific instances of knownbusinessEntity data. This function returns a YPFuture wrapping a businessDetail message on successful matchof one or more businessKey values. If multiple businessKey valueswere passed, the results will be returned in the same order as thekeys passed. |
| get_businessDetailExt | | YPFuture get_businessDetailExt(String businessKey)(Code) | | The get_businessDetailExt message returns extended businessEntity
information for one or more specified businessEntitys. This
message returns exactly the same information as the get_businessDetail
message, but may contain additional attributes if the source is
an external registry (not an Operator Site) that is compatible
with this API specification.
Parameters:
businessKey - A uuid_key string that represents a specific instance of knownbusinessEntity data. This function returns a YPFuture wrapping a businessDetailExt message on successful matchof one or more businessKey values. If multiple businessKey valueswere passed, the results will be returned in the same order as thekeys passed. |
| get_businessDetailExt | | YPFuture get_businessDetailExt(Vector businessKeyStrings)(Code) | | The get_businessDetailExt message returns extended businessEntity
information for one or more specified businessEntitys. This
message returns exactly the same information as the get_businessDetail
message, but may contain additional attributes if the source is
an external registry (not an Operator Site) that is compatible
with this API specification.
Parameters:
businessKeyStrings - Vector of uuid_key strings that represent specific instances of knownbusinessEntity data. This function returns a YPFuture wrapping a businessDetailExt message on successful matchof one or more businessKey values. If multiple businessKey valueswere passed, the results will be returned in the same order as thekeys passed. |
| get_publisherAssertions | | YPFuture get_publisherAssertions(String authInfo)(Code) | | The get_publisherAssertions message is used to get a list of active
publisher assertions that are controlled by an individual publisher account.
Parameters:
authInfo - Contains an authentication token. Authentication tokens are obtainedusing the get_authToken method. This function returns a YPFuture wrapping a PublisherAssertions message that contains apublisherAssertion element for each publisher assertion registered by thepublisher account associated with the authentication information. |
| get_registeredInfo | | YPFuture get_registeredInfo(String authInfo)(Code) | | The get_registeredInfo message is used to get an abbreviated list
of all businessEntity keys and tModel keys that are controlled by
the individual associated the credentials passed.
Parameters:
authInfo - Contains an authentication token. Authentication tokens are obtainedusing the get_authToken API call. The function returns a YPFuture wrapping upon successful completion, a registeredInfo object will be returned,listing abbreviated business information in one or more businessInfoobjects, and tModel information in one or more tModelInfo objects.This API is useful for determining the full extent of registeredinformation controlled by a single user in a single call. |
| get_serviceDetail | | YPFuture get_serviceDetail(String serviceKey)(Code) | | The get_serviceDetail message is used to request full information
about a known businessService structure.
Parameters:
serviceKey - A uuid_key string that represents a specific instance ofknown businessService data. This function returns a YPFuture wrapping a serviceDetail message on successful matchof one or more serviceKey values. If multiple serviceKey valueswere passed, the results will be returned in the same order as thekeys passed. |
| get_serviceDetail | | YPFuture get_serviceDetail(Vector serviceKeyStrings)(Code) | | The get_serviceDetail message is used to request full information
about a known businessService structure.
Parameters:
serviceKeyStrings - A vector of uuid_key strings that represent specific instances ofknown businessService data. This function returns a YPFuture wrapping a serviceDetail message on successful matchof one or more serviceKey values. If multiple serviceKey valueswere passed, the results will be returned in the same order as thekeys passed. |
| get_tModelDetail | | YPFuture get_tModelDetail(String tModelKey)(Code) | | The get_tModelDetail message is used to request full information
about a known tModel structure.
Parameters:
tModelKey - A URN qualified uuid_key string that represent a specificinstance of known tModel data. All tModelKey values begin with auuid URN qualifier (e.g. "uuid:" followed by a known tModel UUID value.) This function returns a YPFuture wrapping a tModelDetail message on successful matchof one or more tModelKey values. If multiple tModelKey valueswere passed, the results will be returned in the same order asthe keys passed. |
| get_tModelDetail | | YPFuture get_tModelDetail(Vector tModelKeyStrings)(Code) | | The get_tModelDetail message is used to request full information
about a known tModel structure.
Parameters:
tModelKeyStrings - A Vector of URN qualified uuid_key strings that represent specificinstances of known tModel data. All tModelKey values begin with auuid URN qualifier (e.g. "uuid:" followed by a known tModel UUID value.) This function returns a YPFuture wrapping a tModelDetail message on successful matchof one or more tModelKey values. If multiple tModelKey valueswere passed, the results will be returned in the same order asthe keys passed. |
| save_binding | | YPFuture save_binding(String authInfo, Vector bindingTemplates)(Code) | | The save_binding message is used to save or update a complete
bindingTemplate structure. This message can be used to add or
update one or more bindingTemplate structures to one or more existing
businessService structures.
Parameters:
authInfo - Contains an authentication token. Authentication tokens are obtainedusing the get_authToken method.
Parameters:
bindingTemplates - Vector of bindingTemplate objects. The order in which these areprocessed is not defined. To save a new bindingTemplate, pass abindingTemplate object with an empty bindingKey attribute value. This API returns a bindingDetail object containing the final resultsof the call that reflects the newly registered information for theeffected bindingTemplate objects. |
| save_business | | YPFuture save_business(String authInfo, Vector businessEntities)(Code) | | The save_business message is used to save or update information about a
complete businessEntity structure. This API has the broadest scope of
all of the save_x API calls in the publisher API, and can be used to make
sweeping changes to the published information for one or more
businessEntity structures controlled by an individual.
Parameters:
authInfo - Contains an authentication token. Authentication tokens are obtainedusing the get_authToken method.
Parameters:
businessEntities - Vector of businessEntity objects. These objects can be obtained in advanceby using the get_businessDetail API call or by any other means. This API returns a businessDetail message containing the final resultsof the call that reflects the new registered information for thebusinessEntity information provided. |
| save_service | | YPFuture save_service(String authInfo, Vector businessServices)(Code) | | The save_service message adds or updates one or more businessService
structures.
Parameters:
authInfo - Contains an authentication token. Authentication tokens are obtainedusing the get_authToken method.
Parameters:
businessServices - Vector of businessService objects. These objects can be obtained inadvance by using the get_serviceDetail API call or by any other means. This API returns a serviceDetail object containing the final resultsof the call that reflects the newly registered information for theeffected businessService structures. |
| save_tModel | | YPFuture save_tModel(String authInfo, Vector tModels)(Code) | | The save_tModel message adds or updates one or more tModel structures.
Parameters:
authInfo - Contains an authentication token. Authentication tokens are obtainedusing the get_authToken method.
Parameters:
tModels - Vector of complete tModel structures. If adding a new tModel,the tModelKey value should be passed as an empty element. This API returns a tModelDetail message containing the final resultsof the call that reflects the new registered information for theeffected tModel structures |
| send | | YPFuture send(UDDIElement el, boolean inquiry)(Code) | | Sends a UDDIElement to either the inquiry or publish URL.
Parameters:
el -
Parameters:
inquiry - An element representing a XML DOM tree containing the UDDI response. |
| send | | YPFuture send(Element el, boolean inquiry)(Code) | | Sends an XML DOM tree indentified by the given element to either the
inquiry or publish URL. Can be used to send an manually constructed
message to the UDDI registry.
Parameters:
el -
Parameters:
inquiry - An element representing a XML DOM tree containing the UDDI response. |
| set_publisherAssertions | | YPFuture set_publisherAssertions(String authInfo, PublisherAssertion pub)(Code) | | The set_publisherAssertions message is used to save the complete set of publisher
assertions for an individual publisher account. When this message is processed, the publisher
assertions that are active prior to this API call for a given publisher account are examined by the
UDDI registry. Any new assertions not present prior to the call are added to the assertions attributed
to the publisher. As a result, new relationships may be activated (e.g. determined to have a completed
status), and existing relationships may be deactivated.
Parameters:
authInfo - Contains an authentication token. Authentication tokens are obtainedusing the get_authToken method.
Parameters:
pub - Contains a relationship assertion. Upon successful completion, a publisherAssertions message is returned containingall of the relationship assertions currently attributed to the publisher accountthat is associated with the authInfo data passed. |
| set_publisherAssertions | | YPFuture set_publisherAssertions(String authInfo, Vector publisherAssertion)(Code) | | The set_publisherAssertions message is used to save the complete set of publisher
assertions for an individual publisher account. When this message is processed, the publisher
assertions that are active prior to this API call for a given publisher account are examined by the
UDDI registry. Any new assertions not present prior to the call are added to the assertions attributed
to the publisher. As a result, new relationships may be activated (e.g. determined to have a completed
status), and existing relationships may be deactivated.
Parameters:
authInfo - Contains an authentication token. Authentication tokens are obtainedusing the get_authToken method.
Parameters:
publisherAssertion - Is a vector of publisherAssertion object. Each publisherAssertioncontains a relationship assertion. Upon successful completion, a publisherAssertions message is returned containingall of the relationship assertions currently attributed to the publisher accountthat is associated with the authInfo data passed. |
| validate_values_businessEntity | | YPFuture validate_values_businessEntity(Vector businessEntity)(Code) | | A UDDI operator sends the validate_values message to the appropriate external service, whenever a
publisher saves data that uses a categorization value or identifier whose use is regulated by the
external party who controls that service. The normal use is to verify that specific categories or
identifiers (checking the keyValue attribute values supplied) exist within the given taxonomy or
identifier system
Parameters:
businessEntity - The vector of businessEntity structure being validated. Upon successful completion, a dispositionReport is returned with asingle success indicator. |
| validate_values_businessService | | YPFuture validate_values_businessService(Vector businessService)(Code) | | A UDDI operator sends the validate_values message to the appropriate external service, whenever a
publisher saves data that uses a categorization value or identifier whose use is regulated by the
external party who controls that service. The normal use is to verify that specific categories or
identifiers (checking the keyValue attribute values supplied) exist within the given taxonomy or
identifier system
Parameters:
businessService - The vector of business service structure being validated. Upon successful completion, a dispositionReport is returned with asingle success indicator. |
| validate_values_tModel | | YPFuture validate_values_tModel(Vector tModel)(Code) | | A UDDI operator sends the validate_values message to the appropriate external service, whenever a
publisher saves data that uses a categorization value or identifier whose use is regulated by the
external party who controls that service. The normal use is to verify that specific categories or
identifiers (checking the keyValue attribute values supplied) exist within the given taxonomy or
identifier system
Parameters:
tModel - The vector of tModel structure being validated. Upon successful completion, a dispositionReport is returned with asingle success indicator. |
|
|