org.adorsys.docusafe.transactional

Interface TransactionalDocumentSafeService

All Superinterfaces:

NonTransactionalDocumentSafeService

All Known Implementing Classes:

TransactionalDocumentSafeServiceImpl

public interface TransactionalDocumentSafeService
extends NonTransactionalDocumentSafeService

Created by peter on 11.06.18 at 14:56.

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
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 interface org.adorsys.docusafe.transactional.NonTransactionalDocumentSafeService

createUser, destroyUser, nonTxListInbox, userExists

Method Detail

beginTransaction

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

txStoreDocument

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

Parameters:

userIDAuth - user and password

dsDocument - data and metadata and FQN to be stored

txReadDocument

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

Reads the content of a document

Parameters:

userIDAuth - user and password

documentFQN - file to be read

Returns:

an Object containing the metadata and the data

txDeleteDocument

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

Deletes a single file

Parameters:

userIDAuth - user and password

documentFQN - file to be deleted

txListDocuments

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.

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

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

returns the Version number of the Document or throws a FileNotFoundException

Parameters:

userIDAuth - user and password

documentFQN - the document, the version is requested for

Returns:

the Version number

txDocumentExists

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

Checks the existance of a file

Parameters:

userIDAuth - user and password

documentFQN - name of the file

Returns:

true, if the file exists, false otherwise

txDeleteFolder

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

Parameters:

userIDAuth - user and password

documentDirectoryFQN - name of the directory

endTransaction

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

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.

Parameters:

userIDAuth - user and password

txMoveDocumentToInboxOfUser

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. After the commit the file is (depending on the moveType) really deleted or not

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

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. now it exists in the inbox and the tx space. After the commit the file is deleted in the inbox automaticly

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