|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface WebService
Interface for the WebService object.
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 |
---|
static final java.lang.String copyright
Method Detail |
---|
java.lang.String getName()
PIMInternalException
- If an internal error occurs.void setName(java.lang.String name)
name
- The name of the new webservice.
PIMInternalException
- If an internal error occurs.
PIMAuthorizationException
- Reserved for future use.
java.lang.IllegalArgumentException
- If name is null or an empty string.java.lang.String getImplementationClassName()
PIMInternalException
- If an internal error occurs.
java.lang.UnsupportedOperationException
- If the user tries to invoke this method on script based
webservice.void setImplementationClassName(java.lang.String implementationClassName)
implementationClassName
- Java class name which implements the service.
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.java.lang.String getDescription()
PIMInternalException
- If an internal error occurs.void setDescription(java.lang.String description)
description
- Description of the webservice.
PIMInternalException
- If an internal error occurs.
PIMAuthorizationException
- Reserved for future use.java.lang.String getURL()
PIMInternalException
- If an internal error occurs.java.lang.String getWsdlURL()
PIMInternalException
- If an internal error occurs.Document getWsdlDocument()
PIMInternalException
- If an internal error occurs.
PIMAuthorizationException
- If the user does not have the equivalent of
Permission.DOCSTORE_VIEW_FILES
void setWsdlDocument(Document wsdlDoc)
wsdlDoc
- Document object which represents the WSDL.
PIMInternalException
- If an internal error occurs.
PIMAuthorizationException
- Reserved for future use.
java.lang.IllegalArgumentException
- If wsdlDoc is null.Document getWsddDocument()
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.void setWsddDocument(Document wsddDoc)
wsddDoc
- Document object which represents the WSDD.
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.WebService.MessageStyle getStyle()
PIMInternalException
- If an internal error occurs.void setStyle(WebService.MessageStyle messageStyle)
messageStyle
- The message style for the web service.
PIMInternalException
- If an internal error occurs.
PIMAuthorizationException
- Reserved for future use.
java.lang.IllegalArgumentException
- If messageStyle is null.Document getImplementationScript()
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.void setImplementationScript(Document implementationScript)
implementationScript
- The Document object which represents the webservice
implementation script.
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.boolean isRequestStored()
PIMInternalException
- If an internal error occurs.void setStoreRequest(boolean storeRequest)
storeRequest
- Determines whether incoming requests are stored.
PIMInternalException
- If an internal error occurs.
PIMAuthorizationException
- Reserved for future use.boolean isResponseStored()
PIMInternalException
- If an internal error occurs.void setStoreResponse(boolean storeResponse)
storeResponse
- Determines whether outgoing responses are stored.
PIMInternalException
- If an internal error occurs.
PIMAuthorizationException
- Reserved for future use.boolean isDeployed()
PIMInternalException
- If an internal error occurs.void setDeployed(boolean deployed)
deployed
- Determines whether the service will be deployed.
PIMInternalException
- If an internal error occurs.
PIMAuthorizationException
- Reserved for future use.boolean isAuthenticationRequired()
PIMInternalException
- If an internal error occurs.void setAuthenticationRequired(boolean isAuthenticationrequired)
isAuthenticationrequired
- Determines whether a username, company name, and password are
required to invoke this web service.
PIMInternalException
- If an internal error occurs.
PIMAuthorizationException
- Reserved for future use.boolean isSkipRequestValidation()
PIMInternalException
- If an internal error occurs.void setSkipRequestValidation(boolean skipRequestValidation)
skipRequestValidation
- Determines whether the inbound message is validated against
WSDL schema.
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 styleboolean isSkipResponseValidation()
PIMInternalException
- If an internal error occurs.void setSkipResponseValidation(boolean skipResponseValidation)
skipResponseValidation
- Determines whether the outbound message is validated against
WSDL schema.
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 stylevoid save()
PIMInternalException
- If an internal error occurs.
PIMAuthorizationException
- Reserved for future use.void delete()
PIMInternalException
- If an internal error occurs.
PIMAuthorizationException
- Reserved for future use.PIMCollection<WebServiceTransaction> getTransactions(java.util.Date fromDate, java.util.Date toDate)
fromDate
- the start date.toDate
- the end date.
PIMInternalException
- If an internal error occurs.
PIMAuthorizationException
- Reserved for future use.
java.lang.IllegalArgumentException
- If fromDate is null or toDate is nullboolean isJavaBased()
PIMInternalException
- If an internal error occurs.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |