ee.ria.dhx.ws.service

Interface DhxPackageService

All Known Implementing Classes:

DhxPackageServiceImpl

public interface DhxPackageService

Interface for document sending and receiving. Service must be independent from capsule versions that are being sent or received, that means that no changes should be done in service if new capsule version is added.

Author:

Aleksei Kokarev

Method Summary

Modifier and Type	Method and Description
ee.ria.dhx.types.eu.x_road.dhx.producer.SendDocumentResponse	receiveDocumentFromEndpoint(ee.ria.dhx.types.eu.x_road.dhx.producer.SendDocument document, ee.ria.dhx.types.InternalXroadMember client, ee.ria.dhx.types.InternalXroadMember service, org.springframework.ws.context.MessageContext context) Method is used by endpoint.
java.util.List<ee.ria.dhx.types.DhxSendDocumentResult>	sendMultiplePackages(java.util.List<ee.ria.dhx.types.OutgoingDhxPackage> outgoingPackages) Send document.
ee.ria.dhx.types.DhxSendDocumentResult	sendPackage(ee.ria.dhx.types.OutgoingDhxPackage outgoingPackage) Send package.

Method Detail

sendPackage

ee.ria.dhx.types.DhxSendDocumentResult sendPackage(ee.ria.dhx.types.OutgoingDhxPackage outgoingPackage)
                                            throws ee.ria.dhx.exception.DhxException

Send package. Package is sent to recipient defined in outgoingPackage.

Parameters:

outgoingPackage - - package to send

Returns:

- sendDocument service result

Throws:

ee.ria.dhx.exception.DhxException - - thrown if error occurs while sending document

sendMultiplePackages

java.util.List<ee.ria.dhx.types.DhxSendDocumentResult> sendMultiplePackages(java.util.List<ee.ria.dhx.types.OutgoingDhxPackage> outgoingPackages)
                                                                     throws ee.ria.dhx.exception.DhxException

Send document. Every package is sent to recipient defined in it. If package sending gets exception, then send document result with fault in it is created, sending will be continued anyway.

Parameters:

outgoingPackages - - package to send

Returns:

- sendDocument service results

Throws:

ee.ria.dhx.exception.DhxException - - thrown if error occurs while sending document

receiveDocumentFromEndpoint

ee.ria.dhx.types.eu.x_road.dhx.producer.SendDocumentResponse receiveDocumentFromEndpoint(ee.ria.dhx.types.eu.x_road.dhx.producer.SendDocument document,
                                                                                         ee.ria.dhx.types.InternalXroadMember client,
                                                                                         ee.ria.dhx.types.InternalXroadMember service,
                                                                                         org.springframework.ws.context.MessageContext context)
                                                                                  throws ee.ria.dhx.exception.DhxException

Method is used by endpoint. Is called when document arrives to endpoint.

Parameters:

document - - service iniput parameters. document to receive

client - - SOAP message client(who sent the request).

service - - SOAP message service(to whom was request sent).

context - - SOAP message context. If something is missing in parsed objects, then take them from context

Returns:

service response

Throws:

ee.ria.dhx.exception.DhxException - - thrown if error occurs while receiving document