org.nuiton.wikitty
Interface WikittyService

All Known Implementing Classes:

WikittyServiceCached, WikittyServiceDelegator, WikittyServiceImpl, WikittyServiceInMemory, WikittyServiceNotifier, WikittyServiceSecurity

public interface WikittyService

Wikitty service. The main implementation for this interface is WikittyServiceImpl. It can be used alone but this implementation doesn't deal with all stuffs described in this interface. Thus, other functionalities are added to the implementation through objects that decorate WikittyServiceImpl :

WikittyServiceCached

add a cache for wikitties

WikittyServiceSecurity

add user authentication support and right management

WikittyServiceNotifier

add notifications between client of the same wikitty service

Version:

$Revision: 441 $ Last update: $Date: 2010-10-21 12:35:22 +0200 (jeu., 21 oct. 2010) $ by : $Author: bpoussin $

Author:

poussin

Nested Class Summary

static class

WikittyService.ServiceListenerType Event listener type.

Method Summary

void	addWikittyServiceListener(WikittyServiceListener listener, WikittyService.ServiceListenerType type) Add new wikitty service listener.
boolean	canDelete(java.lang.String securityToken, java.lang.String wikittyId) Verifie que l'utilisateur associe au securityToken peut supprimer le wikitty dont on passe l'identifiant.
boolean	canRead(java.lang.String securityToken, java.lang.String wikittyId) Un utilisateur peu lire un objet, s'il est Reader ou a defaut: - owner - AppAdmin - Admin - Writer
boolean	canWrite(java.lang.String securityToken, Wikitty wikitty) Verifie si l'utilisateur lie au securityToken a le droit d'ecrire le Wikitty passe en argument
void	clear(java.lang.String securityToken) Use with caution : It will delete ALL indexes from search engine !
void	delete(java.lang.String securityToken, java.util.Collection<java.lang.String> ids) Delete all object if id exists.
void	delete(java.lang.String securityToken, java.lang.String id) Delete object if id exists.
java.util.List<java.lang.String>	deleteTree(java.lang.String securityToken, java.lang.String treeNodeId) Delete specified tree node and all sub nodes.
PagedResult<java.lang.String>	findAllByCriteria(java.lang.String securityToken, Criteria criteria)
PagedResult<java.lang.String>	findAllByCriteria(java.lang.String securityToken, WikittyTransaction transaction, Criteria criteria)
Wikitty	findByCriteria(java.lang.String securityToken, Criteria criteria) Fist lonely (or first one) wikitty object that match criteria, if no wikitty found or first retrived is not authorized for the user return null
Wikitty	findByCriteria(java.lang.String securityToken, WikittyTransaction transaction, Criteria criteria) Fist lonely (or first one) wikitty object that match criteria, if no wikitty found or first retrived is not authorized for the user return null
java.util.List<java.lang.String>	getAllExtensionIds(java.lang.String securityToken) Return all extension id (ex: "extName[version])").
java.util.List<java.lang.String>	getAllExtensionsRequires(java.lang.String securityToken, java.lang.String extensionName) Return all extension id (ex: "extName[version])") where extensionName is required.
java.lang.String	login(java.lang.String login, java.lang.String password) Authenticate someone on WikittyService. securityToken returned must be used to call others methods
void	logout(java.lang.String securityToken) Unanthenticate someone by disabled securityToken
void	removeWikittyServiceListener(WikittyServiceListener listener, WikittyService.ServiceListenerType type) Remove wikitty service listener.
java.util.List<Wikitty>	restore(java.lang.String securityToken, java.util.List<java.lang.String> id)
Wikitty	restore(java.lang.String securityToken, java.lang.String id)
java.util.List<Wikitty>	restore(java.lang.String securityToken, WikittyTransaction transaction, java.util.List<java.lang.String> id) Restore wikitty using opened transaction.
java.util.Map<WikittyTreeNode,java.lang.Integer>	restoreChildren(java.lang.String securityToken, java.lang.String wikittyId, Criteria filter) Retrieve all wikitties children with count (no recursively) of an other one Wikitty reference by wikittyId MUST include the 'Node' extension
WikittyExtension	restoreExtension(java.lang.String securityToken, java.lang.String extensionId) Load extension from id.
WikittyExtension	restoreExtension(java.lang.String securityToken, WikittyTransaction transaction, java.lang.String extensionId) Action is done in transaction passed in argument.
WikittyExtension	restoreExtensionLastVersion(java.lang.String securityToken, java.lang.String name) Search extension with name in last version.
WikittyExtension	restoreExtensionLastVersion(java.lang.String securityToken, WikittyTransaction transaction, java.lang.String name) Search extension with name in last version.
java.util.Map.Entry<WikittyTreeNode,java.lang.Integer>	restoreNode(java.lang.String securityToken, java.lang.String wikittyId, Criteria filter) Retrieve wikitty node with count.
WikittyTree	restoreTree(java.lang.String securityToken, java.lang.String wikittyId) Retrieve all wikitties children (recursively) of an other one Wikitty reference by wikittyId MUST include the 'Node' extension
Wikitty	restoreVersion(java.lang.String securityToken, java.lang.String wikittyId, java.lang.String version) Restore wikitty in specifique version.
UpdateResponse	store(java.lang.String securityToken, java.util.Collection<Wikitty> wikitties) Manage Update and creation.
UpdateResponse	store(java.lang.String securityToken, java.util.Collection<Wikitty> wikitties, boolean force) Manage Update and creation.
UpdateResponse	store(java.lang.String securityToken, Wikitty wikitty) Manage Update and creation.
UpdateResponse	store(java.lang.String securityToken, WikittyTransaction transaction, java.util.Collection<Wikitty> wikitties, boolean force) Manage Update and creation, action is done in transaction passed in argument.
UpdateResponse	storeExtension(java.lang.String securityToken, java.util.Collection<WikittyExtension> exts) Manage Update and creation.
UpdateResponse	storeExtension(java.lang.String securityToken, WikittyExtension ext) Manage Update and creation.
UpdateResponse	storeExtension(java.lang.String securityToken, WikittyTransaction transaction, java.util.Collection<WikittyExtension> exts) Manage Update and creation, action is done in transaction passed in argument
UpdateResponse	syncEngin(java.lang.String securityToken) Synchronise search engine with wikitty storage engine, i.e. clear and reindex all wikitties.

Method Detail

addWikittyServiceListener

void addWikittyServiceListener(WikittyServiceListener listener,
                               WikittyService.ServiceListenerType type)

Add new wikitty service listener. Warning, listener is referenced as WeakReference, but sure to another reference to work.

Parameters:

listener - listener to add

type - type of event to listen

See Also:

WikittyService.ServiceListenerType

removeWikittyServiceListener

void removeWikittyServiceListener(WikittyServiceListener listener,
                                  WikittyService.ServiceListenerType type)

Remove wikitty service listener. Warning, listener is referenced as WeakReference, but sure to another reference to work.

Parameters:

listener - listener to remove

type - type of event to listen

See Also:

WikittyService.ServiceListenerType

login

java.lang.String login(java.lang.String login,
                       java.lang.String password)

Authenticate someone on WikittyService. securityToken returned must be used to call others methods

Parameters:

login - can be application specifique login, but best practice is to use email user

password -

Returns:

return token securityToken

logout

void logout(java.lang.String securityToken)

Unanthenticate someone by disabled securityToken

Parameters:

securityToken - security token previously returned by login. If securityToken is not valid, this method do nothing

clear

void clear(java.lang.String securityToken)

Use with caution : It will delete ALL indexes from search engine ! This operation should be disabled in production environment.

Parameters:

securityToken - security token

canWrite

boolean canWrite(java.lang.String securityToken,
                 Wikitty wikitty)

Verifie si l'utilisateur lie au securityToken a le droit d'ecrire le Wikitty passe en argument

Parameters:

securityToken - le token de securite qui permet de retrouver l'utilisateur et ainsi verifier les droits

wikitty - le wikitty a sauver

Returns:

vrai si l'utilisateur peut sauver l'objet

canDelete

boolean canDelete(java.lang.String securityToken,
                  java.lang.String wikittyId)

Verifie que l'utilisateur associe au securityToken peut supprimer le wikitty dont on passe l'identifiant. Seul le propriétaire de l'objet ou un admin peut supprimer un objet. Si l'id de l'objet est invalide, la methode retourne true, car la suppression d'un id invalide ne fait rien

Parameters:

securityToken - security token

wikittyId - wikitty id

Returns:

vrai le la suppression ne posera pas de probleme.

canRead

boolean canRead(java.lang.String securityToken,
                java.lang.String wikittyId)

Un utilisateur peu lire un objet, s'il est Reader ou a defaut: - owner - AppAdmin - Admin - Writer

Parameters:

securityToken - security token

wikittyId - wikitty id

Returns:

vrai si l'utilisateur peut lire l'obbjet

store

UpdateResponse store(java.lang.String securityToken,
                     Wikitty wikitty)

Manage Update and creation.

Parameters:

securityToken - security token

wikitty - contains an id all the time.

Returns:

update response containing version and id of stored wikitty

store

UpdateResponse store(java.lang.String securityToken,
                     java.util.Collection<Wikitty> wikitties)

Manage Update and creation.

Parameters:

securityToken - security token

wikitties - list of wikitty to be persisted

Returns:

update response containing version and id of stored wikitty

store

UpdateResponse store(java.lang.String securityToken,
                     java.util.Collection<Wikitty> wikitties,
                     boolean force)

Manage Update and creation.

Parameters:

securityToken - security token

wikitties - list of wikitty to be persisted

force - boolean force non version version increment on saved wikitty or force version on wikitty creation (version 0.0)

Returns:

update response

store

UpdateResponse store(java.lang.String securityToken,
                     WikittyTransaction transaction,
                     java.util.Collection<Wikitty> wikitties,
                     boolean force)

Manage Update and creation, action is done in transaction passed in argument.

Parameters:

securityToken - security token

transaction - transaction used to do the action (must not be null)

wikitties - list of wikitty to be persisted

force - boolean force non version version increment on saved wikitty or force version on wikitty creation (version 0.0)

Returns:

update response

getAllExtensionIds

java.util.List<java.lang.String> getAllExtensionIds(java.lang.String securityToken)

Return all extension id (ex: "extName[version])").

Parameters:

securityToken - security token

Returns:

extension ids list

getAllExtensionsRequires

java.util.List<java.lang.String> getAllExtensionsRequires(java.lang.String securityToken,
                                                          java.lang.String extensionName)

Return all extension id (ex: "extName[version])") where extensionName is required.

Parameters:

securityToken - security token

extensionName - extension name

Returns:

extension id list

storeExtension

UpdateResponse storeExtension(java.lang.String securityToken,
                              WikittyExtension ext)

Manage Update and creation.

Parameters:

securityToken - security token

ext - extension to be persisted

Returns:

update response

storeExtension

UpdateResponse storeExtension(java.lang.String securityToken,
                              java.util.Collection<WikittyExtension> exts)

Manage Update and creation.

Parameters:

securityToken - security token

exts - list of wikitty extension to be persisted

Returns:

update response

storeExtension

UpdateResponse storeExtension(java.lang.String securityToken,
                              WikittyTransaction transaction,
                              java.util.Collection<WikittyExtension> exts)

Manage Update and creation, action is done in transaction passed in argument

Parameters:

securityToken - security token

transaction - transaction used to do the action (must not be null)

exts - list of wikitty extension to be persisted

Returns:

update response

restoreExtension

WikittyExtension restoreExtension(java.lang.String securityToken,
                                  java.lang.String extensionId)

Load extension from id. Id is 'name[version]'.

Parameters:

securityToken - security token

extensionId - extension id to restore

Returns:

the corresponding object, exception if no such object found.

restoreExtension

WikittyExtension restoreExtension(java.lang.String securityToken,
                                  WikittyTransaction transaction,
                                  java.lang.String extensionId)

Action is done in transaction passed in argument.

Parameters:

securityToken - security token

transaction - transaction used to do the action (must not be null)

extensionId -

Returns:

the corresponding object, exception if no such object found.

restoreExtensionLastVersion

WikittyExtension restoreExtensionLastVersion(java.lang.String securityToken,
                                             java.lang.String name)

Search extension with name in last version.

Parameters:

securityToken - security token

name - extension name

Returns:

the corresponding object, exception if no such object found.

restoreExtensionLastVersion

WikittyExtension restoreExtensionLastVersion(java.lang.String securityToken,
                                             WikittyTransaction transaction,
                                             java.lang.String name)

Search extension with name in last version.

Parameters:

securityToken - security token

transaction - transaction used to do the action (must not be null)

name - extension name

Returns:

the corresponding object, exception if no such object found.

restore

Wikitty restore(java.lang.String securityToken,
                java.lang.String id)

Parameters:

securityToken - security token

id - object id to restore

Returns:

the corresponding object, or null if object doesn't exist, is deleted or you don't have authorisation (you can check authorisation before call restore with canRead(java.lang.String, java.lang.String)

restore

java.util.List<Wikitty> restore(java.lang.String securityToken,
                                java.util.List<java.lang.String> id)

Parameters:

securityToken - security token

id - list of wikitty ids to restore

Returns:

list of corresponding wikitty, if one id is not valid (no object or deleted or no authorisation) this id is skip and result list have less elements than collection argument

restore

java.util.List<Wikitty> restore(java.lang.String securityToken,
                                WikittyTransaction transaction,
                                java.util.List<java.lang.String> id)

Restore wikitty using opened transaction.

Parameters:

securityToken - security token

transaction - transaction to use

id - list of wikitty ids to restore

Returns:

list of corresponding wikitty, if one id is not valid (no object or deleted or no authorisation) this id is skip and result list have less elements than collection argument

delete

void delete(java.lang.String securityToken,
            java.lang.String id)

Delete object if id exists.

Parameters:

securityToken - security token

id - object's id to remove

delete

void delete(java.lang.String securityToken,
            java.util.Collection<java.lang.String> ids)

Delete all object if id exists.

Parameters:

securityToken - security token

ids - object's ids to remove

findAllByCriteria

PagedResult<java.lang.String> findAllByCriteria(java.lang.String securityToken,
                                                Criteria criteria)

Parameters:

securityToken - security token

criteria -

Returns:

findAllByCriteria

PagedResult<java.lang.String> findAllByCriteria(java.lang.String securityToken,
                                                WikittyTransaction transaction,
                                                Criteria criteria)

Parameters:

securityToken - security token

transaction -

criteria -

Returns:

findByCriteria

Wikitty findByCriteria(java.lang.String securityToken,
                       Criteria criteria)

Fist lonely (or first one) wikitty object that match criteria, if no wikitty found or first retrived is not authorized for the user return null

Parameters:

securityToken - security token

criteria -

Returns:

wikitty object or null

findByCriteria

Wikitty findByCriteria(java.lang.String securityToken,
                       WikittyTransaction transaction,
                       Criteria criteria)

Fist lonely (or first one) wikitty object that match criteria, if no wikitty found or first retrived is not authorized for the user return null

Parameters:

securityToken - security token

criteria -

transaction -

Returns:

wikitty object or null

restoreTree

WikittyTree restoreTree(java.lang.String securityToken,
                        java.lang.String wikittyId)

Retrieve all wikitties children (recursively) of an other one Wikitty reference by wikittyId MUST include the 'Node' extension

Parameters:

securityToken - security token

wikittyId -

Returns:

deleteTree

java.util.List<java.lang.String> deleteTree(java.lang.String securityToken,
                                            java.lang.String treeNodeId)

Delete specified tree node and all sub nodes.

Parameters:

securityToken - security token

treeNodeId - tree node id to delete

Returns:

delete wikitty ids

restoreNode

java.util.Map.Entry<WikittyTreeNode,java.lang.Integer> restoreNode(java.lang.String securityToken,
                                                                   java.lang.String wikittyId,
                                                                   Criteria filter)

Retrieve wikitty node with count. Wikitty reference by wikittyId MUST include the 'Node' extension.

Parameters:

securityToken - security token

wikittyId -

Returns:

restoreChildren

java.util.Map<WikittyTreeNode,java.lang.Integer> restoreChildren(java.lang.String securityToken,
                                                                 java.lang.String wikittyId,
                                                                 Criteria filter)

Retrieve all wikitties children with count (no recursively) of an other one Wikitty reference by wikittyId MUST include the 'Node' extension

Parameters:

securityToken - security token

wikittyId -

Returns:

restoreVersion

Wikitty restoreVersion(java.lang.String securityToken,
                       java.lang.String wikittyId,
                       java.lang.String version)

Restore wikitty in specifique version. Authorisation is checked on last version even for previous wikitty version

Parameters:

securityToken - security token

syncEngin

UpdateResponse syncEngin(java.lang.String securityToken)

Synchronise search engine with wikitty storage engine, i.e. clear and reindex all wikitties.

Parameters:

securityToken - security token

Returns:

update response