com.ibm.pim.webservice
Interface WebServiceManager

All Superinterfaces:
Manager

public interface WebServiceManager
extends Manager

Manager for the WebService objects.

Since:
6.0.0

Field Summary
static java.lang.String copyright
           
 
Method Summary
 WebService createWebService(java.lang.String webServiceName, java.lang.String description, Document wsdlDoc, WebService.MessageStyle messageStyle, Document implementationScript)
          Creates a new web service with the script that implements the service
 WebService createWebService(java.lang.String webServiceName, java.lang.String description, Document wsdlDoc, WebService.MessageStyle messageStyle, Document implementationScript, boolean storeIncoming, boolean storeOutgoing, boolean deployed, boolean authenticationRequired, boolean skipRequestValidation, boolean skipResponseValidation)
          Creates a new web service with the script that implements the service
 WebService createWebServiceUsingJava(java.lang.String webServiceName, java.lang.String description, Document wsdlDoc, Document wsddDoc, WebService.MessageStyle messageStyle, java.lang.String implementingClass)
          Creates a new java web service.
 WebService createWebServiceUsingJava(java.lang.String webServiceName, java.lang.String description, Document wsdlDoc, Document wsddDoc, WebService.MessageStyle messageStyle, java.lang.String implementingClass, boolean storeIncoming, boolean storeOutgoing, boolean deployed, boolean authenticationRequired, boolean skipRequestValidation, boolean skipResponseValidation)
          Creates a new java web service.
 WebService getWebService(java.lang.String webServiceName)
          Returns the web service with the given name.
 java.util.Collection<WebService> getWebServices()
          Retrieves all web services available in the current context
 
Methods inherited from interface com.ibm.pim.common.Manager
getManagerName
 

Field Detail

copyright

static final java.lang.String copyright
See Also:
Constant Field Values
Method Detail

getWebService

WebService getWebService(java.lang.String webServiceName)
Returns the web service with the given name.

Parameters:
webServiceName - The name of the webservice.
Returns:
The webservice. Returns null if the webservice with the name does not exist
Throws:
PIMInternalException - If an internal error occurs.
PIMAuthorizationException - Reserved for future use
java.lang.IllegalArgumentException - If webServiceName is null or an empty string

createWebService

WebService createWebService(java.lang.String webServiceName,
                            java.lang.String description,
                            Document wsdlDoc,
                            WebService.MessageStyle messageStyle,
                            Document implementationScript)
Creates a new web service with the script that implements the service

Parameters:
webServiceName - The name of the new webservice.
description - Description of the new webservice.
wsdlDoc - The WSDL Document object.
messageStyle - The message style for the web service.
implementationScript - The Document object which represents the service implementation script.
Returns:
The newly created webservice.
Throws:
PIMInternalException - If an internal error occurs.
PIMAuthorizationException - Reserved for future use
java.lang.IllegalArgumentException - If webServiceName is null or an empty string or wsdlDoc or messageStyle or implementationScript is null

createWebService

WebService createWebService(java.lang.String webServiceName,
                            java.lang.String description,
                            Document wsdlDoc,
                            WebService.MessageStyle messageStyle,
                            Document implementationScript,
                            boolean storeIncoming,
                            boolean storeOutgoing,
                            boolean deployed,
                            boolean authenticationRequired,
                            boolean skipRequestValidation,
                            boolean skipResponseValidation)
Creates a new web service with the script that implements the service

Parameters:
webServiceName - The name of the new webservice.
description - Description of the new webservice.
wsdlDoc - The WSDL Document object.
messageStyle - The message style for the web service.
implementationScript - The Document object which represents the webservice implementation script.
storeIncoming - Determines whether incoming request are stored. If true,the incoming messages for this web service will be stored.
storeOutgoing - Determines whether outgoing response are stored. If true, the outgoing messages for this web service will be stored.
deployed - Determines whether the service will be deployed. If true, the web service will be deployed
authenticationRequired - Determines whether a username, company name, and password are required to invoke this web service. If true, the web service requires an authentication.
skipRequestValidation - Determines whether the inbound message is validated against WSDL schema. If true, the inbound messages will not be validated against WSDL schema.
skipResponseValidation - determines whether the outbound message is validated against WSDL schema. If true, the outbound message will not be validated against WSDL schema.
Returns:
The newly created webservice.
Throws:
PIMInternalException - If an internal error occurs.
PIMAuthorizationException - Reserved for future use
java.lang.IllegalArgumentException - If webServiceName is null or an empty string or wsdlDoc or messageStyle or implementationScript is null or the messageStyle is WebService.MessageStyle.RPC_ENCODED and the value for skipRequestValidation or skipResponseValidation is true

createWebServiceUsingJava

WebService createWebServiceUsingJava(java.lang.String webServiceName,
                                     java.lang.String description,
                                     Document wsdlDoc,
                                     Document wsddDoc,
                                     WebService.MessageStyle messageStyle,
                                     java.lang.String implementingClass)
Creates a new java web service.

Parameters:
webServiceName - The name of the new webservice.
description - Description of the new webservice.
wsdlDoc - The WSDL Document object.
wsddDoc - The WSDD Document object.
messageStyle - The message style for the web service.
implementingClass - Java class which implements the service.
Returns:
The newly created webservice.
Throws:
PIMInternalException - If an internal error occurs.
PIMAuthorizationException - Reserved for future use
java.lang.IllegalArgumentException - If webServiceName is null or an empty string or wsdlDoc or wsddDoc or messageStyle is null or implementingClass is null or an empty string

createWebServiceUsingJava

WebService createWebServiceUsingJava(java.lang.String webServiceName,
                                     java.lang.String description,
                                     Document wsdlDoc,
                                     Document wsddDoc,
                                     WebService.MessageStyle messageStyle,
                                     java.lang.String implementingClass,
                                     boolean storeIncoming,
                                     boolean storeOutgoing,
                                     boolean deployed,
                                     boolean authenticationRequired,
                                     boolean skipRequestValidation,
                                     boolean skipResponseValidation)
Creates a new java web service.

Parameters:
webServiceName - The name of the new webservice.
description - Description of the new webservice.
wsdlDoc - The WSDL Document object.
wsddDoc - The WSDD Document object.
messageStyle - The message style for the web service.
implementingClass - Java class which implements the service.
storeIncoming - Determines whether incoming request are stored. If true,the incoming messages for this web service will be stored.
storeOutgoing - Determines whether outgoing response are stored. If true, the outgoing messages for this web service will be stored.
deployed - Determines whether the service will be deployed. If true, the web service will be deployed
authenticationRequired - Determines whether a username, company name, and password are required to invoke this web service. If true, the web service requires an authentication.
skipRequestValidation - Determines whether the inbound message is validated against WSDL schema. If true, the inbound messages will not be validated against WSDL schema.
skipResponseValidation - Determines whether the outbound message is validated against WSDL schema. If true, the outbound message will not be validated against WSDL schema.
Returns:
The newly created webservice.
Throws:
PIMInternalException - If an internal error occurs.
PIMAuthorizationException - Reserved for future use
java.lang.IllegalArgumentException - If webServiceName is null or an empty string or wsdlDoc or wsddDoc or messageStyle is null or implementingClass is null or an empty string or the messageStyle is WebService.MessageStyle.RPC_ENCODED and the value for skipRequestValidation or skipResponseValidation is true

getWebServices

java.util.Collection<WebService> getWebServices()
Retrieves all web services available in the current context

Returns:
A Collection of web services.
Throws:
PIMInternalException - If an internal error occurs
PIMAuthorizationException - Reserved for future use