com.groiss.ws

Interface SOAPWebServiceOperation

public interface SOAPWebServiceOperation

SOAPWebServiceOperation can be used to invoke a specific operation

Method Summary

Modifier and Type	Method and Description
QName	getName() get the operation-name
static SOAPWebServiceOperation	getOperation(String service, String operation) Get the registered SOAPWebServiceOperation from the SOAPWebService with the passed IDs
Element	getPayload(Map<String,? extends Object> payload) This method mixes the passed payload into the skeleton and returns the XML that will be sent
SOAPWebService	getWebservice() return the SOAPWebService this operation belongs to
Element	invoke(Element payload) Invoke the webservice with the passed payload
Map<String,Object>	invoke(Map<String,? extends Object> payload) Invoke the webservice and send the passed payload
Element	invokeWithDMSAttachments(Element payload, List<Pair<String,DMSDocForm>> attachments) Invoke the webservice with the passed payload and attachment content that should be attached to the webservice request
Element	invokeWithFileAttachments(Element payload, List<Pair<String,File>> attachments) Invoke the webservice with the passed payload and files that should be attached to the webservice request

Method Detail

getOperation

static SOAPWebServiceOperation getOperation(String service,
                                            String operation)

Get the registered SOAPWebServiceOperation from the SOAPWebService with the passed IDs

Parameters:

service - the service-ID

operation - the operation-ID

Returns:

the operation

See Also:

SOAPWebService.getService(String)

getWebservice

SOAPWebService getWebservice()

return the SOAPWebService this operation belongs to

Returns:

SOAPWebService object

getPayload

Element getPayload(Map<String,? extends Object> payload)

This method mixes the passed payload into the skeleton and returns the XML that will be sent

Parameters:

payload -

Returns:

the mixed-in payload as Element

invoke

Map<String,Object> invoke(Map<String,? extends Object> payload)

Invoke the webservice and send the passed payload

Parameters:

payload -

Returns:

the webservice response parameter

invoke

Element invoke(Element payload)

Invoke the webservice with the passed payload

Parameters:

payload -

Returns:

the webservice response as Element

invokeWithFileAttachments

Element invokeWithFileAttachments(Element payload,
                                  List<Pair<String,File>> attachments)

Invoke the webservice with the passed payload and files that should be attached to the webservice request

Parameters:

payload -

attachments - a list of Pair containing the contentId as key and a File as value; the contentId is not mandatory and if not given it will be generated automatically

Returns:

the webservice response as Element

invokeWithDMSAttachments

Element invokeWithDMSAttachments(Element payload,
                                 List<Pair<String,DMSDocForm>> attachments)

Invoke the webservice with the passed payload and attachment content that should be attached to the webservice request

Parameters:

payload -

attachments - a list of Pair containing the contentId as key and a DMSDocForm as value; the contentId is not mandatory and if not given it will be generated automatically

Returns:

the webservice response as Element

getName

QName getName()

get the operation-name

Returns:

the operation-name as QName object