com.jurismarches.vradi.services
Interface VradiStorageService

All Known Implementing Classes:

VradiStorageServiceImpl

public interface VradiStorageService

Vradi storage service. This service is intended to be used in remote mode. Typical usage is code that can be run only on server :

• Openoffice template generation
• Mail sending

Version:

$Revision: 1715 $ $Date: 2010-10-27 21:21:28 +0200 (mer., 27 oct. 2010) $

Author:

morin

Method Summary

void	archiveQueries(QueryMaker queryMaker) Archives the queries of a user, client or group in a RSS file.
Session	bindForms(Session session) Binds all queryMaker with the forms found by their queries and not already sent.
boolean	checkTemplateExist(java.lang.String extensionName) Check if template file form extension name in param
java.util.List<Sending>	createAllSending(java.lang.String sessionId, Group group, java.util.List<java.lang.String> formsIdsToBind) Create new Sending
java.util.List<Status>	createDefaultStatuses() Create all default status.
Session	createNewSession()
Sending	createSending(java.lang.String sessionId, User user, java.util.List<java.lang.String> formsIdsToBind) Create new Sending
VradiUser	createUser(VradiUser user) Create a VradiUser.
void	deleteSession(java.lang.String sessionId) Delete session and sending associated This method return a VradiException if session to delete is not active
java.lang.String	exportAsCSV(org.nuiton.wikitty.Criteria criteria) Get csv export.
java.lang.String	exportClientDB() Export all the clients, users and groups in database
java.lang.String	generatePDF(java.lang.String formId, boolean force) Generate pdf file for specified form.
void	generatePDFForSession(java.lang.String sessionId) Generate all the PDFs needed to send a session.
java.util.Map<java.lang.String,java.lang.String>	getAssociatedFields(java.lang.String extensionName, java.lang.String templateName) Get association between template fields and extension fields.
java.util.List<java.lang.String>	getDocumentFields(org.nuiton.wikitty.WikittyExtension extension, java.lang.String templateName) Get template document fields names.
void	importAsCSV(java.lang.String uri) Import all data as CSV.
XmlStreamImportResult	importFormsFromWebHarvestStream(WebHarvestStream webHarvestStream) Creates and store forms from an WebHarvestXmlStream by using the XmlStreamBinding to link xml stream field values with form fields.
XmlStreamImportResult	importFormsFromXmlStream(XmlStream xmlStream) Creates and store forms from an XmlStream by using the XmlStreamBinding to link xml stream field values with form fields.
VradiUser	loginUser(java.lang.String login, java.lang.String md5Password) Checks if userName and userPassword matches a valid VradiUser.
void	receiveMessages()
void	reindexData() Reindex the datas.
java.util.List<Sending>	removeAllSending(java.lang.String sessionId, java.util.List<java.lang.String> formsIds, Group group) Remove all sending corresponding with form and group from session
boolean	removeFormsFromSession(java.lang.String session, java.util.List<java.lang.String> formsIds) Check if template file form extension name in param
Sending	removeSending(java.lang.String sessionId, java.util.List<java.lang.String> formsIds, User user) Remove sending corresponding with form and user from session
Sending	revertDeletion(java.lang.String sendingId, java.util.List<java.lang.String> formsIdsToUpdate) Method call to revert froms deleted in sending
java.util.List<Sending>	revertGroupDeletion(java.lang.String sessionId, java.lang.String groupId, java.lang.String formId) Revert forms deleted for group
Sending	revertUserDeletion(java.lang.String sessionId, java.lang.String userId, java.lang.String formId) Revert forms deleted for user
java.lang.String	sendMessage(java.lang.String sendingId, java.lang.String sessionParagraph) Send sending pass in param to sending user email
java.lang.String	sendMessage(java.lang.String sendingId, java.lang.String sessionParagraph, java.lang.String email) Send sending pass in param to specific email
java.lang.String	sendMessages(java.lang.String sessionId) Send session pass in param
void	setAssociatedFields(java.lang.String extensionName, java.lang.String templateName, java.util.Map<java.lang.String,java.lang.String> fieldMap) Save association between template fields and extensions fields.
Session	stopSentMail(Session session)

Method Detail

createDefaultStatuses

java.util.List<Status> createDefaultStatuses()
                                             throws VradiException

Create all default status.

Returns:

all status

Throws:

VradiException

bindForms

Session bindForms(Session session)
                  throws VradiException

Binds all queryMaker with the forms found by their queries and not already sent.

Throws:

VradiException

createAllSending

java.util.List<Sending> createAllSending(java.lang.String sessionId,
                                         Group group,
                                         java.util.List<java.lang.String> formsIdsToBind)
                                         throws VradiException

Create new Sending

Parameters:

session -

group -

formsIdsToBind -

Returns:

Throws:

VradiException

createSending

Sending createSending(java.lang.String sessionId,
                      User user,
                      java.util.List<java.lang.String> formsIdsToBind)
                      throws VradiException

Create new Sending

Parameters:

session -

user -

formsIdsToBind -

Returns:

Throws:

VradiException

createNewSession

Session createNewSession()
                         throws VradiException

Throws:

VradiException

importFormsFromWebHarvestStream

XmlStreamImportResult importFormsFromWebHarvestStream(WebHarvestStream webHarvestStream)
                                                      throws VradiException

Creates and store forms from an WebHarvestXmlStream by using the XmlStreamBinding to link xml stream field values with form fields. Input xmlStream is modified by this method (wikitty obselete).

Parameters:

webHarvestStream - stream to import

Returns:

a structure containing : - the number of created forms - the number of already existing forms - the number of forms created with date parsing error - the number of forms created with number parsing error

Throws:

VradiException - for various possible errors

getAssociatedFields

java.util.Map<java.lang.String,java.lang.String> getAssociatedFields(java.lang.String extensionName,
                                                                     java.lang.String templateName)
                                                                     throws VradiException

Get association between template fields and extension fields.

Parameters:

extensionName -

templateName -

Returns:

association map or null is there is no association yet

Throws:

VradiException

importFormsFromXmlStream

XmlStreamImportResult importFormsFromXmlStream(XmlStream xmlStream)
                                               throws VradiException

Creates and store forms from an XmlStream by using the XmlStreamBinding to link xml stream field values with form fields. Input xmlStream is modified by this method (wikitty obselete).

Parameters:

xmlStream - stream to import

Returns:

a structure containing : - the number of created forms - the number of already existing forms - the number of forms created with date parsing error - the number of forms created with number parsing error

Throws:

VradiException - for various possible errors

createUser

VradiUser createUser(VradiUser user)
                     throws VradiException

Create a VradiUser.

Parameters:

user - the user to create

Returns:

the vradiUser updated or null if user can't be created (already exists)

Throws:

VradiException

loginUser

VradiUser loginUser(java.lang.String login,
                    java.lang.String md5Password)
                    throws VradiException

Checks if userName and userPassword matches a valid VradiUser.

Parameters:

login - the login of a WikittyUser

md5Password - the password of a WikittyUser (md5 encoded)

Returns:

a WikittyUser or null if either userName or userPassword don't match

Throws:

VradiException

importAsCSV

void importAsCSV(java.lang.String uri)
                 throws VradiException

Import all data as CSV. FIXME EC-20100415 will not work in remote mode (or uri maybe be valid for remote server too)

Parameters:

uri - uri used to read input stream

Throws:

VradiException - if any error happen during import

exportAsCSV

java.lang.String exportAsCSV(org.nuiton.wikitty.Criteria criteria)
                             throws VradiException

Get csv export.

Parameters:

criteria - export criteria

Returns:

csv export

Throws:

VradiException - if any error happen during export

reindexData

void reindexData()
                 throws VradiException

Reindex the datas.

Throws:

VradiException

archiveQueries

void archiveQueries(QueryMaker queryMaker)
                    throws VradiException

Archives the queries of a user, client or group in a RSS file.

Parameters:

queryMaker - the query maker whose queries are archived

Throws:

VradiException

setAssociatedFields

void setAssociatedFields(java.lang.String extensionName,
                         java.lang.String templateName,
                         java.util.Map<java.lang.String,java.lang.String> fieldMap)
                         throws VradiException

Save association between template fields and extensions fields.

Parameters:

extensionName -

templateName -

fieldMap -

Throws:

VradiException

generatePDF

java.lang.String generatePDF(java.lang.String formId,
                             boolean force)
                             throws VradiException

Generate pdf file for specified form.

Parameters:

formId - form id to generate pdf

force - force regeneration

Returns:

uri to download file

Throws:

VradiException

removeAllSending

java.util.List<Sending> removeAllSending(java.lang.String sessionId,
                                         java.util.List<java.lang.String> formsIds,
                                         Group group)
                                         throws VradiException

Remove all sending corresponding with form and group from session

Parameters:

session - concerned

formsIds - concerned

queryMaker - concerned

Returns:

List of sending after deletion

Throws:

VradiException

removeSending

Sending removeSending(java.lang.String sessionId,
                      java.util.List<java.lang.String> formsIds,
                      User user)
                      throws VradiException

Remove sending corresponding with form and user from session

Parameters:

session - concerned

formsIds - concerned

queryMaker - concerned

Returns:

sending after deletion

Throws:

VradiException

getDocumentFields

java.util.List<java.lang.String> getDocumentFields(org.nuiton.wikitty.WikittyExtension extension,
                                                   java.lang.String templateName)
                                                   throws VradiException

Get template document fields names.

Parameters:

extension - extension

templateName - template name

Returns:

field names

Throws:

VradiException

sendMessages

java.lang.String sendMessages(java.lang.String sessionId)
                              throws VradiException

Send session pass in param

Parameters:

sessionId - session id concerned

Returns:

Logged messages

Throws:

VradiException - exception is occured

sendMessage

java.lang.String sendMessage(java.lang.String sendingId,
                             java.lang.String sessionParagraph)
                             throws VradiException

Send sending pass in param to sending user email

Parameters:

sendingId - sending id concerned

sessionParagraph - paragraph to send

Returns:

Logged messages

Throws:

VradiException - exception is occured

sendMessage

java.lang.String sendMessage(java.lang.String sendingId,
                             java.lang.String sessionParagraph,
                             java.lang.String email)
                             throws VradiException

Send sending pass in param to specific email

Parameters:

sendingId - sending id concerned

sessionParagraph - paragraph to send

email - specific

Returns:

Logged messages

Throws:

VradiException - exception is occured

receiveMessages

void receiveMessages()
                     throws VradiException

Throws:

VradiException

stopSentMail

Session stopSentMail(Session session)
                     throws VradiException

Throws:

VradiException

generatePDFForSession

void generatePDFForSession(java.lang.String sessionId)
                           throws VradiException

Generate all the PDFs needed to send a session.

Parameters:

sessionId - the session wikitty id

Throws:

VradiException

exportClientDB

java.lang.String exportClientDB()
                                throws VradiException

Export all the clients, users and groups in database

Returns:

the csv export as a String

Throws:

VradiException - if any error happen during export

deleteSession

void deleteSession(java.lang.String sessionId)
                   throws VradiException

Delete session and sending associated This method return a VradiException if session to delete is not active

Parameters:

sessionId - to delete

Throws:

VradiException - if an error occur during session deletion

checkTemplateExist

boolean checkTemplateExist(java.lang.String extensionName)
                           throws VradiException

Check if template file form extension name in param

Parameters:

extensionName - to check

Returns:

true if file exist

Throws:

VradiException - if an error occur during checking template

removeFormsFromSession

boolean removeFormsFromSession(java.lang.String session,
                               java.util.List<java.lang.String> formsIds)
                               throws VradiException

Check if template file form extension name in param

Parameters:

formsIds - to update

Returns:

false if no session opened found

Throws:

VradiException - if an error occur during checking template

revertDeletion

Sending revertDeletion(java.lang.String sendingId,
                       java.util.List<java.lang.String> formsIdsToUpdate)

Method call to revert froms deleted in sending

Parameters:

sendingId - to update

formsIdsToUpdate - deleted to revert

Returns:

updated sending

revertUserDeletion

Sending revertUserDeletion(java.lang.String sessionId,
                           java.lang.String userId,
                           java.lang.String formId)

Revert forms deleted for user

Parameters:

sessionId - session concerned

userId - user concerned

formId - form to revert

Returns:

sending impacted

revertGroupDeletion

java.util.List<Sending> revertGroupDeletion(java.lang.String sessionId,
                                            java.lang.String groupId,
                                            java.lang.String formId)

Revert forms deleted for group

Parameters:

sessionId - session concerned

groupId - user concerned

formId - form to revert

Returns:

sending impacted