com.webmethods.portal.webservices

Interface IWebService

public interface IWebService

Interface to define methods needed for WebService portlets.

Method Summary

Modifier and Type	Method and Description
default Class<?>[]	getExtraWsdlSchemaClasses(IContext context) Return extra classes whose type schema should be included in the generated WSDL.
IURI	getURI() Gets the URI of the webservice.
Collection	getWebServiceCommands(IContext context) get a list of commands that should be exposed through the portlet's webservice.
String	getWebServiceName() Get the name of the webservice
org.apache.axis.description.ServiceDesc	initializeServiceDesc(IContext context, org.apache.axis.description.ServiceDesc serviceDesc) initialize the Axis Service Description
void	initializeSOAPMappingRegistry(IContext context, TypeMapping registry) initialize the SOAP datatype registry
org.apache.axis.handlers.soap.SOAPService	initializeSOAPService(org.apache.axis.handlers.soap.SOAPService soapService) initialize the Axis Service Description
boolean	isWebServiceEnabled() returns whether the webservice is enabled.

Method Detail

getURI

IURI getURI()

Gets the URI of the webservice.

Returns:

isWebServiceEnabled

boolean isWebServiceEnabled()
                     throws PortalException

returns whether the webservice is enabled.

Returns:

true if the webservice is enabled, false otherwise

Throws:

PortalException

getWebServiceName

String getWebServiceName()
                  throws PortalException

Get the name of the webservice

Returns:

Throws:

PortalException

getWebServiceCommands

Collection getWebServiceCommands(IContext context)
                          throws PortalException

get a list of commands that should be exposed through the portlet's webservice.

Returns:

a collection of commands that should be exposed through the portlet's webservice

Throws:

PortalException

initializeSOAPMappingRegistry

void initializeSOAPMappingRegistry(IContext context,
                                   TypeMapping registry)
                            throws PortalException

initialize the SOAP datatype registry

Parameters:

registry - the datatype registry to add type definitions to.

Throws:

PortalException

initializeServiceDesc

org.apache.axis.description.ServiceDesc initializeServiceDesc(IContext context,
                                                              org.apache.axis.description.ServiceDesc serviceDesc)
                                                       throws PortalException

initialize the Axis Service Description

Parameters:

soapService -

Returns:

the initialized SOAPService object.

Throws:

PortalException

initializeSOAPService

org.apache.axis.handlers.soap.SOAPService initializeSOAPService(org.apache.axis.handlers.soap.SOAPService soapService)
                                                         throws PortalException

initialize the Axis Service Description

Parameters:

soapService -

Returns:

the initialized SOAPService object.

Throws:

PortalException

getExtraWsdlSchemaClasses

default Class<?>[] getExtraWsdlSchemaClasses(IContext context)
                                      throws PortalException

Return extra classes whose type schema should be included in the generated WSDL. This is useful when a parameter or return type is abstract or can accept multiple types (i.e. Object or List)

Returns:

extra classes to add to the WSDL schema

Throws:

PortalException