org.apache.ws.scout.registry

Interface IRegistry

All Superinterfaces:

IRegistryBase

All Known Implementing Classes:

RegistryImpl

public interface IRegistry
extends IRegistryBase

IRegistry interface.

Only the functions that scout relies on, are in this interface.

Borrowed from jUDDI.

Author:

Tom Cunningham

Method Summary

Methods

Modifier and Type	Method and Description
DispositionReport	deleteBinding(String authInfo, String[] bindingKeyArray) "Used to remove an existing bindingTemplate from the bindingTemplates collection that is part of a specified businessService structure."
DispositionReport	deleteBusiness(String authInfo, String[] businessKeyArray) "Used to delete registered businessEntity information from the registry."
DispositionReport	deletePublisherAssertions(String authInfo, PublisherAssertion[] assertionArray)
DispositionReport	deleteService(String authInfo, String[] serviceKeyArray) "Used to delete an existing businessService from the businessServices collection that is part of a specified businessEntity."
DispositionReport	deleteTModel(String authInfo, String[] tModelKeyArray) "Used to delete registered information about a tModel.
BindingDetail	findBinding(String serviceKey, CategoryBag categoryBag, TModelBag tModelBag, FindQualifiers findQualifiers, int maxRows) "Used to locate specific bindings within a registered businessService.
BusinessList	findBusiness(Name[] nameArray, DiscoveryURLs discoveryURLs, IdentifierBag identifierBag, CategoryBag categoryBag, TModelBag tModelBag, FindQualifiers findQualifiers, int maxRows) Used to locate information about one or more businesses.
ServiceList	findService(String businessKey, Name[] nameArray, CategoryBag categoryBag, TModelBag tModelBag, FindQualifiers findQualifiers, int maxRows) "Used to locate specific services within a registered businessEntity.
TModelList	findTModel(String name, CategoryBag categoryBag, IdentifierBag identifierBag, FindQualifiers findQualifiers, int maxRows) "Used to locate one or more tModel information structures.
AssertionStatusReport	getAssertionStatusReport(String authInfo, String completionStatus)
AuthToken	getAuthToken(String userID, String cred) "Used to request an authentication token from an Operator Site.
BusinessDetail	getBusinessDetail(String businessKey) "Used to get the full businessEntity information for one or more businesses.
BusinessDetail	getBusinessDetail(String[] businessKeyVector) "Used to get the full businessEntity information for one or more businesses.
URI	getInquiryURI()
PublisherAssertions	getPublisherAssertions(String authInfo)
URI	getPublishURI()
RegisteredInfo	getRegisteredInfo(String authInfo)
ServiceDetail	getServiceDetail(String serviceKey) "Used to get full details for a given set of registered businessService data.
ServiceDetail	getServiceDetail(String[] serviceKeyArray) "Used to get full details for a given set of registered businessService data.
TModelDetail	getTModelDetail(String tModelKey) "Used to get full details for a given set of registered tModel data.
TModelDetail	getTModelDetail(String[] tModelKeyArray) "Used to get full details for a given set of registered tModel data.
Transport	getTransport()
BindingDetail	saveBinding(String authInfo, BindingTemplate[] bindingArray) "Used to register new bindingTemplate information or update existing bindingTemplate information.
BusinessDetail	saveBusiness(String authInfo, BusinessEntity[] businessArray) "Used to register new businessEntity information or update existing businessEntity information.
ServiceDetail	saveService(String authInfo, BusinessService[] serviceArray) "Used to register or update complete information about a businessService exposed by a specified businessEntity."
TModelDetail	saveTModel(String authInfo, TModel[] tModelArray) "Used to register or update complete information about a tModel."
void	setInquiryURI(URI uri)
PublisherAssertions	setPublisherAssertions(String authInfo, PublisherAssertion[] assertionArray)
void	setPublishURI(URI uri)
void	setTransport(Transport transport)

Methods inherited from interface org.apache.ws.scout.registry.IRegistryBase

execute, getSecurityURI, setSecurityURI

Method Detail

getInquiryURI

URI getInquiryURI()

Specified by:

getInquiryURI in interface IRegistryBase

Returns:

Returns the inquiryURL.

setInquiryURI

void setInquiryURI(URI uri)

Specified by:

setInquiryURI in interface IRegistryBase

Parameters:

uri - The inquiry uri to set.

getPublishURI

URI getPublishURI()

Specified by:

getPublishURI in interface IRegistryBase

Returns:

Returns the publishURL.

setPublishURI

void setPublishURI(URI uri)

Specified by:

setPublishURI in interface IRegistryBase

Parameters:

uri - The publish uri to set.

getTransport

Transport getTransport()

Specified by:

getTransport in interface IRegistryBase

Returns:

Returns the transport.

setTransport

void setTransport(Transport transport)

Specified by:

setTransport in interface IRegistryBase

Parameters:

transport - The transport to set.

setPublisherAssertions

PublisherAssertions setPublisherAssertions(String authInfo,
                                         PublisherAssertion[] assertionArray)
                                           throws RegistryException

Throws:

RegistryException;

RegistryException

saveService

ServiceDetail saveService(String authInfo,
                        BusinessService[] serviceArray)
                          throws RegistryException

"Used to register or update complete information about a businessService exposed by a specified businessEntity."

Throws:

RegistryException;

RegistryException

saveBinding

BindingDetail saveBinding(String authInfo,
                        BindingTemplate[] bindingArray)
                          throws RegistryException

"Used to register new bindingTemplate information or update existing bindingTemplate information. Use this to control information about technical capabilities exposed by a registered business."

Throws:

RegistryException;

RegistryException

saveBusiness

BusinessDetail saveBusiness(String authInfo,
                          BusinessEntity[] businessArray)
                            throws RegistryException

"Used to register new businessEntity information or update existing businessEntity information. Use this to control the overall information about the entire business. Of the save_x APIs this one has the broadest effect."

Throws:

RegistryException;

RegistryException

saveTModel

TModelDetail saveTModel(String authInfo,
                      TModel[] tModelArray)
                        throws RegistryException

"Used to register or update complete information about a tModel."

Throws:

RegistryException;

RegistryException

deleteBinding

DispositionReport deleteBinding(String authInfo,
                              String[] bindingKeyArray)
                                throws RegistryException

"Used to remove an existing bindingTemplate from the bindingTemplates collection that is part of a specified businessService structure."

Throws:

RegistryException;

RegistryException

deleteBusiness

DispositionReport deleteBusiness(String authInfo,
                               String[] businessKeyArray)
                                 throws RegistryException

"Used to delete registered businessEntity information from the registry."

Throws:

RegistryException;

RegistryException

deleteService

DispositionReport deleteService(String authInfo,
                              String[] serviceKeyArray)
                                throws RegistryException

"Used to delete an existing businessService from the businessServices collection that is part of a specified businessEntity."

Throws:

RegistryException;

RegistryException

deleteTModel

DispositionReport deleteTModel(String authInfo,
                             String[] tModelKeyArray)
                               throws RegistryException

"Used to delete registered information about a tModel. If there are any references to a tModel when this call is made, the tModel will be marked deleted instead of being physically removed."

Throws:

RegistryException;

RegistryException

getAssertionStatusReport

AssertionStatusReport getAssertionStatusReport(String authInfo,
                                             String completionStatus)
                                               throws RegistryException

Throws:

RegistryException;

RegistryException

deletePublisherAssertions

DispositionReport deletePublisherAssertions(String authInfo,
                                          PublisherAssertion[] assertionArray)
                                            throws RegistryException

Throws:

RegistryException;

RegistryException

getAuthToken

AuthToken getAuthToken(String userID,
                     String cred)
                       throws RegistryException

"Used to request an authentication token from an Operator Site. Authentication tokens are required to use all other APIs defined in the publishers API. This server serves as the program's equivalent of a login request."

Throws:

RegistryException;

RegistryException

findBusiness

BusinessList findBusiness(Name[] nameArray,
                        DiscoveryURLs discoveryURLs,
                        IdentifierBag identifierBag,
                        CategoryBag categoryBag,
                        TModelBag tModelBag,
                        FindQualifiers findQualifiers,
                        int maxRows)
                          throws RegistryException

Used to locate information about one or more businesses. Returns a businessList message that matches the conditions specified.

Throws:

RegistryException;

RegistryException

getBusinessDetail

BusinessDetail getBusinessDetail(String businessKey)
                                 throws RegistryException

"Used to get the full businessEntity information for one or more businesses. Returns a businessDetail message."

Throws:

RegistryException;

RegistryException

getBusinessDetail

BusinessDetail getBusinessDetail(String[] businessKeyVector)
                                 throws RegistryException

"Used to get the full businessEntity information for one or more businesses. Returns a businessDetail message."

Throws:

RegistryException;

RegistryException

getPublisherAssertions

PublisherAssertions getPublisherAssertions(String authInfo)
                                           throws RegistryException

Throws:

RegistryException;

RegistryException

getRegisteredInfo

RegisteredInfo getRegisteredInfo(String authInfo)
                                 throws RegistryException

Throws:

RegistryException;

RegistryException

findTModel

TModelList findTModel(String name,
                    CategoryBag categoryBag,
                    IdentifierBag identifierBag,
                    FindQualifiers findQualifiers,
                    int maxRows)
                      throws RegistryException

"Used to locate one or more tModel information structures. Returns a tModelList structure."

Throws:

RegistryException;

RegistryException

findBinding

BindingDetail findBinding(String serviceKey,
                        CategoryBag categoryBag,
                        TModelBag tModelBag,
                        FindQualifiers findQualifiers,
                        int maxRows)
                          throws RegistryException

"Used to locate specific bindings within a registered businessService. Returns a bindingDetail message."

Throws:

RegistryException

findService

ServiceList findService(String businessKey,
                      Name[] nameArray,
                      CategoryBag categoryBag,
                      TModelBag tModelBag,
                      FindQualifiers findQualifiers,
                      int maxRows)
                        throws RegistryException

"Used to locate specific services within a registered businessEntity. Return a serviceList message." From the XML spec (API, p18) it appears that the name, categoryBag, and tModelBag arguments are mutually exclusive.

Throws:

RegistryException;

RegistryException

getTModelDetail

TModelDetail getTModelDetail(String tModelKey)
                             throws RegistryException

"Used to get full details for a given set of registered tModel data. Returns a tModelDetail message."

Throws:

RegistryException;

RegistryException

getTModelDetail

TModelDetail getTModelDetail(String[] tModelKeyArray)
                             throws RegistryException

"Used to get full details for a given set of registered tModel data. Returns a tModelDetail message."

Throws:

RegistryException;

RegistryException

getServiceDetail

ServiceDetail getServiceDetail(String serviceKey)
                               throws RegistryException

"Used to get full details for a given set of registered businessService data. Returns a serviceDetail message."

Throws:

RegistryException;

RegistryException

getServiceDetail

ServiceDetail getServiceDetail(String[] serviceKeyArray)
                               throws RegistryException

"Used to get full details for a given set of registered businessService data. Returns a serviceDetail message."

Throws:

RegistryException;

RegistryException