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(UserIDAuth userIDAuth)
void	endTransaction(UserIDAuth userIDAuth) Commits the running transaction and all its changes.
TxDocumentFQNVersion	getVersion(UserIDAuth userIDAuth, DocumentFQN documentFQN) returns the Version number of the Document or throws a FileNotFoundException
void	transferFromNonTxToTx(UserIDAuth userIDAuth, DocumentFQN nonTxFQN, DocumentFQN txFQN) Gets a file from the nonTx Context and stores it in the tx Context.
void	txDeleteDocument(UserIDAuth userIDAuth, DocumentFQN documentFQN) Deletes a single file
void	txDeleteFolder(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(UserIDAuth userIDAuth, DocumentFQN documentFQN) Checks the existance of a file
TxBucketContentFQN	txListDocuments(UserIDAuth userIDAuth, DocumentDirectoryFQN documentDirectoryFQN, org.adorsys.encobject.types.ListRecursiveFlag recursiveFlag) Seeks all Files and Folders starting from a given root.
DSDocument	txReadDocument(UserIDAuth userIDAuth, DocumentFQN documentFQN) Reads the content of a document
void	txStoreDocument(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, findPublicEncryptionKey, grantAccessToNonTxFolder, nonTxDeleteDocument, nonTxDeleteFolder, nonTxDocumentExists, nonTxDocumentExists, nonTxListDocuments, nonTxReadDocument, nonTxReadDocument, nonTxStoreDocument, nonTxStoreDocument, userExists

Method Detail

beginTransaction

void beginTransaction(UserIDAuth userIDAuth)

txStoreDocument

void txStoreDocument(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(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(UserIDAuth userIDAuth,
                      DocumentFQN documentFQN)

Deletes a single file

Parameters:

userIDAuth - user and password

documentFQN - file to be deleted

txListDocuments

TxBucketContentFQN txListDocuments(UserIDAuth userIDAuth,
                                   DocumentDirectoryFQN documentDirectoryFQN,
                                   org.adorsys.encobject.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(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(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(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

transferFromNonTxToTx

void transferFromNonTxToTx(UserIDAuth userIDAuth,
                           DocumentFQN nonTxFQN,
                           DocumentFQN txFQN)

Gets a file from the nonTx Context and stores it in the tx Context. After this call, the file exists in both spaces (tx and nonTx). After the commit, this file will be deleted automaticly.

Parameters:

userIDAuth - user and password

nonTxFQN - name of the file in the non transactional context (e.g. source)

txFQN - name of the file in the transactional context (e.g. destination)

endTransaction

void endTransaction(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