org.nuiton.wikitty.services
Class WikittyServiceHook

java.lang.Object
  org.nuiton.wikitty.services.WikittyServiceDelegator
      org.nuiton.wikitty.services.WikittyServiceHook

All Implemented Interfaces:

WikittyService

public class WikittyServiceHook
extends WikittyServiceDelegator

Cette classe permet d'intercepter les modifications faites via les differentes methodes de modification des données et d'executer les differents WikittyHook enregistres. Les WikittyHook peuvent

Version:

$Revision: 784 $ Last update: $Date: 2011-04-12 10:26:26 +0200 (mar., 12 avril 2011) $ by : $Author: jcouteau $

Author:

poussin

Nested Class Summary

Nested classes/interfaces inherited from interface org.nuiton.wikitty.WikittyService

WikittyService.ServiceListenerType

Field Summary

static String	POST_CLEAR
static String	POST_DELETE
static String	POST_DELETE_EXTENSION
static String	POST_DELETE_TREE
static String	POST_LOGIN
static String	POST_LOGOUT
static String	POST_REPLAY
static String	POST_STORE
static String	POST_STORE_EXTENSION
static String	POST_SYNC_SEARCH_ENGINE
static String	PRE_CLEAR
static String	PRE_DELETE
static String	PRE_DELETE_EXTENSION
static String	PRE_DELETE_TREE
static String	PRE_LOGIN
static String	PRE_LOGOUT
static String	PRE_REPLAY
static String	PRE_STORE
static String	PRE_STORE_EXTENSION
static String	PRE_SYNC_SEARCH_ENGINE

Fields inherited from class org.nuiton.wikitty.services.WikittyServiceDelegator

delegate

Constructor Summary

WikittyServiceHook(org.nuiton.util.ApplicationConfig config, WikittyService ws)

Method Summary

protected Map<String,Object>	callHook(String securityToken, String actionName, Map<String,Object> args, WikittyEvent event)
WikittyEvent	clear(String securityToken) Use with caution : It will delete ALL indexes from search engine !
WikittyEvent	delete(String securityToken, Collection<String> ids) Delete all object if id exists.
WikittyEvent	deleteExtension(String securityToken, Collection<String> extNames) Delete all extension if id exists and no wikitty used this extension.
WikittyEvent	deleteTree(String securityToken, String wikittyId) Delete specified tree node and all sub nodes.
protected Collection<Wikitty>	getHook(String securityToken, String actionName)
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
WikittyEvent	replay(String securityToken, List<WikittyEvent> events, boolean force) Replay all events in argument on this WikittyService
WikittyEvent	store(String securityToken, Collection<Wikitty> wikitties, boolean force) Manage Update and creation.
WikittyEvent	storeExtension(String securityToken, Collection<WikittyExtension> exts) Manage Update and creation
void	syncSearchEngine(String securityToken) Synchronise search engine with wikitty storage engine, i.e. clear and reindex all wikitties.

Methods inherited from class org.nuiton.wikitty.services.WikittyServiceDelegator

addWikittyServiceListener, canDelete, canRead, canWrite, exists, findAllByCriteria, findByCriteria, findTreeNode, getAllExtensionIds, getAllExtensionsRequires, getDelegate, isDeleted, removeWikittyServiceListener, restore, restoreExtension, restoreExtensionLastVersion, restoreVersion, setDelegate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

PRE_STORE

public static final String PRE_STORE

See Also:

Constant Field Values

POST_STORE

public static final String POST_STORE

See Also:

Constant Field Values

PRE_STORE_EXTENSION

public static final String PRE_STORE_EXTENSION

See Also:

Constant Field Values

POST_STORE_EXTENSION

public static final String POST_STORE_EXTENSION

See Also:

Constant Field Values

PRE_DELETE

public static final String PRE_DELETE

See Also:

Constant Field Values

POST_DELETE

public static final String POST_DELETE

See Also:

Constant Field Values

PRE_DELETE_EXTENSION

public static final String PRE_DELETE_EXTENSION

See Also:

Constant Field Values

POST_DELETE_EXTENSION

public static final String POST_DELETE_EXTENSION

See Also:

Constant Field Values

PRE_DELETE_TREE

public static final String PRE_DELETE_TREE

See Also:

Constant Field Values

POST_DELETE_TREE

public static final String POST_DELETE_TREE

See Also:

Constant Field Values

PRE_CLEAR

public static final String PRE_CLEAR

See Also:

Constant Field Values

POST_CLEAR

public static final String POST_CLEAR

See Also:

Constant Field Values

PRE_LOGIN

public static final String PRE_LOGIN

See Also:

Constant Field Values

POST_LOGIN

public static final String POST_LOGIN

See Also:

Constant Field Values

PRE_LOGOUT

public static final String PRE_LOGOUT

See Also:

Constant Field Values

POST_LOGOUT

public static final String POST_LOGOUT

See Also:

Constant Field Values

PRE_REPLAY

public static final String PRE_REPLAY

See Also:

Constant Field Values

POST_REPLAY

public static final String POST_REPLAY

See Also:

Constant Field Values

PRE_SYNC_SEARCH_ENGINE

public static final String PRE_SYNC_SEARCH_ENGINE

See Also:

Constant Field Values

POST_SYNC_SEARCH_ENGINE

public static final String POST_SYNC_SEARCH_ENGINE

See Also:

Constant Field Values

Constructor Detail

WikittyServiceHook

public WikittyServiceHook(org.nuiton.util.ApplicationConfig config,
                          WikittyService ws)

Parameters:

config - not use currently but needed in futur

ws -

Method Detail

getHook

protected Collection<Wikitty> getHook(String securityToken,
                                      String actionName)

callHook

protected Map<String,Object> callHook(String securityToken,
                                      String actionName,
                                      Map<String,Object> args,
                                      WikittyEvent event)

store

public WikittyEvent store(String securityToken,
                          Collection<Wikitty> wikitties,
                          boolean force)

Description copied from interface: WikittyService

Manage Update and creation.

Specified by:

store in interface WikittyService

Overrides:

store in class WikittyServiceDelegator

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

storeExtension

public WikittyEvent storeExtension(String securityToken,
                                   Collection<WikittyExtension> exts)

Description copied from interface: WikittyService

Manage Update and creation

Specified by:

storeExtension in interface WikittyService

Overrides:

storeExtension in class WikittyServiceDelegator

Parameters:

securityToken - security token

exts - list of wikitty extension to be persisted

Returns:

update response

delete

public WikittyEvent delete(String securityToken,
                           Collection<String> ids)

Description copied from interface: WikittyService

Delete all object if id exists.

Specified by:

delete in interface WikittyService

Overrides:

delete in class WikittyServiceDelegator

Parameters:

securityToken - security token

ids - object's ids to remove

deleteExtension

public WikittyEvent deleteExtension(String securityToken,
                                    Collection<String> extNames)

Description copied from interface: WikittyService

Delete all extension if id exists and no wikitty used this extension. extension name must be just the name (extName)

Specified by:

deleteExtension in interface WikittyService

Overrides:

deleteExtension in class WikittyServiceDelegator

Parameters:

securityToken - security token

extNames - extension's names to remove

deleteTree

public WikittyEvent deleteTree(String securityToken,
                               String wikittyId)

Description copied from interface: WikittyService

Delete specified tree node and all sub nodes.

Specified by:

deleteTree in interface WikittyService

Overrides:

deleteTree in class WikittyServiceDelegator

Parameters:

securityToken - security token

wikittyId - tree node id to delete

Returns:

delete wikitty ids

clear

public WikittyEvent clear(String securityToken)

Description copied from interface: WikittyService

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

Specified by:

clear in interface WikittyService

Overrides:

clear in class WikittyServiceDelegator

Parameters:

securityToken - security token

login

public String login(String login,
                    String password)

Description copied from interface: WikittyService

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

Specified by:

login in interface WikittyService

Overrides:

login in class WikittyServiceDelegator

Parameters:

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

Returns:

return token securityToken

logout

public void logout(String securityToken)

Description copied from interface: WikittyService

Unanthenticate someone by disabled securityToken

Specified by:

logout in interface WikittyService

Overrides:

logout in class WikittyServiceDelegator

Parameters:

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

replay

public WikittyEvent replay(String securityToken,
                           List<WikittyEvent> events,
                           boolean force)

Description copied from interface: WikittyService

Replay all events in argument on this WikittyService

Specified by:

replay in interface WikittyService

Overrides:

replay in class WikittyServiceDelegator

Parameters:

securityToken - security token

events - event to replay

force - for to not change wikitty version (use version in wikitty present in event)

Returns:

new event that represent all event passed in argument. if arguement have: store, store, delete, clear, store. Return event resume all by only one clear + store, because all action before clear is not necessary. Similarly for store + delete for the same object. (note: perhaps this broke history, when history are implanted and two serveur must have same history ?)

syncSearchEngine

public void syncSearchEngine(String securityToken)

Description copied from interface: WikittyService

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

Specified by:

syncSearchEngine in interface WikittyService

Overrides:

syncSearchEngine in class WikittyServiceDelegator

Parameters:

securityToken - security token