com.actional.uddi.plugin

Interface IPublisher

public interface IPublisher

UDDI publisher interface.

Since:

1.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	IPublisher.IAddPolicyToServiceContext Interface of addPolicyToService(com.actional.uddi.plugin.IPublisher.IAddPolicyToServiceContext).
static interface	IPublisher.ICreateBusinessServiceContext Interface of createBusinessService(com.actional.uddi.plugin.IPublisher.ICreateBusinessServiceContext).
static interface	IPublisher.IGetBusinessServiceCategoriesContext Interface of getBusinessServiceCategories(com.actional.uddi.plugin.IPublisher.IGetBusinessServiceCategoriesContext).
static interface	IPublisher.IKeyValidationEntry Interface of getKeyValidationEntries().

Method Summary

Modifier and Type	Method and Description
void	addPolicyToService(IPublisher.IAddPolicyToServiceContext context) Publishes a tModel containing the policy information for a service, and updates the service to reference the policy tModel.
IBusinessService	createBusinessService(IPublisher.ICreateBusinessServiceContext context) Publishes a service to the UDDI server.
java.lang.String	deleteBusinessService(java.lang.String serviceKey) Deletes a business service from the UDDI server.
java.lang.String	deleteTModel(java.lang.String tModelKey) Deletes a ITModel from the UDDI server.
void	disconnect() This method is called when the plugin should pre-emptively release resources that it is consuming
java.util.List<IBusinessEntity>	findPublishableBusinesses() Retrieves all IBusinessEntitys that the user has permission to write to.
ICategoryBag	getBusinessServiceCategories(IPublisher.IGetBusinessServiceCategoriesContext context) Returns a ICategoryBag of keyed references that are added to a business service when it is published to the UDDI server.
IInquiry	getInquiry() Returns the IInquiry.
ICategoryBag	getKeyedReferencesForPublish() Returns ICategoryBag of keyed references that should be added to the categoryBag of a service when it is published to the UDDI server.
java.util.List<IPublisher.IKeyValidationEntry>	getKeyValidationEntries() This method returns a list of IKeyValidationEntry which identifies the tModel keys of KeyedReferences that should be validated.
IUDDISettings	getUDDISettings() Returns the settings of the plugin.
IBindingTemplate	saveBindingTemplate(IBindingTemplate binding) Saves a IBindingTemplate to the UDDI server.
IBusinessService	saveBusinessService(IBusinessService service) Saves a IBusinessService to the UDDI server.
ITModel	saveTModel(ITModel model) Saves a ITModel to the UDDI server.
boolean	supportsPublishingServices() Returns true if this plugin supports publishing services to the UDDI server.

Method Detail

getInquiry

IInquiry getInquiry()

Returns the IInquiry.

Returns:

the UDDI inquiry plugin.

getUDDISettings

IUDDISettings getUDDISettings()

Returns the settings of the plugin.

Returns:

the settings of the plugin.

supportsPublishingServices

boolean supportsPublishingServices()

Returns true if this plugin supports publishing services to the UDDI server.

Returns:

true if this plugin supports publishing services to the UDDI server.

findPublishableBusinesses

java.util.List<IBusinessEntity> findPublishableBusinesses()
                                                   throws java.lang.Exception

Retrieves all IBusinessEntitys that the user has permission to write to. The user credentials used are within the the UDDI settings.

Returns:

list of writable business entities.

Throws:

java.lang.Exception

saveTModel

ITModel saveTModel(ITModel model)
            throws java.lang.Exception

Saves a ITModel to the UDDI server.

Parameters:

model - The tModel to save.

Returns:

the saved TModel.

Throws:

java.lang.Exception

saveBusinessService

IBusinessService saveBusinessService(IBusinessService service)
                              throws java.lang.Exception

Saves a IBusinessService to the UDDI server.

Parameters:

service - The business service to save.

Returns:

the saved business service.

Throws:

java.lang.Exception

saveBindingTemplate

IBindingTemplate saveBindingTemplate(IBindingTemplate binding)
                              throws java.lang.Exception

Saves a IBindingTemplate to the UDDI server.

Parameters:

binding - The binding template to save.

Returns:

the saved binding template.

Throws:

java.lang.Exception

deleteTModel

java.lang.String deleteTModel(java.lang.String tModelKey)
                       throws java.lang.Exception

Deletes a ITModel from the UDDI server.

Parameters:

tModelKey - The key of the TModel to delete.

Returns:

the tModel key if the key existed in the UDDI server.

Throws:

java.lang.Exception

deleteBusinessService

java.lang.String deleteBusinessService(java.lang.String serviceKey)
                                throws java.lang.Exception

Deletes a business service from the UDDI server.

Parameters:

serviceKey - The key of the business service to delete.

Returns:

the business service key if the key existed in the UDDI server.

Throws:

java.lang.Exception

getKeyedReferencesForPublish

ICategoryBag getKeyedReferencesForPublish()

Returns ICategoryBag of keyed references that should be added to the categoryBag of a service when it is published to the UDDI server.

Returns:

category bag of keyed references to add to services when published.

getBusinessServiceCategories

ICategoryBag getBusinessServiceCategories(IPublisher.IGetBusinessServiceCategoriesContext context)
                                   throws java.lang.Exception

Returns a ICategoryBag of keyed references that are added to a business service when it is published to the UDDI server.

Parameters:

context - The context for retrieving the categories.

Returns:

a categoryBag of keyed references

Throws:

java.lang.Exception

createBusinessService

IBusinessService createBusinessService(IPublisher.ICreateBusinessServiceContext context)
                                throws java.lang.Exception

Publishes a service to the UDDI server.

Parameters:

context - The creation context.

Returns:

the created IBusinessService.

Throws:

java.lang.Exception

getKeyValidationEntries

java.util.List<IPublisher.IKeyValidationEntry> getKeyValidationEntries()

This method returns a list of IKeyValidationEntry which identifies the tModel keys of KeyedReferences that should be validated. The value of these KeyedReferences contains a key to a UDDI object that must exist in the registry.

Returns:

list of IKeyValidationEntry.

addPolicyToService

void addPolicyToService(IPublisher.IAddPolicyToServiceContext context)
                 throws java.lang.Exception

Publishes a tModel containing the policy information for a service, and updates the service to reference the policy tModel.

Parameters:

context - The context.

Throws:

java.lang.Exception

disconnect

void disconnect()

This method is called when the plugin should pre-emptively release resources that it is consuming.