org.nuiton.wikitty
Class WikittyProxy

java.lang.Object
  org.nuiton.wikitty.WikittyProxy

public class WikittyProxy
extends java.lang.Object

Wikitty proxy is used to transform wikitty object used by WikittyService into business objects used by applications. It also manage securityToken for WikittyServiceSecurity.

Version:

$Revision: 444 $ Last update: $Date: 2010-10-21 16:32:50 +0200 (jeu., 21 oct. 2010) $ by : $Author: bpoussin $

Author:

poussin

Field Summary

protected java.lang.String	securityToken Security token.
protected WikittyService	wikittyService Delegated wikitty service.

Constructor Summary

WikittyProxy()
Empty constructor (uninitialized wikittyService).

WikittyProxy(WikittyService wikittyService)
Constructor with wikittyService.

Method Summary

<E extends BusinessEntity> E	cast(BusinessEntity source, java.lang.Class<E> target) Cast Business object to another Business Object If source don't have target extension, this extension is added
void	clear() Use with caution : It will delete ALL indexes from search engine !
void	delete(java.util.Collection<java.lang.String> ids)
void	delete(java.lang.String id)
java.util.List<java.lang.String>	deleteTree(java.lang.String treeNodeId) Delete specified tree node and all sub nodes.
<E extends BusinessEntity> PagedResult<E>	findAllByCriteria(java.lang.Class<E> clazz, Criteria criteria) Search object that correspond to criteria and that have all extension needed by BusinessEntity (clazz).
PagedResult<Wikitty>	findAllByCriteria(Criteria criteria)
<E extends BusinessEntityWikitty> PagedResult<E>	findAllByExample(E e, int firstIndex, int endIndex, java.lang.String... fieldFacet)
<E extends BusinessEntity> E	findByCriteria(java.lang.Class<E> clazz, Criteria criteria)
Wikitty	findByCriteria(Criteria criteria)
<E extends BusinessEntityWikitty> E	findByExample(E e)
java.util.List<java.lang.String>	getAllExtensionIds() Return all extension id (ex: "extName[version])").
java.util.List<java.lang.String>	getAllExtensionsRequires(java.lang.String extensionName) Return all extension id (ex: "extName[version])") where extensionName is required.
java.lang.String	getSecurityToken()
WikittyService	getWikittyService()
<E extends BusinessEntity> boolean	hasType(java.lang.Class<E> clazz, java.lang.String wikittyId)
java.lang.String	login(java.lang.String login, java.lang.String password)
void	logout()
<E extends BusinessEntity> java.util.List<E>	restore(java.lang.Class<E> clazz, java.util.List<java.lang.String> id)
<E extends BusinessEntity> java.util.List<E>	restore(java.lang.Class<E> clazz, java.util.List<java.lang.String> id, boolean checkExtension) Restore wikitty entity with specified id or null if entity can't be be found.
<E extends BusinessEntity> E	restore(java.lang.Class<E> clazz, java.lang.String id) Restore wikitty entity with specified id or null if entity can't be found.
<E extends BusinessEntity> E	restore(java.lang.Class<E> clazz, java.lang.String id, boolean checkExtension) Restore wikitty entity with specified id or null if entity can't be found.
Wikitty	restore(java.lang.String id) Restore wikitty entity with specified id or null if entity can't be found.
<E extends BusinessEntity> java.util.Map<E,java.lang.Integer>	restoreChildren(java.lang.Class<E> clazz, java.lang.String wikittyId, Criteria filter)
<E extends BusinessEntity> java.util.Map<E,java.lang.Integer>	restoreChildren(java.lang.Class<E> clazz, java.lang.String wikittyId, Criteria filter, boolean checkExtension)
WikittyExtension	restoreExtension(java.lang.String extensionId) Load extension from id.
WikittyExtension	restoreExtensionLastVersion(java.lang.String extensionName) Search extension with name in last version.
<E extends BusinessEntity> java.util.Map.Entry<E,java.lang.Integer>	restoreNode(java.lang.Class<E> clazz, java.lang.String wikittyId, Criteria filter)
<E extends BusinessEntity> java.util.Map.Entry<E,java.lang.Integer>	restoreNode(java.lang.Class<E> clazz, java.lang.String wikittyId, Criteria filter, boolean checkExtension)
WikittyTree	restoreTree(java.lang.String wikittyId)
Wikitty	restoreVersion(java.lang.String wikittyId, java.lang.String version)
void	setSecurityToken(java.lang.String securityToken)
void	setWikittyService(WikittyService wikittyService)
<E extends BusinessEntity> E	store(E e)
<E extends BusinessEntity> java.util.List<E>	store(java.util.List<E> objets) Store to WikittyService objects.
UpdateResponse	storeExtension(java.util.Collection<WikittyExtension> exts) Manage Update and creation.
UpdateResponse	storeExtension(WikittyExtension ext) Manage Update and creation.
UpdateResponse	syncEngin() Synchronize search engine with wikitty storage engine, i.e. clear and reindex all wikitties.

Methods inherited from class java.lang.Object

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

Field Detail

wikittyService

protected WikittyService wikittyService

Delegated wikitty service.

securityToken

protected java.lang.String securityToken

Security token.

See Also:

WikittyServiceSecurity.login(String, String)

Constructor Detail

WikittyProxy

public WikittyProxy()

Empty constructor (uninitialized wikittyService).

WikittyProxy

public WikittyProxy(WikittyService wikittyService)

Constructor with wikittyService.

Parameters:

wikittyService - wikitty service

Method Detail

login

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

logout

public void logout()

getSecurityToken

public java.lang.String getSecurityToken()

setSecurityToken

public void setSecurityToken(java.lang.String securityToken)

getWikittyService

public WikittyService getWikittyService()

setWikittyService

public void setWikittyService(WikittyService wikittyService)

cast

public <E extends BusinessEntity> E cast(BusinessEntity source,
                                         java.lang.Class<E> target)

Cast Business object to another Business Object If source don't have target extension, this extension is added

Parameters:

source - business entity source

target - business entity class wanted

Returns:

new instance of object wanted

store

public <E extends BusinessEntity> E store(E e)

store

public <E extends BusinessEntity> java.util.List<E> store(java.util.List<E> objets)

Store to WikittyService objects.

Type Parameters:

E - object type

Parameters:

objets - list

Returns:

updated objects list

restore

public <E extends BusinessEntity> E restore(java.lang.Class<E> clazz,
                                            java.lang.String id,
                                            boolean checkExtension)

Restore wikitty entity with specified id or null if entity can't be found.

Type Parameters:

E - object type

Parameters:

clazz - entity class

id - entity id

checkExtension - if true check that Wikitty result has all extension declared in clazz

Returns:

wikitty entity with specified id or null if entity can't be found

restore

public Wikitty restore(java.lang.String id)

Restore wikitty entity with specified id or null if entity can't be found.

Parameters:

id - entity id

Returns:

wikitty entity with specified id or null if entity can't be found

restore

public <E extends BusinessEntity> E restore(java.lang.Class<E> clazz,
                                            java.lang.String id)

Restore wikitty entity with specified id or null if entity can't be found.

Type Parameters:

E - object type

Parameters:

clazz - entity class

id - entity id

Returns:

wikitty entity with specified id or null if entity can't be found

restore

public <E extends BusinessEntity> java.util.List<E> restore(java.lang.Class<E> clazz,
                                                            java.util.List<java.lang.String> id,
                                                            boolean checkExtension)

Restore wikitty entity with specified id or null if entity can't be be found.

Type Parameters:

E - object type

Parameters:

clazz - entity class

id - entity id

checkExtension - if true check that Wikitty result has all extension

Returns:

wikitty entity with specified id or null if entity can't be found

restore

public <E extends BusinessEntity> java.util.List<E> restore(java.lang.Class<E> clazz,
                                                            java.util.List<java.lang.String> id)

delete

public void delete(java.lang.String id)

delete

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

findAllByExample

public <E extends BusinessEntityWikitty> PagedResult<E> findAllByExample(E e,
                                                                         int firstIndex,
                                                                         int endIndex,
                                                                         java.lang.String... fieldFacet)

findByExample

public <E extends BusinessEntityWikitty> E findByExample(E e)

findAllByCriteria

public <E extends BusinessEntity> PagedResult<E> findAllByCriteria(java.lang.Class<E> clazz,
                                                                   Criteria criteria)

Search object that correspond to criteria and that have all extension needed by BusinessEntity (clazz). If criteria is null, find all extensions else if criteria is empty return nothing.

Type Parameters:

E - object type

Parameters:

clazz - entity class

criteria - criteria

Returns:

paged result

findAllByCriteria

public PagedResult<Wikitty> findAllByCriteria(Criteria criteria)

findByCriteria

public <E extends BusinessEntity> E findByCriteria(java.lang.Class<E> clazz,
                                                   Criteria criteria)

findByCriteria

public Wikitty findByCriteria(Criteria criteria)

restoreTree

public WikittyTree restoreTree(java.lang.String wikittyId)

deleteTree

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

Delete specified tree node and all sub nodes.

Parameters:

treeNodeId - tree node id to delete

Returns:

if at least one node has been deleted

restoreNode

public <E extends BusinessEntity> java.util.Map.Entry<E,java.lang.Integer> restoreNode(java.lang.Class<E> clazz,
                                                                                       java.lang.String wikittyId,
                                                                                       Criteria filter)

restoreNode

public <E extends BusinessEntity> java.util.Map.Entry<E,java.lang.Integer> restoreNode(java.lang.Class<E> clazz,
                                                                                       java.lang.String wikittyId,
                                                                                       Criteria filter,
                                                                                       boolean checkExtension)

restoreChildren

public <E extends BusinessEntity> java.util.Map<E,java.lang.Integer> restoreChildren(java.lang.Class<E> clazz,
                                                                                     java.lang.String wikittyId,
                                                                                     Criteria filter)

restoreChildren

public <E extends BusinessEntity> java.util.Map<E,java.lang.Integer> restoreChildren(java.lang.Class<E> clazz,
                                                                                     java.lang.String wikittyId,
                                                                                     Criteria filter,
                                                                                     boolean checkExtension)

restoreVersion

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

hasType

public <E extends BusinessEntity> boolean hasType(java.lang.Class<E> clazz,
                                                  java.lang.String wikittyId)

storeExtension

public UpdateResponse storeExtension(WikittyExtension ext)

Manage Update and creation.

Parameters:

ext - extension to be persisted

Returns:

update response

storeExtension

public UpdateResponse storeExtension(java.util.Collection<WikittyExtension> exts)

Manage Update and creation.

Parameters:

exts - list of wikitty extension to be persisted

Returns:

update response

restoreExtension

public WikittyExtension restoreExtension(java.lang.String extensionId)

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

Parameters:

extensionId - extension id to restore

Returns:

the corresponding object, exception if no such object found.

restoreExtensionLastVersion

public WikittyExtension restoreExtensionLastVersion(java.lang.String extensionName)

Search extension with name in last version.

Parameters:

extensionName - extension name

Returns:

the corresponding object, exception if no such object found.

getAllExtensionIds

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

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

Returns:

extension id list

getAllExtensionsRequires

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

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

Parameters:

extensionName - extension name

Returns:

extensions

clear

public void clear()

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

syncEngin

public UpdateResponse syncEngin()

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

Returns:

update response