com.ibm.pim.webservice
Interface WebService


public interface WebService

Interface for the WebService object.

Since:
6.0.0

Nested Class Summary
static class WebService.MessageStyle
          Enumeration listing the message styles which will be used to create webservice.
 
Field Summary
static java.lang.String copyright
           
 
Method Summary
 void delete()
          Undeploys and deletes the web service.
 java.lang.String getDescription()
          Returns the description of the web service.
 java.lang.String getImplementationClassName()
          Returns the implementation class name for the webservice.
 Document getImplementationScript()
          Returns the Document object represents the implementation script for the web service.
 java.lang.String getName()
          Returns the name of the webservice.
 WebService.MessageStyle getStyle()
          Returns the style for the web service.
 PIMCollection<WebServiceTransaction> getTransactions(java.util.Date fromDate, java.util.Date toDate)
          Returns all the transactions associated with the webservice for the specified date range.
 java.lang.String getURL()
          Returns the URL for the webservice.
 Document getWsddDocument()
          Returns document object which represents the WSDD for the web service.
 Document getWsdlDocument()
          Returns document object which represents the WSDL for the web service.
 java.lang.String getWsdlURL()
          Returns the WSDL URL for the web service.
 boolean isAuthenticationRequired()
          Indicates whether this web service requires an authentication.
 boolean isDeployed()
          Indicates whether this web service is deployed.
 boolean isJavaBased()
          Returns true if a webservice definition within MDMPIM is java based.
 boolean isRequestStored()
          Indicates whether incoming messages for this web service are stored.
 boolean isResponseStored()
          Indicates whether outgoing messages for this web service are stored.
 boolean isSkipRequestValidation()
          Indicates whether the inbound message requires validation against WSDL schema.
 boolean isSkipResponseValidation()
          Indicates whether the outbound message requires validation against WSDL schema.
 void save()
          Persists the web service to the database
 void setAuthenticationRequired(boolean isAuthenticationrequired)
          Sets whether this WebService requires authentication.
 void setDeployed(boolean deployed)
          Sets whether this WebService is deployed.
 void setDescription(java.lang.String description)
          Sets the description of the given WebService.
 void setImplementationClassName(java.lang.String implementationClassName)
          Sets the fully qualified name of the implementation class of the given WebService.
 void setImplementationScript(Document implementationScript)
          Sets the implementation script for the given WebService.
 void setName(java.lang.String name)
          Sets the name of the given WebService.
 void setSkipRequestValidation(boolean skipRequestValidation)
          Sets whether the inbound message requires validation against WSDL schema.
 void setSkipResponseValidation(boolean skipResponseValidation)
          Sets whether the outbound message requires validation against WSDL schema.
 void setStoreRequest(boolean storeRequest)
          Sets the storeRequest property of the given WebService.
 void setStoreResponse(boolean storeResponse)
          Sets the storeResponse of the given WebService.
 void setStyle(WebService.MessageStyle messageStyle)
          Sets the message style of the given WebService.
 void setWsddDocument(Document wsddDoc)
          Sets the WSDD document.
 void setWsdlDocument(Document wsdlDoc)
          Sets the WSDL document.
 

Field Detail

copyright

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

getName

java.lang.String getName()
Returns the name of the webservice.

Returns:
Webservice name.
Throws:
PIMInternalException - If an internal error occurs.

setName

void setName(java.lang.String name)
Sets the name of the given WebService.

Parameters:
name - The name of the new webservice.
Throws:
PIMInternalException - If an internal error occurs.
PIMAuthorizationException - Reserved for future use.
java.lang.IllegalArgumentException - If name is null or an empty string.

getImplementationClassName

java.lang.String getImplementationClassName()
Returns the implementation class name for the webservice.

Returns:
Name of the implementation class.
Throws:
PIMInternalException - If an internal error occurs.
java.lang.UnsupportedOperationException - If the user tries to invoke this method on script based webservice.

setImplementationClassName

void setImplementationClassName(java.lang.String implementationClassName)
Sets the fully qualified name of the implementation class of the given WebService.

Parameters:
implementationClassName - Java class name which implements the service.
Throws:
PIMInternalException - If an internal error occurs.
PIMAuthorizationException - Reserved for future use.
java.lang.UnsupportedOperationException - If the user tries to invoke this method on script based webservice.
java.lang.IllegalArgumentException - If implementationClassName is null or an empty string.

getDescription

java.lang.String getDescription()
Returns the description of the web service.

Returns:
Webservice description.
Throws:
PIMInternalException - If an internal error occurs.

setDescription

void setDescription(java.lang.String description)
Sets the description of the given WebService.

Parameters:
description - Description of the webservice.
Throws:
PIMInternalException - If an internal error occurs.
PIMAuthorizationException - Reserved for future use.

getURL

java.lang.String getURL()
Returns the URL for the webservice.

Returns:
The webservice URL.
Throws:
PIMInternalException - If an internal error occurs.

getWsdlURL

java.lang.String getWsdlURL()
Returns the WSDL URL for the web service.

Returns:
The WSDL URL.
Throws:
PIMInternalException - If an internal error occurs.

getWsdlDocument

Document getWsdlDocument()
Returns document object which represents the WSDL for the web service.

Returns:
The WSDL Document object.
Throws:
PIMInternalException - If an internal error occurs.
PIMAuthorizationException - If the user does not have the equivalent of Permission.DOCSTORE_VIEW_FILES

setWsdlDocument

void setWsdlDocument(Document wsdlDoc)
Sets the WSDL document.

Parameters:
wsdlDoc - Document object which represents the WSDL.
Throws:
PIMInternalException - If an internal error occurs.
PIMAuthorizationException - Reserved for future use.
java.lang.IllegalArgumentException - If wsdlDoc is null.

getWsddDocument

Document getWsddDocument()
Returns document object which represents the WSDD for the web service.

Returns:
the WSDD Document object.
Throws:
PIMInternalException - If an internal error occurs.
PIMAuthorizationException - If the user does not have the equivalent of Permission.DOCSTORE_VIEW_FILES
java.lang.UnsupportedOperationException - If the user tries to invoke this method on script based webservice.

setWsddDocument

void setWsddDocument(Document wsddDoc)
Sets the WSDD document.

Parameters:
wsddDoc - Document object which represents the WSDD.
Throws:
PIMInternalException - If an internal error occurs.
PIMAuthorizationException - Reserved for future use.
java.lang.UnsupportedOperationException - If the user tries to invoke this method on script based webservice.
java.lang.IllegalArgumentException - If wsddDoc is null.

getStyle

WebService.MessageStyle getStyle()
Returns the style for the web service.

Returns:
the message style.
Throws:
PIMInternalException - If an internal error occurs.

setStyle

void setStyle(WebService.MessageStyle messageStyle)
Sets the message style of the given WebService.

Parameters:
messageStyle - The message style for the web service.
Throws:
PIMInternalException - If an internal error occurs.
PIMAuthorizationException - Reserved for future use.
java.lang.IllegalArgumentException - If messageStyle is null.

getImplementationScript

Document getImplementationScript()
Returns the Document object represents the implementation script for the web service.

Returns:
the implementation script document.
Throws:
PIMInternalException - If an internal error occurs.
PIMAuthorizationException - If the user does not have the equivalent of Permission.DOCSTORE_VIEW_FILES
java.lang.UnsupportedOperationException - If the user tries to invoke this method on java based webservice.

setImplementationScript

void setImplementationScript(Document implementationScript)
Sets the implementation script for the given WebService.

Parameters:
implementationScript - The Document object which represents the webservice implementation script.
Throws:
PIMInternalException - If an internal error occurs.
PIMAuthorizationException - Reserved for future use.
java.lang.UnsupportedOperationException - If the user tries to invoke this method on java based webservice.
java.lang.IllegalArgumentException - If implementationScript is null.

isRequestStored

boolean isRequestStored()
Indicates whether incoming messages for this web service are stored.

Returns:
A boolean value indicating the incoming messages for this web service are stored. Returns true if the incoming messages for this web service are stored.
Throws:
PIMInternalException - If an internal error occurs.

setStoreRequest

void setStoreRequest(boolean storeRequest)
Sets the storeRequest property of the given WebService. storeRequest determines whether incoming request are stored.

Parameters:
storeRequest - Determines whether incoming requests are stored.
Throws:
PIMInternalException - If an internal error occurs.
PIMAuthorizationException - Reserved for future use.

isResponseStored

boolean isResponseStored()
Indicates whether outgoing messages for this web service are stored.

Returns:
A boolean value indicating the outgoing messages for this web service are stored. Returns true if the outgoing messages for this web service are stored.
Throws:
PIMInternalException - If an internal error occurs.

setStoreResponse

void setStoreResponse(boolean storeResponse)
Sets the storeResponse of the given WebService. storeResponse determines whether outgoing response are stored.

Parameters:
storeResponse - Determines whether outgoing responses are stored.
Throws:
PIMInternalException - If an internal error occurs.
PIMAuthorizationException - Reserved for future use.

isDeployed

boolean isDeployed()
Indicates whether this web service is deployed.

Returns:
A boolean value indicating the web service is deployed. Returns true if the web service is deployed
Throws:
PIMInternalException - If an internal error occurs.

setDeployed

void setDeployed(boolean deployed)
Sets whether this WebService is deployed.

Parameters:
deployed - Determines whether the service will be deployed.
Throws:
PIMInternalException - If an internal error occurs.
PIMAuthorizationException - Reserved for future use.

isAuthenticationRequired

boolean isAuthenticationRequired()
Indicates whether this web service requires an authentication.

Returns:
A boolean value indicating the web service requires authentication. Returns true if the web service requires an authentication
Throws:
PIMInternalException - If an internal error occurs.

setAuthenticationRequired

void setAuthenticationRequired(boolean isAuthenticationrequired)
Sets whether this WebService requires authentication.

Parameters:
isAuthenticationrequired - Determines whether a username, company name, and password are required to invoke this web service.
Throws:
PIMInternalException - If an internal error occurs.
PIMAuthorizationException - Reserved for future use.

isSkipRequestValidation

boolean isSkipRequestValidation()
Indicates whether the inbound message requires validation against WSDL schema.

Returns:
A boolean value indicating the inbound message requires validation against WSDL schema. Returns true if the inbound message is not validated against WSDL schema.
Throws:
PIMInternalException - If an internal error occurs.

setSkipRequestValidation

void setSkipRequestValidation(boolean skipRequestValidation)
Sets whether the inbound message requires validation against WSDL schema.

Parameters:
skipRequestValidation - Determines whether the inbound message is validated against WSDL schema.
Throws:
PIMInternalException - If an internal error occurs.
PIMAuthorizationException - Reserved for future use.
java.lang.UnsupportedOperationException - If the user tries to invoke this method on web service with RPC_ENCODED as message style

isSkipResponseValidation

boolean isSkipResponseValidation()
Indicates whether the outbound message requires validation against WSDL schema.

Returns:
A boolean value indicating the outbound message requires validation against WSDL schema. Returns true if the outbound message is not validated against WSDL schema.
Throws:
PIMInternalException - If an internal error occurs.

setSkipResponseValidation

void setSkipResponseValidation(boolean skipResponseValidation)
Sets whether the outbound message requires validation against WSDL schema.

Parameters:
skipResponseValidation - Determines whether the outbound message is validated against WSDL schema.
Throws:
PIMInternalException - If an internal error occurs.
PIMAuthorizationException - Reserved for future use.
java.lang.UnsupportedOperationException - If the user tries to invoke this method on web service with RPC_ENCODED as message style

save

void save()
Persists the web service to the database

Throws:
PIMInternalException - If an internal error occurs.
PIMAuthorizationException - Reserved for future use.

delete

void delete()
Undeploys and deletes the web service.

Throws:
PIMInternalException - If an internal error occurs.
PIMAuthorizationException - Reserved for future use.

getTransactions

PIMCollection<WebServiceTransaction> getTransactions(java.util.Date fromDate,
                                                     java.util.Date toDate)
Returns all the transactions associated with the webservice for the specified date range.

Parameters:
fromDate - the start date.
toDate - the end date.
Returns:
an PIMCollection of WebServiceTransaction for this webservice
Throws:
PIMInternalException - If an internal error occurs.
PIMAuthorizationException - Reserved for future use.
java.lang.IllegalArgumentException - If fromDate is null or toDate is null

isJavaBased

boolean isJavaBased()
Returns true if a webservice definition within MDMPIM is java based.

Returns:
A boolean value indicating the webservice definition within MDMPIM is java based. Returns true if the web service is java based.
Throws:
PIMInternalException - If an internal error occurs.