com.xpn.xwiki.store

Class XWikiHibernateVersioningStore

java.lang.Object

com.xpn.xwiki.internal.store.AbstractXWikiStore

com.xpn.xwiki.store.XWikiHibernateBaseStore

com.xpn.xwiki.store.XWikiHibernateVersioningStore

All Implemented Interfaces:

XWikiVersioningStoreInterface

@Component
 @Named(value="hibernate")
 @Singleton
public class XWikiHibernateVersioningStore
extends XWikiHibernateBaseStore
implements XWikiVersioningStoreInterface

Realization of XWikiVersioningStoreInterface for Hibernate-based storage.

Version:

$Id: 078f3fca12450c9f028c72064a1b3f0d085932cc $

Nested Class Summary

Nested classes/interfaces inherited from class com.xpn.xwiki.store.XWikiHibernateBaseStore

XWikiHibernateBaseStore.HibernateCallback<T>

Field Summary

Fields inherited from class com.xpn.xwiki.store.XWikiHibernateBaseStore

hibernateConfiguration, HINT, loggerManager, store

Constructor Summary

Constructors

Constructor and Description
XWikiHibernateVersioningStore() Empty constructor needed for component manager.
XWikiHibernateVersioningStore(String hibpath) Deprecated. 1.6M1. use ComponentManager.lookup(XWikiVersioningStoreInterface.class) instead.
XWikiHibernateVersioningStore(XWikiContext context) Deprecated. 1.6M1. use ComponentManager.lookup(XWikiVersioningStoreInterface.class) instead.
XWikiHibernateVersioningStore(XWiki xwiki, XWikiContext context) Deprecated. 1.6M1. use ComponentManager.lookup(XWikiVersioningStoreInterface.class) instead.

Method Summary

Modifier and Type	Method and Description
void	deleteArchive(XWikiDocument doc, boolean bTransaction, XWikiContext context) Delete all history for a document.
XWikiDocumentArchive	getXWikiDocumentArchive(XWikiDocument doc, XWikiContext inputxcontext)
org.suigeneris.jrcs.rcs.Version[]	getXWikiDocVersions(XWikiDocument doc, XWikiContext context)
protected List<XWikiRCSNodeInfo>	loadAllRCSNodeInfo(XWikiContext context, long id, boolean bTransaction)
XWikiRCSNodeContent	loadRCSNodeContent(XWikiRCSNodeId id, boolean bTransaction, XWikiContext context) Load XWikiRCSNodeContent on demand.
XWikiDocument	loadXWikiDoc(XWikiDocument basedoc, String sversion, XWikiContext inputxcontext)
void	loadXWikiDocArchive(XWikiDocumentArchive archivedoc, boolean bTransaction, XWikiContext context)
void	resetRCSArchive(XWikiDocument doc, boolean bTransaction, XWikiContext inputxcontext)
void	saveXWikiDocArchive(XWikiDocumentArchive archivedoc, boolean bTransaction, XWikiContext context)
void	updateXWikiDocArchive(XWikiDocument doc, boolean bTransaction, XWikiContext inputxcontext)

Methods inherited from class com.xpn.xwiki.store.XWikiHibernateBaseStore

beginTransaction, beginTransaction, beginTransaction, beginTransaction, checkHibernate, cleanUp, createHibernateSequenceIfRequired, dynamicMappingTableName, endTransaction, endTransaction, escapeSchema, execute, execute, executeRead, executeRead, executeWrite, executeWrite, failSafeExecute, failSafeExecuteRead, failSafeExecuteWrite, getConfiguration, getConnections, getDatabaseMetaData, getDatabaseProductName, getDatabaseProductName, getDialect, getExecution, getHint, getMapping, getMetadata, getNbConnections, getPath, getSchemaFromWikiName, getSchemaFromWikiName, getSchemaFromWikiName, getSchemaUpdateScript, getSession, getSessionFactory, getTransaction, isInSchemaMode, isVirtual, makeMapping, setDatabase, setNbConnections, setPath, setSession, setSessionFactory, setTransaction, shutdownHibernate, updateSchema, updateSchema, updateSchema, updateSchema

Methods inherited from class com.xpn.xwiki.internal.store.AbstractXWikiStore

getExecutionXContext, restoreExecutionXContext

Methods inherited from class java.lang.Object

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

Constructor Detail

XWikiHibernateVersioningStore

@Deprecated
public XWikiHibernateVersioningStore(XWiki xwiki,
                                                 XWikiContext context)

Deprecated. 1.6M1. use ComponentManager.lookup(XWikiVersioningStoreInterface.class) instead.

This allows to initialize our storage engine. The hibernate config file path is taken from xwiki.cfg or directly in the WEB-INF directory.

Parameters:

xwiki - The xwiki object

context - The current context

XWikiHibernateVersioningStore

@Deprecated
public XWikiHibernateVersioningStore(String hibpath)

Deprecated. 1.6M1. use ComponentManager.lookup(XWikiVersioningStoreInterface.class) instead.

Initialize the storage engine with a specific path This is used for tests.

Parameters:

hibpath - path to hibernate.hbm.xml file

XWikiHibernateVersioningStore

@Deprecated
public XWikiHibernateVersioningStore(XWikiContext context)

Deprecated. 1.6M1. use ComponentManager.lookup(XWikiVersioningStoreInterface.class) instead.

Parameters:

context - The current context

See Also:

XWikiHibernateVersioningStore(XWiki, XWikiContext)

XWikiHibernateVersioningStore

public XWikiHibernateVersioningStore()

Empty constructor needed for component manager.

Method Detail

getXWikiDocVersions

public org.suigeneris.jrcs.rcs.Version[] getXWikiDocVersions(XWikiDocument doc,
                                                             XWikiContext context)
                                                      throws XWikiException

Specified by:

getXWikiDocVersions in interface XWikiVersioningStoreInterface

Throws:

XWikiException

getXWikiDocumentArchive

public XWikiDocumentArchive getXWikiDocumentArchive(XWikiDocument doc,
                                                    XWikiContext inputxcontext)
                                             throws XWikiException

Specified by:

getXWikiDocumentArchive in interface XWikiVersioningStoreInterface

Throws:

XWikiException

loadXWikiDocArchive

public void loadXWikiDocArchive(XWikiDocumentArchive archivedoc,
                                boolean bTransaction,
                                XWikiContext context)
                         throws XWikiException

Specified by:

loadXWikiDocArchive in interface XWikiVersioningStoreInterface

Throws:

XWikiException

saveXWikiDocArchive

public void saveXWikiDocArchive(XWikiDocumentArchive archivedoc,
                                boolean bTransaction,
                                XWikiContext context)
                         throws XWikiException

Specified by:

saveXWikiDocArchive in interface XWikiVersioningStoreInterface

Throws:

XWikiException

loadXWikiDoc

public XWikiDocument loadXWikiDoc(XWikiDocument basedoc,
                                  String sversion,
                                  XWikiContext inputxcontext)
                           throws XWikiException

Specified by:

loadXWikiDoc in interface XWikiVersioningStoreInterface

Throws:

XWikiException

resetRCSArchive

public void resetRCSArchive(XWikiDocument doc,
                            boolean bTransaction,
                            XWikiContext inputxcontext)
                     throws XWikiException

Specified by:

resetRCSArchive in interface XWikiVersioningStoreInterface

Throws:

XWikiException

updateXWikiDocArchive

public void updateXWikiDocArchive(XWikiDocument doc,
                                  boolean bTransaction,
                                  XWikiContext inputxcontext)
                           throws XWikiException

Specified by:

updateXWikiDocArchive in interface XWikiVersioningStoreInterface

Throws:

XWikiException

loadAllRCSNodeInfo

protected List<XWikiRCSNodeInfo> loadAllRCSNodeInfo(XWikiContext context,
                                                    long id,
                                                    boolean bTransaction)
                                             throws XWikiException

Parameters:

context - the XWiki context

id - XWikiRCSNodeContent.getId()

bTransaction - should store to use old transaction(false) or create new (true)

Returns:

loaded rcs node content

Throws:

XWikiException - if any error

loadRCSNodeContent

public XWikiRCSNodeContent loadRCSNodeContent(XWikiRCSNodeId id,
                                              boolean bTransaction,
                                              XWikiContext context)
                                       throws XWikiException

Description copied from interface: XWikiVersioningStoreInterface

Load XWikiRCSNodeContent on demand. Used in XWikiRCSNodeInfo.getContent(XWikiContext) for example.

Specified by:

loadRCSNodeContent in interface XWikiVersioningStoreInterface

Parameters:

id - the node id (see XWikiRCSNodeContent.getId())

Returns:

the RCS node content for the passed node id

Throws:

XWikiException

deleteArchive

public void deleteArchive(XWikiDocument doc,
                          boolean bTransaction,
                          XWikiContext context)
                   throws XWikiException

Description copied from interface: XWikiVersioningStoreInterface

Delete all history for a document.

Specified by:

deleteArchive in interface XWikiVersioningStoreInterface

Parameters:

doc - the document for which to delete all the history

Throws:

XWikiException