ee.ria.dhx.server.persistence.service

Class CapsuleService

java.lang.Object

ee.ria.dhx.server.persistence.service.CapsuleService

@Service
public class CapsuleService
extends java.lang.Object

Class is intended to perform actions on capsule, e.g. create capsule from persisted object and backwards. Class is aware of capsule versions, and designed to be easily modified to support other capsule versions as well. Other classes in that module are unaware of capsule versions and only use that class to get or set data to capsule.

Author:

Aleksei Kokarev

Constructor Summary

Constructors

Constructor and Description
CapsuleService()

Method Summary

Modifier and Type	Method and Description
void	cleanupContainer(java.lang.Object containerObject) When all actions with contianer are complete, delete file which might be related to the container.
void	cleanupContainers(java.util.List<? extends java.lang.Object> containers) When all actions with contianer are complete, delete file which might be related to the container.
void	formatCapsuleRecipientAndSender(java.lang.Object containerObject, Organisation sender, Organisation recipient, java.lang.Boolean outgoingContainer) Sometimes DHX addressee(incoming document) and DVK addresse(outgoing document might be different.
java.lang.Object	getContainerFromDocument(Document doc) Method creates container object from Document object.
java.util.List<java.lang.Object>	getContainersList(javax.activation.DataHandler handler, ee.ria.dhx.util.CapsuleVersionEnum version) Method gets list of containers from attachment.
Document	getDocumentFromIncomingContainer(ee.ria.dhx.types.IncomingDhxPackage pckg, ee.ria.dhx.util.CapsuleVersionEnum version) Methods creates Document object from IncomingDhxPackage.
Document	getDocumentFromOutgoingContainer(ee.ria.dhx.types.InternalXroadMember senderMember, ee.ria.dhx.types.InternalXroadMember recipientMember, java.lang.Object container, java.lang.String folderName, ee.ria.dhx.util.CapsuleVersionEnum version) Methods creates Document object using data found from SOAP sender, SOAP recipient, container and folderName.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CapsuleService

public CapsuleService()

Method Detail

getDocumentFromIncomingContainer

@Loggable
public Document getDocumentFromIncomingContainer(ee.ria.dhx.types.IncomingDhxPackage pckg,
                                                            ee.ria.dhx.util.CapsuleVersionEnum version)
                                                     throws ee.ria.dhx.exception.DhxException

Methods creates Document object from IncomingDhxPackage. Created object is not saved in database. If document senders's organisation is not found, it is created and saved.

Parameters:

pckg - - IncomingDhxPackage to create Document for

version - - version of the capsule being received

Returns:

- Document created from IncomingDhxPackage

Throws:

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

getContainersList

@Loggable
public java.util.List<java.lang.Object> getContainersList(javax.activation.DataHandler handler,
                                                                     ee.ria.dhx.util.CapsuleVersionEnum version)
                                                              throws ee.ria.dhx.exception.DhxException

Method gets list of containers from attachment. Because sendDocuments service accepts many containers in attachment and those containers are not wrapped with wrapper element, unmarshalling does not work, therefore doing with workaround.

Parameters:

handler - - DataHandler containing list of containers

version - - CapsuleVersionEnum of the containers to parse

Returns:

List of containers parsed from DataHandler

Throws:

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

getDocumentFromOutgoingContainer

@Loggable
public Document getDocumentFromOutgoingContainer(ee.ria.dhx.types.InternalXroadMember senderMember,
                                                            ee.ria.dhx.types.InternalXroadMember recipientMember,
                                                            java.lang.Object container,
                                                            java.lang.String folderName,
                                                            ee.ria.dhx.util.CapsuleVersionEnum version)
                                                     throws ee.ria.dhx.exception.DhxException

Methods creates Document object using data found from SOAP sender, SOAP recipient, container and folderName. Created object is not saved in database. If document senders's organisation is not found, it is created and saved. Method is meant to be used from NOT DHX services, means that document will be outgoing.

Parameters:

senderMember - - sender of the document(from SOAP header)

recipientMember - - recipientMember of the document(from SOAP header)

container - - container

folderName - - name of the folder to save the document to

version - - version of the capsule being sent

Returns:

- created Document object

Throws:

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

getContainerFromDocument

@Loggable
public java.lang.Object getContainerFromDocument(Document doc)
                                                     throws ee.ria.dhx.exception.DhxException

Method creates container object from Document object. Also it sets DecMetadata for capsule version 2.1.

Parameters:

doc - - Document to create DecContaner from

Returns:

- created container object

Throws:

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

formatCapsuleRecipientAndSender

@Loggable
public void formatCapsuleRecipientAndSender(java.lang.Object containerObject,
                                                       Organisation sender,
                                                       Organisation recipient,
                                                       java.lang.Boolean outgoingContainer)
                                                throws ee.ria.dhx.exception.DhxException

Sometimes DHX addressee(incoming document) and DVK addresse(outgoing document might be different. In DHX there must be always registration code, in DVK there might be system also. That method changes recipient and sender in capsule accordingly.

Parameters:

containerObject - container Object to do changes in

sender - sender organisation

recipient - recipient organisation

outgoingContainer - defines wether it is incoming or outgoing container.

Throws:

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

cleanupContainer

@Loggable
public void cleanupContainer(java.lang.Object containerObject)
                                 throws ee.ria.dhx.exception.DhxException

When all actions with contianer are complete, delete file which might be related to the container.

Parameters:

containerObject - container to cleanup

Throws:

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

cleanupContainers

public void cleanupContainers(java.util.List<? extends java.lang.Object> containers)
                       throws ee.ria.dhx.exception.DhxException

When all actions with contianer are complete, delete file which might be related to the container.

Parameters:

containers - list of container to cleanup

Throws:

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