ee.ria.dhx.ws.service

Interface DhxImplementationSpecificService

All Known Implementing Classes:

ExampleDhxImplementationSpecificService

public interface DhxImplementationSpecificService

Interface which declares methods that are needed for DHX web services to work, but those methods are not implemented by DHX ws itself.

Author:

Aleksei Kokarev

Method Summary

Modifier and Type	Method and Description
java.util.List<ee.ria.dhx.types.InternalXroadMember>	getAdresseeList() Method returns adressees list from local storage(DB for example).
java.util.List<ee.ria.dhx.types.DhxRepresentee>	getRepresentationList() Method returns list of representees.
boolean	isDuplicatePackage(ee.ria.dhx.types.InternalXroadMember from, java.lang.String consignmentId) Method searches through saved documents and checks if document with same sender and consignment id exists.
java.lang.String	receiveDocument(ee.ria.dhx.types.IncomingDhxPackage document, org.springframework.ws.context.MessageContext context) Method should receive document(save in database for example) and return unique id of it.
void	saveAddresseeList(java.util.List<ee.ria.dhx.types.InternalXroadMember> members) Methods saves adressees list to local storage(DB for example).
void	saveSendResult(ee.ria.dhx.types.DhxSendDocumentResult finalResult, java.util.List<ee.ria.dhx.types.AsyncDhxSendDocumentResult> retryResults) If using asynchronous document sending.

Method Detail

isDuplicatePackage

boolean isDuplicatePackage(ee.ria.dhx.types.InternalXroadMember from,
                           java.lang.String consignmentId)
                    throws ee.ria.dhx.exception.DhxException

Method searches through saved documents and checks if document with same sender and consignment id exists.

Parameters:

from - - document sender to check

consignmentId - - consignment id to check

Returns:

- true if document with same sender and consignment id exists, otherwise false

Throws:

ee.ria.dhx.exception.DhxException - - thrown if error occurs

receiveDocument

java.lang.String receiveDocument(ee.ria.dhx.types.IncomingDhxPackage document,
                                 org.springframework.ws.context.MessageContext context)
                          throws ee.ria.dhx.exception.DhxException

Method should receive document(save in database for example) and return unique id of it. Id will be sent as receipt in response.

Parameters:

document - - document to receive

context - - if something is missing in document, then there is opportunity to take it from context

Returns:

- unique id of the document that was saved.

Throws:

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

getRepresentationList

java.util.List<ee.ria.dhx.types.DhxRepresentee> getRepresentationList()
                                                               throws ee.ria.dhx.exception.DhxException

Method returns list of representees.

Returns:

List of representees that are represented by that X-road member or empty List if there are no representees.

Throws:

ee.ria.dhx.exception.DhxException - - thrown if error occurs

getAdresseeList

java.util.List<ee.ria.dhx.types.InternalXroadMember> getAdresseeList()
                                                              throws ee.ria.dhx.exception.DhxException

Method returns adressees list from local storage(DB for example). Method does not renew adressees list from X-road.

Returns:

- adressees list from local storage

Throws:

ee.ria.dhx.exception.DhxException - - thrown if error occurs

saveAddresseeList

void saveAddresseeList(java.util.List<ee.ria.dhx.types.InternalXroadMember> members)
                throws ee.ria.dhx.exception.DhxException

Methods saves adressees list to local storage(DB for example). This method is called after renewing adressees list from X-road.

Parameters:

members - - list of the adressees to save

Throws:

ee.ria.dhx.exception.DhxException - - thrown if error occurs

saveSendResult

void saveSendResult(ee.ria.dhx.types.DhxSendDocumentResult finalResult,
                    java.util.List<ee.ria.dhx.types.AsyncDhxSendDocumentResult> retryResults)

If using asynchronous document sending. Then this method is a callback for receiving sendDocument results. This method is used for both success and fail.

Parameters:

finalResult - - last result of the package sending. Contains both package that was sent(including recipient and other information) and sending result, either success or fail. If sending was unsucessfull then final results response parameter will contain fault.

retryResults - - contains information about all retries that were done. Meant for debugging or history saving or something like that.