org.adorsys.docusafe.transactional.impl

Class TransactionalDocumentSafeServiceImpl

java.lang.Object

org.adorsys.docusafe.transactional.impl.NonTransactionalDocumentSafeServiceImpl

org.adorsys.docusafe.transactional.impl.TransactionalDocumentSafeServiceImpl

All Implemented Interfaces:

NonTransactionalDocumentSafeService, TransactionalDocumentSafeService

public class TransactionalDocumentSafeServiceImpl
extends NonTransactionalDocumentSafeServiceImpl
implements TransactionalDocumentSafeService

Created by peter on 11.06.18 at 15:01.

Field Summary

Fields

Modifier and Type	Field and Description
static String	CURRENT_TRANSACTION_DATA

Fields inherited from class org.adorsys.docusafe.transactional.impl.NonTransactionalDocumentSafeServiceImpl

documentSafeService

Constructor Summary

Constructors

Constructor and Description
TransactionalDocumentSafeServiceImpl(RequestMemoryContext requestMemoryContext, DocumentSafeService documentSafeService)

Method Summary

Modifier and Type	Method and Description
void	beginTransaction(org.adorsys.docusafe.service.api.types.UserIDAuth userIDAuth)
void	endTransaction(org.adorsys.docusafe.service.api.types.UserIDAuth userIDAuth) Commits the running transaction and all its changes.
TxDocumentFQNVersion	getVersion(org.adorsys.docusafe.service.api.types.UserIDAuth userIDAuth, DocumentFQN documentFQN) returns the Version number of the Document or throws a FileNotFoundException
static DSDocument	modifyTxDocument(DSDocument dsDocument, TxID txid)
static DocumentFQN	modifyTxDocumentName(DocumentFQN origName, TxID txid)
static DocumentFQN	modifyTxMetaDocumentName(DocumentFQN origName, TxID txid)
void	txDeleteDocument(org.adorsys.docusafe.service.api.types.UserIDAuth userIDAuth, DocumentFQN documentFQN) Deletes a single file
void	txDeleteFolder(org.adorsys.docusafe.service.api.types.UserIDAuth userIDAuth, DocumentDirectoryFQN documentDirectoryFQN) All files in this folder und folders below this folder will be deleted Actually folders do not exist unless they contain a file or folder that eventually contains a file
boolean	txDocumentExists(org.adorsys.docusafe.service.api.types.UserIDAuth userIDAuth, DocumentFQN documentFQN) Checks the existance of a file
TxBucketContentFQN	txListDocuments(org.adorsys.docusafe.service.api.types.UserIDAuth userIDAuth, DocumentDirectoryFQN documentDirectoryFQN, de.adorsys.dfs.connection.api.types.ListRecursiveFlag recursiveFlag) Seeks all Files and Folders starting from a given root.
DSDocument	txMoveDocumentFromInbox(org.adorsys.docusafe.service.api.types.UserIDAuth userIDAuth, DocumentFQN source, DocumentFQN destination) After this call, the file is copied from the inbox to the user tx space.
void	txMoveDocumentToInboxOfUser(org.adorsys.docusafe.service.api.types.UserIDAuth userIDAuth, org.adorsys.docusafe.service.api.types.UserID receiverUserID, DocumentFQN sourceDocumentFQN, DocumentFQN destDocumentFQN, MoveType moveType) After this call, the file is copied or moved to the new user.
DSDocument	txReadDocument(org.adorsys.docusafe.service.api.types.UserIDAuth userIDAuth, DocumentFQN documentFQN) Reads the content of a document
void	txStoreDocument(org.adorsys.docusafe.service.api.types.UserIDAuth userIDAuth, DSDocument dsDocument) writes byted to a file and stores the given Metadata with that file

Methods inherited from class org.adorsys.docusafe.transactional.impl.NonTransactionalDocumentSafeServiceImpl

createUser, destroyUser, nonTxListInbox, userExists

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.adorsys.docusafe.transactional.NonTransactionalDocumentSafeService

createUser, destroyUser, nonTxListInbox, userExists

Field Detail

CURRENT_TRANSACTION_DATA

public static final String CURRENT_TRANSACTION_DATA

See Also:

Constant Field Values

Constructor Detail

TransactionalDocumentSafeServiceImpl

public TransactionalDocumentSafeServiceImpl(RequestMemoryContext requestMemoryContext,
                                            DocumentSafeService documentSafeService)

Method Detail

beginTransaction

public void beginTransaction(org.adorsys.docusafe.service.api.types.UserIDAuth userIDAuth)

Specified by:

beginTransaction in interface TransactionalDocumentSafeService

txStoreDocument

public void txStoreDocument(org.adorsys.docusafe.service.api.types.UserIDAuth userIDAuth,
                            DSDocument dsDocument)

Description copied from interface: TransactionalDocumentSafeService

writes byted to a file and stores the given Metadata with that file

Specified by:

txStoreDocument in interface TransactionalDocumentSafeService

Parameters:

userIDAuth - user and password

dsDocument - data and metadata and FQN to be stored

txReadDocument

public DSDocument txReadDocument(org.adorsys.docusafe.service.api.types.UserIDAuth userIDAuth,
                                 DocumentFQN documentFQN)

Description copied from interface: TransactionalDocumentSafeService

Reads the content of a document

Specified by:

txReadDocument in interface TransactionalDocumentSafeService

Parameters:

userIDAuth - user and password

documentFQN - file to be read

Returns:

an Object containing the metadata and the data

txDeleteDocument

public void txDeleteDocument(org.adorsys.docusafe.service.api.types.UserIDAuth userIDAuth,
                             DocumentFQN documentFQN)

Description copied from interface: TransactionalDocumentSafeService

Deletes a single file

Specified by:

txDeleteDocument in interface TransactionalDocumentSafeService

Parameters:

userIDAuth - user and password

documentFQN - file to be deleted

txListDocuments

public TxBucketContentFQN txListDocuments(org.adorsys.docusafe.service.api.types.UserIDAuth userIDAuth,
                                          DocumentDirectoryFQN documentDirectoryFQN,
                                          de.adorsys.dfs.connection.api.types.ListRecursiveFlag recursiveFlag)

Description copied from interface: TransactionalDocumentSafeService

Seeks all Files and Folders starting from a given root.

Specified by:

txListDocuments in interface TransactionalDocumentSafeService

Parameters:

userIDAuth - user and password

documentDirectoryFQN - folder to list

recursiveFlag - flag, to search deep or not

Returns:

an Object, that contains a list for all files and a list for all folders that are below the documentDirectoryFQN

getVersion

public TxDocumentFQNVersion getVersion(org.adorsys.docusafe.service.api.types.UserIDAuth userIDAuth,
                                       DocumentFQN documentFQN)

Description copied from interface: TransactionalDocumentSafeService

returns the Version number of the Document or throws a FileNotFoundException

Specified by:

getVersion in interface TransactionalDocumentSafeService

Parameters:

userIDAuth - user and password

documentFQN - the document, the version is requested for

Returns:

the Version number

txDocumentExists

public boolean txDocumentExists(org.adorsys.docusafe.service.api.types.UserIDAuth userIDAuth,
                                DocumentFQN documentFQN)

Description copied from interface: TransactionalDocumentSafeService

Checks the existance of a file

Specified by:

txDocumentExists in interface TransactionalDocumentSafeService

Parameters:

userIDAuth - user and password

documentFQN - name of the file

Returns:

true, if the file exists, false otherwise

txDeleteFolder

public void txDeleteFolder(org.adorsys.docusafe.service.api.types.UserIDAuth userIDAuth,
                           DocumentDirectoryFQN documentDirectoryFQN)

Description copied from interface: TransactionalDocumentSafeService

All files in this folder und folders below this folder will be deleted Actually folders do not exist unless they contain a file or folder that eventually contains a file

Specified by:

txDeleteFolder in interface TransactionalDocumentSafeService

Parameters:

userIDAuth - user and password

documentDirectoryFQN - name of the directory

endTransaction

public void endTransaction(org.adorsys.docusafe.service.api.types.UserIDAuth userIDAuth)

Description copied from interface: TransactionalDocumentSafeService

Commits the running transaction and all its changes. If during this transaction any files have been transfered from the nonTxContext, they will automaticly be destroyed after the commit. This "postcommit" action can not throw Exceptions.

Specified by:

endTransaction in interface TransactionalDocumentSafeService

Parameters:

userIDAuth - user and password

txMoveDocumentToInboxOfUser

public void txMoveDocumentToInboxOfUser(org.adorsys.docusafe.service.api.types.UserIDAuth userIDAuth,
                                        org.adorsys.docusafe.service.api.types.UserID receiverUserID,
                                        DocumentFQN sourceDocumentFQN,
                                        DocumentFQN destDocumentFQN,
                                        MoveType moveType)

Description copied from interface: TransactionalDocumentSafeService

After this call, the file is copied or moved to the new user. After the commit the file is (depending on the moveType) really deleted or not

Specified by:

txMoveDocumentToInboxOfUser in interface TransactionalDocumentSafeService

Parameters:

userIDAuth - user and password

receiverUserID - the new owner of the document

sourceDocumentFQN - the path of the file of the user

destDocumentFQN - the new path of the file for the new owner in its inbox

moveType - move oder keep_copy. keep_copy means, the file exists for both users

txMoveDocumentFromInbox

public DSDocument txMoveDocumentFromInbox(org.adorsys.docusafe.service.api.types.UserIDAuth userIDAuth,
                                          DocumentFQN source,
                                          DocumentFQN destination)

Description copied from interface: TransactionalDocumentSafeService

After this call, the file is copied from the inbox to the user tx space. now it exists in the inbox and the tx space. After the commit the file is deleted in the inbox automaticly

Specified by:

txMoveDocumentFromInbox in interface TransactionalDocumentSafeService

Parameters:

userIDAuth - user and password

source - file path in the inbox

destination - file path in the tx space

Returns:

the document, that has been moved

modifyTxDocument

public static DSDocument modifyTxDocument(DSDocument dsDocument,
                                          TxID txid)

modifyTxDocumentName

public static DocumentFQN modifyTxDocumentName(DocumentFQN origName,
                                               TxID txid)

modifyTxMetaDocumentName

public static DocumentFQN modifyTxMetaDocumentName(DocumentFQN origName,
                                                   TxID txid)