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: 281 $ Last update: $Date: 2010-09-02 18:24:08 +0200 (jeu., 02 sept. 2010) $ by : $Author: echatellier $

Author:

poussin

Nested Class Summary

static class

WikittyService.ServiceListenerType Event listener type.

Method Summary

void	addLabel(String securityToken, String wikittyId, String label) add new lable to the wikitty object
void	addWikittyServiceListener(WikittyServiceListener listener, WikittyService.ServiceListenerType type) Add new wikitty service listener.
boolean	canDelete(String securityToken, String wikittyId) Verifie que l'utilisateur associe au securityToken peut supprimer le wikitty dont on passe l'identifiant.
boolean	canRead(String securityToken, String wikittyId) Un utilisateur peu lire un objet, s'il est Reader ou a defaut: - owner - AppAdmin - Admin - Writer
boolean	canWrite(String securityToken, Wikitty wikitty) Verifie si l'utilisateur lie au securityToken a le droit d'ecrire le Wikitty passe en argument
void	clear(String securityToken) Use with caution : It will delete ALL indexes from search engine !
void	delete(String securityToken, Collection<String> ids) delete all object if id exists
void	delete(String securityToken, String id) delete object if id exists
Set<String>	findAllAppliedLabels(String securityToken, String wikittyId) retrieve all labels applied on a wikitty object
PagedResult<String>	findAllByCriteria(String securityToken, Criteria criteria)
PagedResult<String>	findAllByCriteria(String securityToken, WikittyTransaction transaction, Criteria criteria)
PagedResult<String>	findAllByLabel(String securityToken, String label, int firstIndex, int endIndex)
Wikitty	findByCriteria(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(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
Wikitty	findByLabel(String securityToken, String label)
List<String>	getAllExtensionIds(String securityToken) Return all extension id (ex: "extName[version])")
List<String>	getAllExtensionsRequires(String securityToken, String extensionName) Return all extension id (ex: "extName[version])") where extensionName is required.
String	login(String login, String password) Authenticate someone on WikittyService. securityToken returned must be used to call others methods
void	logout(String securityToken) Unanthenticate someone by disabled securityToken
void	removeWikittyServiceListener(WikittyServiceListener listener, WikittyService.ServiceListenerType type) Remove wikitty service listener.
List<Wikitty>	restore(String securityToken, List<String> id)
Wikitty	restore(String securityToken, String id)
List<Wikitty>	restore(String securityToken, WikittyTransaction transaction, List<String> id) Restore wikitty using opened transaction.
Map<TreeNode,Integer>	restoreChildren(String securityToken, 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(String securityToken, String id)
WikittyExtension	restoreExtension(String securityToken, WikittyTransaction transaction, String id) action is done in transaction passed in argument
WikittyExtension	restoreExtensionLastVersion(String securityToken, String name) Search extension with name in last version.
WikittyExtension	restoreExtensionLastVersion(String securityToken, WikittyTransaction transaction, String name) Search extension with name in last version.
Map.Entry<TreeNode,Integer>	restoreNode(String securityToken, String wikittyId, Criteria filter) Retrieve wikitty node with count.
Tree	restoreTree(String securityToken, String wikittyId) Retrieve all wikitties children (recursively) of an other one Wikitty reference by wikittyId MUST include the 'Node' extension
Wikitty	restoreVersion(String securityToken, String wikittyId, String version) Restore wikitty in specifique version.
UpdateResponse	store(String securityToken, Collection<Wikitty> wikitties) Manage Update and creation.
UpdateResponse	store(String securityToken, Collection<Wikitty> wikitties, boolean disableAutoVersionIncrement) Manage Update and creation.
UpdateResponse	store(String securityToken, Wikitty wikitty) Manage Update and creation.
UpdateResponse	store(String securityToken, WikittyTransaction transaction, Collection<Wikitty> wikitties, boolean disableAutoVersionIncrement) Manage Update and creation, action is done in transaction passed in argument
UpdateResponse	storeExtension(String securityToken, Collection<WikittyExtension> exts) Manage Update and creation.
UpdateResponse	storeExtension(String securityToken, WikittyExtension ext) Manage Update and creation.
UpdateResponse	storeExtension(String securityToken, WikittyTransaction transaction, Collection<WikittyExtension> exts) Manage Update and creation, action is done in transaction passed in argument
UpdateResponse	syncEngin(String securityToken) Synchronise search engine with wikitty strorage 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

String login(String login,
             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(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(String securityToken)

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

canWrite

boolean canWrite(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(String securityToken,
                  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 -

wikittyId -

Returns:

vrai le la suppression ne posera pas de probleme.

canRead

boolean canRead(String securityToken,
                String wikittyId)

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

Parameters:

securityToken -

id -

Returns:

vrai si l'utilisateur peut lire l'obbjet

store

UpdateResponse store(String securityToken,
                     Wikitty wikitty)

Manage Update and creation.

Parameters:

wikitty - contains an id all the time.

store

UpdateResponse store(String securityToken,
                     Collection<Wikitty> wikitties)

Manage Update and creation.

Parameters:

wikitties - list of wikitty to be persisted

store

UpdateResponse store(String securityToken,
                     Collection<Wikitty> wikitties,
                     boolean disableAutoVersionIncrement)

Manage Update and creation.

Parameters:

wikitties - list of wikitty to be persisted

disableAutoVersionIncrement - boolean to disable version increment on saved wikitty

store

UpdateResponse store(String securityToken,
                     WikittyTransaction transaction,
                     Collection<Wikitty> wikitties,
                     boolean disableAutoVersionIncrement)

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

Parameters:

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

wikitties - list of wikitty to be persisted

disableAutoVersionIncrement - boolean to disable version increment on saved wikitty

getAllExtensionIds

List<String> getAllExtensionIds(String securityToken)

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

Returns:

getAllExtensionsRequires

List<String> getAllExtensionsRequires(String securityToken,
                                      String extensionName)

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

Returns:

storeExtension

UpdateResponse storeExtension(String securityToken,
                              WikittyExtension ext)

Manage Update and creation.

Parameters:

wikitty - extension to be persisted

storeExtension

UpdateResponse storeExtension(String securityToken,
                              Collection<WikittyExtension> exts)

Manage Update and creation.

Parameters:

exts - list of wikitty extension to be persisted

storeExtension

UpdateResponse storeExtension(String securityToken,
                              WikittyTransaction transaction,
                              Collection<WikittyExtension> exts)

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

Parameters:

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

exts - list of wikitty extension to be persisted

restoreExtension

WikittyExtension restoreExtension(String securityToken,
                                  String id)

Parameters:

id -

Returns:

the corresponding object, exception if no such object found.

restoreExtension

WikittyExtension restoreExtension(String securityToken,
                                  WikittyTransaction transaction,
                                  String id)

action is done in transaction passed in argument

Parameters:

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

id -

Returns:

the corresponding object, exception if no such object found.

restoreExtensionLastVersion

WikittyExtension restoreExtensionLastVersion(String securityToken,
                                             String name)

Search extension with name in last version.

Parameters:

name - extension name

Returns:

the corresponding object, exception if no such object found.

restoreExtensionLastVersion

WikittyExtension restoreExtensionLastVersion(String securityToken,
                                             WikittyTransaction transaction,
                                             String name)

Search extension with name in last version.

Parameters:

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(String securityToken,
                String id)

Parameters:

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

List<Wikitty> restore(String securityToken,
                      List<String> id)

Parameters:

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

List<Wikitty> restore(String securityToken,
                      WikittyTransaction transaction,
                      List<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(String securityToken,
            String id)

delete object if id exists

Parameters:

id - object's id to remove

delete

void delete(String securityToken,
            Collection<String> ids)

delete all object if id exists

Parameters:

ids - object's ids to remove

findAllByCriteria

PagedResult<String> findAllByCriteria(String securityToken,
                                      Criteria criteria)

Parameters:

criteria -

Returns:

findAllByCriteria

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

Parameters:

transaction -

criteria -

Returns:

findByCriteria

Wikitty findByCriteria(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:

criteria -

Returns:

wikitty object or null

findByCriteria

Wikitty findByCriteria(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:

criteria -

transaction -

Returns:

wikitty object or null

addLabel

void addLabel(String securityToken,
              String wikittyId,
              String label)

add new lable to the wikitty object

Parameters:

wikittyId - id of wikitty object to add label

label - label to add

findAllByLabel

PagedResult<String> findAllByLabel(String securityToken,
                                   String label,
                                   int firstIndex,
                                   int endIndex)

Parameters:

label -

Returns:

findByLabel

Wikitty findByLabel(String securityToken,
                    String label)

Parameters:

addLabel -

Returns:

findAllAppliedLabels

Set<String> findAllAppliedLabels(String securityToken,
                                 String wikittyId)

retrieve all labels applied on a wikitty object

Parameters:

wikittyId -

Returns:

restoreTree

Tree restoreTree(String securityToken,
                 String wikittyId)

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

Parameters:

wikittyId -

Returns:

restoreNode

Map.Entry<TreeNode,Integer> restoreNode(String securityToken,
                                        String wikittyId,
                                        Criteria filter)

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

Parameters:

wikittyId -

Returns:

restoreChildren

Map<TreeNode,Integer> restoreChildren(String securityToken,
                                      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:

wikittyId -

Returns:

restoreVersion

Wikitty restoreVersion(String securityToken,
                       String wikittyId,
                       String version)

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

syncEngin

UpdateResponse syncEngin(String securityToken)

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

Returns: