uk.ac.cam.caret.sakai.rwiki.component.service.impl

Class RWikiObjectServiceImpl

java.lang.Object

uk.ac.cam.caret.sakai.rwiki.component.service.impl.RWikiObjectServiceImpl

All Implemented Interfaces:

org.sakaiproject.entity.api.ContextObserver, org.sakaiproject.entity.api.EntityProducer, org.sakaiproject.entity.api.EntityTransferrer, uk.ac.cam.caret.sakai.rwiki.service.api.RWikiObjectService

public class RWikiObjectServiceImpl
extends Object
implements uk.ac.cam.caret.sakai.rwiki.service.api.RWikiObjectService

Author:

andrew

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	autoDdl Configuration: to run the ddl on init or not.
String	createTemplatePageName

Fields inherited from interface uk.ac.cam.caret.sakai.rwiki.service.api.RWikiObjectService

APPLICATION_ID, EVENT_RESOURCE_ADD, EVENT_RESOURCE_READ, EVENT_RESOURCE_REMOVE, EVENT_RESOURCE_WRITE, REFERENCE_LABEL, REFERENCE_ROOT, SMALL_CHANGE_IN_THREAD

Constructor Summary

Constructors

Constructor and Description
RWikiObjectServiceImpl()

Method Summary

Methods

Modifier and Type	Method and Description
String	archive(String siteId, Document doc, Stack stack, String archivePath, List attachments) Archive all the wiki pages in the site as a single collection
boolean	checkAdmin(uk.ac.cam.caret.sakai.rwiki.service.api.model.RWikiObject rwo)
boolean	checkRead(uk.ac.cam.caret.sakai.rwiki.service.api.model.RWikiObject rwo)
boolean	checkUpdate(uk.ac.cam.caret.sakai.rwiki.service.api.model.RWikiObject rwo)
void	contextCreated(String context, boolean toolPlacement)
void	contextDeleted(String context, boolean toolPlacement)
void	contextUpdated(String context, boolean toolPlacement)
List	createListProxy(List commentsList, uk.ac.cam.caret.sakai.rwiki.service.api.dao.ObjectProxy lop)
uk.ac.cam.caret.sakai.rwiki.service.api.model.RWikiObject	createNewRWikiCurrentObject()
uk.ac.cam.caret.sakai.rwiki.service.api.model.RWikiPermissions	createNewRWikiPermissionsImpl()
String	createReference(String pageName)
boolean	exists(String name, String space)
StringBuffer	extractReferences(uk.ac.cam.caret.sakai.rwiki.service.api.model.RWikiCurrentObject rwo, HashSet referenced) Add page references to the rwiki object.
List	findAllChangedSince(Date time, String basepath)
List	findAllPageNames()
List	findChangedSince(Date since, String realm)
List	findReferencingPages(String name)
List	findRWikiHistoryObjects(uk.ac.cam.caret.sakai.rwiki.service.api.model.RWikiObject reference)
List	findRWikiHistoryObjectsInReverse(uk.ac.cam.caret.sakai.rwiki.service.api.model.RWikiObject reference)
List	findRWikiSubPages(String globalParentPageName)
org.sakaiproject.alias.api.AliasService	getAliasService()
uk.ac.cam.caret.sakai.rwiki.service.api.PageLinkRenderer	getComponentPageLinkRender(String pageSpace, boolean withBreadCrumb)
String	getCreateTemplatePageName()
org.sakaiproject.entity.api.Entity	getEntity(org.sakaiproject.entity.api.Reference ref)
org.sakaiproject.entity.api.Entity	getEntity(uk.ac.cam.caret.sakai.rwiki.service.api.model.RWikiObject rwo)
Collection	getEntityAuthzGroups(org.sakaiproject.entity.api.Reference ref, String userId)
String	getEntityDescription(org.sakaiproject.entity.api.Reference ref)
org.sakaiproject.entity.api.ResourceProperties	getEntityResourceProperties(org.sakaiproject.entity.api.Reference ref)
String	getEntityUrl(org.sakaiproject.entity.api.Reference ref) The format of the URL is controlled by a MessageFormat String injected into urlFormat.
Map	getHandlers()
org.sakaiproject.entity.api.HttpAccess	getHttpAccess()
String	getLabel()
org.sakaiproject.entity.api.Reference	getReference(uk.ac.cam.caret.sakai.rwiki.service.api.model.RWikiObject rwo)
org.sakaiproject.entity.api.Entity	getReferenceEntity(org.sakaiproject.entity.api.Reference ref)
uk.ac.cam.caret.sakai.rwiki.service.api.dao.RWikiCurrentObjectDao	getRWikiCurrentObjectDao()
uk.ac.cam.caret.sakai.rwiki.service.api.model.RWikiHistoryObject	getRWikiHistoryObject(uk.ac.cam.caret.sakai.rwiki.service.api.model.RWikiObject reference, int revision)
uk.ac.cam.caret.sakai.rwiki.service.api.dao.RWikiHistoryObjectDao	getRWikiHistoryObjectDao()
uk.ac.cam.caret.sakai.rwiki.service.api.model.RWikiCurrentObject	getRWikiObject(uk.ac.cam.caret.sakai.rwiki.service.api.model.RWikiObject reference)
uk.ac.cam.caret.sakai.rwiki.service.api.model.RWikiCurrentObject	getRWikiObject(String name, String realm)
uk.ac.cam.caret.sakai.rwiki.service.api.model.RWikiCurrentObject	getRWikiObject(String name, String realm, uk.ac.cam.caret.sakai.rwiki.service.api.model.RWikiObject ignore, String templatePage)
void	init() Register this as an EntityProducer
String	merge(String siteId, Element root, String archivePath, String fromSiteId, Map attachmentNames, Map userIdTrans, Set userListAllowImport) The archive contains the current version, followed by historical versions If any of these aer out of order, only versions upto the first encoundered version will be merged.
String[]	myToolIds()
boolean	parseEntityReference(String reference, org.sakaiproject.entity.api.Reference ref) The parsing process iterates though a list of regular expressions to generate a match
void	revert(String name, String realm, Date version, int revision)
List	search(String criteria, String realm)
void	setAliasService(org.sakaiproject.alias.api.AliasService aliasService)
void	setAutoDdl(String value) Configuration: to run the ddl on init or not.
void	setCreateTemplatePageName(String createTemplatePageName)
void	setHandlers(Map m_handlers)
void	setRWikiCurrentObjectDao(uk.ac.cam.caret.sakai.rwiki.service.api.dao.RWikiCurrentObjectDao cdao)
void	setRWikiHistoryObjectDao(uk.ac.cam.caret.sakai.rwiki.service.api.dao.RWikiHistoryObjectDao hdao)
void	transferCopyEntities(String fromContext, String toContext, List ids) Only the current version of a page is imported, history is left behind.
void	transferCopyEntities(String fromContext, String toContext, List ids, boolean cleanup)
void	update(String name, String realm, Date version, uk.ac.cam.caret.sakai.rwiki.service.api.model.RWikiPermissions permissions)
void	update(String name, String realm, Date version, String content)
void	update(String name, String realm, Date version, String content, uk.ac.cam.caret.sakai.rwiki.service.api.model.RWikiPermissions permissions)
void	updateNewComment(String name, String realm, Date version, String content)
boolean	willArchiveMerge()

Methods inherited from class java.lang.Object

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

Field Detail

createTemplatePageName

public String createTemplatePageName

autoDdl

protected boolean autoDdl

Configuration: to run the ddl on init or not.

Constructor Detail

RWikiObjectServiceImpl

public RWikiObjectServiceImpl()

Method Detail

setAutoDdl

public void setAutoDdl(String value)

Configuration: to run the ddl on init or not.

Parameters:

value - the auto ddl value.

init

public void init()

Register this as an EntityProducer

getRWikiObject

public uk.ac.cam.caret.sakai.rwiki.service.api.model.RWikiCurrentObject getRWikiObject(String name,
                                                                              String realm)
                                                                                throws uk.ac.cam.caret.sakai.rwiki.service.exception.PermissionException

Specified by:

getRWikiObject in interface uk.ac.cam.caret.sakai.rwiki.service.api.RWikiObjectService

Throws:

uk.ac.cam.caret.sakai.rwiki.service.exception.PermissionException

getRWikiObject

public uk.ac.cam.caret.sakai.rwiki.service.api.model.RWikiCurrentObject getRWikiObject(String name,
                                                                              String realm,
                                                                              uk.ac.cam.caret.sakai.rwiki.service.api.model.RWikiObject ignore,
                                                                              String templatePage)
                                                                                throws uk.ac.cam.caret.sakai.rwiki.service.exception.PermissionException

Specified by:

getRWikiObject in interface uk.ac.cam.caret.sakai.rwiki.service.api.RWikiObjectService

Throws:

uk.ac.cam.caret.sakai.rwiki.service.exception.PermissionException

search

public List search(String criteria,
          String realm)
            throws uk.ac.cam.caret.sakai.rwiki.service.exception.PermissionException

Specified by:

search in interface uk.ac.cam.caret.sakai.rwiki.service.api.RWikiObjectService

Throws:

uk.ac.cam.caret.sakai.rwiki.service.exception.PermissionException

getRWikiCurrentObjectDao

public uk.ac.cam.caret.sakai.rwiki.service.api.dao.RWikiCurrentObjectDao getRWikiCurrentObjectDao()

setRWikiCurrentObjectDao

public void setRWikiCurrentObjectDao(uk.ac.cam.caret.sakai.rwiki.service.api.dao.RWikiCurrentObjectDao cdao)

getRWikiHistoryObjectDao

public uk.ac.cam.caret.sakai.rwiki.service.api.dao.RWikiHistoryObjectDao getRWikiHistoryObjectDao()

setRWikiHistoryObjectDao

public void setRWikiHistoryObjectDao(uk.ac.cam.caret.sakai.rwiki.service.api.dao.RWikiHistoryObjectDao hdao)

update

public void update(String name,
          String realm,
          Date version,
          String content,
          uk.ac.cam.caret.sakai.rwiki.service.api.model.RWikiPermissions permissions)
            throws uk.ac.cam.caret.sakai.rwiki.service.exception.PermissionException,
                   uk.ac.cam.caret.sakai.rwiki.service.exception.VersionException

Specified by:

update in interface uk.ac.cam.caret.sakai.rwiki.service.api.RWikiObjectService

Throws:

uk.ac.cam.caret.sakai.rwiki.service.exception.PermissionException

uk.ac.cam.caret.sakai.rwiki.service.exception.VersionException

update

public void update(String name,
          String realm,
          Date version,
          String content)
            throws uk.ac.cam.caret.sakai.rwiki.service.exception.PermissionException,
                   uk.ac.cam.caret.sakai.rwiki.service.exception.VersionException

Specified by:

update in interface uk.ac.cam.caret.sakai.rwiki.service.api.RWikiObjectService

Throws:

uk.ac.cam.caret.sakai.rwiki.service.exception.PermissionException

uk.ac.cam.caret.sakai.rwiki.service.exception.VersionException

update

public void update(String name,
          String realm,
          Date version,
          uk.ac.cam.caret.sakai.rwiki.service.api.model.RWikiPermissions permissions)
            throws uk.ac.cam.caret.sakai.rwiki.service.exception.PermissionException,
                   uk.ac.cam.caret.sakai.rwiki.service.exception.VersionException

Specified by:

update in interface uk.ac.cam.caret.sakai.rwiki.service.api.RWikiObjectService

Throws:

uk.ac.cam.caret.sakai.rwiki.service.exception.PermissionException

uk.ac.cam.caret.sakai.rwiki.service.exception.VersionException

extractReferences

public StringBuffer extractReferences(uk.ac.cam.caret.sakai.rwiki.service.api.model.RWikiCurrentObject rwo,
                             HashSet referenced)

Add page references to the rwiki object. Limit length of the string to save to a fixed value that will cover the common cases without using resources for degenerate cases.

Parameters:

rwo - - The rwiki object

referenced - - the hash of the references to save.

exists

public boolean exists(String name,
             String space)

Specified by:

exists in interface uk.ac.cam.caret.sakai.rwiki.service.api.RWikiObjectService

findChangedSince

public List findChangedSince(Date since,
                    String realm)

Specified by:

findChangedSince in interface uk.ac.cam.caret.sakai.rwiki.service.api.RWikiObjectService

findReferencingPages

public List findReferencingPages(String name)

Specified by:

findReferencingPages in interface uk.ac.cam.caret.sakai.rwiki.service.api.RWikiObjectService

revert

public void revert(String name,
          String realm,
          Date version,
          int revision)

Specified by:

revert in interface uk.ac.cam.caret.sakai.rwiki.service.api.RWikiObjectService

getRWikiObject

public uk.ac.cam.caret.sakai.rwiki.service.api.model.RWikiCurrentObject getRWikiObject(uk.ac.cam.caret.sakai.rwiki.service.api.model.RWikiObject reference)

Specified by:

getRWikiObject in interface uk.ac.cam.caret.sakai.rwiki.service.api.RWikiObjectService

getRWikiHistoryObject

public uk.ac.cam.caret.sakai.rwiki.service.api.model.RWikiHistoryObject getRWikiHistoryObject(uk.ac.cam.caret.sakai.rwiki.service.api.model.RWikiObject reference,
                                                                                     int revision)

Specified by:

getRWikiHistoryObject in interface uk.ac.cam.caret.sakai.rwiki.service.api.RWikiObjectService

findRWikiHistoryObjects

public List findRWikiHistoryObjects(uk.ac.cam.caret.sakai.rwiki.service.api.model.RWikiObject reference)

Specified by:

findRWikiHistoryObjects in interface uk.ac.cam.caret.sakai.rwiki.service.api.RWikiObjectService

findRWikiHistoryObjectsInReverse

public List findRWikiHistoryObjectsInReverse(uk.ac.cam.caret.sakai.rwiki.service.api.model.RWikiObject reference)

Specified by:

findRWikiHistoryObjectsInReverse in interface uk.ac.cam.caret.sakai.rwiki.service.api.RWikiObjectService

getCreateTemplatePageName

public String getCreateTemplatePageName()

Returns:

Returns the createTemplatePageName.

setCreateTemplatePageName

public void setCreateTemplatePageName(String createTemplatePageName)

Parameters:

createTemplatePageName - The createTemplatePageName to set.

findRWikiSubPages

public List findRWikiSubPages(String globalParentPageName)

Specified by:

findRWikiSubPages in interface uk.ac.cam.caret.sakai.rwiki.service.api.RWikiObjectService

updateNewComment

public void updateNewComment(String name,
                    String realm,
                    Date version,
                    String content)
                      throws uk.ac.cam.caret.sakai.rwiki.service.exception.PermissionException,
                             uk.ac.cam.caret.sakai.rwiki.service.exception.VersionException

Specified by:

updateNewComment in interface uk.ac.cam.caret.sakai.rwiki.service.api.RWikiObjectService

Throws:

uk.ac.cam.caret.sakai.rwiki.service.exception.PermissionException

uk.ac.cam.caret.sakai.rwiki.service.exception.VersionException

createListProxy

public List createListProxy(List commentsList,
                   uk.ac.cam.caret.sakai.rwiki.service.api.dao.ObjectProxy lop)

Specified by:

createListProxy in interface uk.ac.cam.caret.sakai.rwiki.service.api.RWikiObjectService

createNewRWikiCurrentObject

public uk.ac.cam.caret.sakai.rwiki.service.api.model.RWikiObject createNewRWikiCurrentObject()

Specified by:

createNewRWikiCurrentObject in interface uk.ac.cam.caret.sakai.rwiki.service.api.RWikiObjectService

createNewRWikiPermissionsImpl

public uk.ac.cam.caret.sakai.rwiki.service.api.model.RWikiPermissions createNewRWikiPermissionsImpl()

Specified by:

createNewRWikiPermissionsImpl in interface uk.ac.cam.caret.sakai.rwiki.service.api.RWikiObjectService

getLabel

public String getLabel()

Specified by:

getLabel in interface org.sakaiproject.entity.api.EntityProducer

willArchiveMerge

public boolean willArchiveMerge()

Specified by:

willArchiveMerge in interface org.sakaiproject.entity.api.EntityProducer

contextCreated

public void contextCreated(String context,
                  boolean toolPlacement)

Specified by:

contextCreated in interface org.sakaiproject.entity.api.ContextObserver

contextUpdated

public void contextUpdated(String context,
                  boolean toolPlacement)

Specified by:

contextUpdated in interface org.sakaiproject.entity.api.ContextObserver

contextDeleted

public void contextDeleted(String context,
                  boolean toolPlacement)

Specified by:

contextDeleted in interface org.sakaiproject.entity.api.ContextObserver

archive

public String archive(String siteId,
             Document doc,
             Stack stack,
             String archivePath,
             List attachments)

Archive all the wiki pages in the site as a single collection

Specified by:

archive in interface org.sakaiproject.entity.api.EntityProducer

merge

public String merge(String siteId,
           Element root,
           String archivePath,
           String fromSiteId,
           Map attachmentNames,
           Map userIdTrans,
           Set userListAllowImport)

The archive contains the current version, followed by historical versions If any of these aer out of order, only versions upto the first encoundered version will be merged. If the page exists, then only version that dont exist, and are not already present will be added in practice this means all the pages in the set will be rejected.

Specified by:

merge in interface org.sakaiproject.entity.api.EntityProducer

myToolIds

public String[] myToolIds()

Specified by:

myToolIds in interface org.sakaiproject.entity.api.ContextObserver

Specified by:

myToolIds in interface org.sakaiproject.entity.api.EntityTransferrer

transferCopyEntities

public void transferCopyEntities(String fromContext,
                        String toContext,
                        List ids)

Only the current version of a page is imported, history is left behind.

Specified by:

transferCopyEntities in interface org.sakaiproject.entity.api.EntityTransferrer

parseEntityReference

public boolean parseEntityReference(String reference,
                           org.sakaiproject.entity.api.Reference ref)

The parsing process iterates though a list of regular expressions to generate a match

Specified by:

parseEntityReference in interface org.sakaiproject.entity.api.EntityProducer

getEntityDescription

public String getEntityDescription(org.sakaiproject.entity.api.Reference ref)

Specified by:

getEntityDescription in interface org.sakaiproject.entity.api.EntityProducer

getEntityResourceProperties

public org.sakaiproject.entity.api.ResourceProperties getEntityResourceProperties(org.sakaiproject.entity.api.Reference ref)

Specified by:

getEntityResourceProperties in interface org.sakaiproject.entity.api.EntityProducer

getEntity

public org.sakaiproject.entity.api.Entity getEntity(org.sakaiproject.entity.api.Reference ref)

Specified by:

getEntity in interface org.sakaiproject.entity.api.EntityProducer

getEntityUrl

public String getEntityUrl(org.sakaiproject.entity.api.Reference ref)

The format of the URL is controlled by a MessageFormat String injected into urlFormat. The parameters are 0 = global Page Name

Specified by:

getEntityUrl in interface org.sakaiproject.entity.api.EntityProducer

getEntityAuthzGroups

public Collection getEntityAuthzGroups(org.sakaiproject.entity.api.Reference ref,
                              String userId)

Specified by:

getEntityAuthzGroups in interface org.sakaiproject.entity.api.EntityProducer

getHttpAccess

public org.sakaiproject.entity.api.HttpAccess getHttpAccess()

Specified by:

getHttpAccess in interface org.sakaiproject.entity.api.EntityProducer

getReferenceEntity

public org.sakaiproject.entity.api.Entity getReferenceEntity(org.sakaiproject.entity.api.Reference ref)

getEntity

public org.sakaiproject.entity.api.Entity getEntity(uk.ac.cam.caret.sakai.rwiki.service.api.model.RWikiObject rwo)

Specified by:

getEntity in interface uk.ac.cam.caret.sakai.rwiki.service.api.RWikiObjectService

Parameters:

rwo -

Returns:

getReference

public org.sakaiproject.entity.api.Reference getReference(uk.ac.cam.caret.sakai.rwiki.service.api.model.RWikiObject rwo)

Specified by:

getReference in interface uk.ac.cam.caret.sakai.rwiki.service.api.RWikiObjectService

Parameters:

rwo -

Returns:

getHandlers

public Map getHandlers()

Specified by:

getHandlers in interface uk.ac.cam.caret.sakai.rwiki.service.api.RWikiObjectService

Returns:

Returns the handlers.

setHandlers

public void setHandlers(Map m_handlers)

Parameters:

m_handlers - The handlers to set.

findAllChangedSince

public List findAllChangedSince(Date time,
                       String basepath)

Specified by:

findAllChangedSince in interface uk.ac.cam.caret.sakai.rwiki.service.api.RWikiObjectService

checkRead

public boolean checkRead(uk.ac.cam.caret.sakai.rwiki.service.api.model.RWikiObject rwo)

Specified by:

checkRead in interface uk.ac.cam.caret.sakai.rwiki.service.api.RWikiObjectService

checkUpdate

public boolean checkUpdate(uk.ac.cam.caret.sakai.rwiki.service.api.model.RWikiObject rwo)

Specified by:

checkUpdate in interface uk.ac.cam.caret.sakai.rwiki.service.api.RWikiObjectService

checkAdmin

public boolean checkAdmin(uk.ac.cam.caret.sakai.rwiki.service.api.model.RWikiObject rwo)

Specified by:

checkAdmin in interface uk.ac.cam.caret.sakai.rwiki.service.api.RWikiObjectService

findAllPageNames

public List findAllPageNames()

Specified by:

findAllPageNames in interface uk.ac.cam.caret.sakai.rwiki.service.api.RWikiObjectService

createReference

public String createReference(String pageName)

Specified by:

createReference in interface uk.ac.cam.caret.sakai.rwiki.service.api.RWikiObjectService

getComponentPageLinkRender

public uk.ac.cam.caret.sakai.rwiki.service.api.PageLinkRenderer getComponentPageLinkRender(String pageSpace,
                                                                                  boolean withBreadCrumb)

Specified by:

getComponentPageLinkRender in interface uk.ac.cam.caret.sakai.rwiki.service.api.RWikiObjectService

getAliasService

public org.sakaiproject.alias.api.AliasService getAliasService()

Returns:

the aliasService

setAliasService

public void setAliasService(org.sakaiproject.alias.api.AliasService aliasService)

Parameters:

aliasService - the aliasService to set

transferCopyEntities

public void transferCopyEntities(String fromContext,
                        String toContext,
                        List ids,
                        boolean cleanup)

Specified by:

transferCopyEntities in interface org.sakaiproject.entity.api.EntityTransferrer