org.jahia.services.content

Class JCRStoreProvider

java.lang.Object

org.jahia.services.content.JCRStoreProvider

All Implemented Interfaces:

Comparable<JCRStoreProvider>

Direct Known Subclasses:

JackrabbitStoreProvider

public class JCRStoreProvider
extends Object
implements Comparable<JCRStoreProvider>

A store provider to handle different back-end stores within a site. There are multiple subclasses for the different repository vendors.

The main and default repository in Jahia is based on the JackrabbitStoreProvider, but you can have different repositories mounted, which are based on other store providers.

Author:

toto

Field Summary

Fields

Modifier and Type	Field and Description
protected String	authenticationType
protected String	guestPassword
protected String	guestUser
protected javax.jcr.Repository	repo
protected String	rmibind
protected JCRSessionFactory	sessionFactory
protected String	systemPassword
protected String	systemUser

Constructor Summary

Constructors

Constructor and Description
JCRStoreProvider()

Method Summary

Modifier and Type	Method and Description
boolean	canCacheNode(javax.jcr.Node node) Checks if the specified node, backed by this provider, can be cached.
boolean	canExportNode(javax.jcr.Node node) Indicates if the specified node, backed by this provider, is considered during export operation
boolean	canExportProperty(javax.jcr.Property property) Indicates if the specified property, backed by this provider, is considered during export operation
protected boolean	canRegisterCustomNodeTypes()
void	checkAvailability()
int	compareTo(JCRStoreProvider o)
protected javax.jcr.Repository	createRepository() Creates an instance of the content repository.
void	deployDefinitions(String systemId) Deploy definitions registered with the given systemId into the underlying repository
protected void	dump(javax.jcr.Node n)
boolean	equals(Object o)
String	getAbsoluteContextPath(javax.servlet.ServletRequest request)
String	getAuthenticationType()
protected javax.jcr.Credentials	getCredentials(javax.jcr.Credentials originalCredentials)
int	getDepth()
String	getFactory()
JahiaGroupManagerService	getGroupManagerService()
protected javax.jcr.Credentials	getGuestCredentials()
String	getHttpPath()
List<JCRNodeWrapper>	getImportDropBoxes(String site, JahiaUser user)
JCRItemWrapper	getItemWrapper(javax.jcr.Item item, JCRSessionWrapper session)
String	getKey()
String	getMountPoint()
String	getMountStatusMessage()
JCRNodeWrapper	getNodeWrapper(javax.jcr.Node objectNode, JCRSessionWrapper session)
JCRNodeWrapper	getNodeWrapper(javax.jcr.Node objectNode, String path, JCRNodeWrapper parent, JCRSessionWrapper session)
Patcher	getPatcher()
JCRPropertyWrapper	getPropertyWrapper(javax.jcr.Property prop, JCRSessionWrapper session)
javax.jcr.query.QueryManager	getQueryManager(JCRSessionWrapper session)
String	getRelativeRoot()
javax.jcr.Repository	getRepository()
protected javax.jcr.Repository	getRepositoryByJNDI()
protected javax.jcr.Repository	getRepositoryByRMI()
String	getRepositoryName()
String	getRmibind()
JCRStoreService	getService()
javax.jcr.Session	getSession(javax.jcr.Credentials credentials, String workspace)
JCRSessionFactory	getSessionFactory()
JCRNodeWrapper	getSiteFolder(String site)
JahiaSitesService	getSitesService()
protected javax.jcr.Credentials	getSystemCredentials()
JCRSessionWrapper	getSystemSession()
JCRSessionWrapper	getSystemSession(String workspace)
String	getUrl()
JCRNodeWrapper	getUserFolder(JahiaUser user)
JahiaUserManagerService	getUserManagerService()
Map<String,Constructor<?>>	getValidators()
javax.jcr.PropertyIterator	getWeakReferences(JCRNodeWrapper node, String propertyName, javax.jcr.Session session) Get weak references of a node
String	getWebdavPath()
int	hashCode()
protected void	initContent()
protected void	initDynamicMountPoints()
protected void	initNodeTypes()
protected void	initObservers()
boolean	isAvailable() Same as isAvailable(false)
boolean	isAvailable(boolean silent) Checks whether this provider is available to serve content.
boolean	isDefault()
boolean	isDynamicallyMounted()
boolean	isExportable() Deprecated. now canExportNode and canExportProperty are used Indicates if the nodes, backed by this provider, are considered during export operation.
boolean	isInitialized()
boolean	isLockingAvailable()
boolean	isMainStorage()
boolean	isReadOnly()
boolean	isRunning() Deprecated. with no replacement
boolean	isSearchAvailable()
boolean	isSlowConnection()
boolean	isUpdateMixinAvailable()
boolean	isVersioningAvailable()
protected void	registerCustomNodeTypes(String systemId, javax.jcr.Workspace ws)
void	registerNamespaces() Deploy all namespaces into provider
protected void	rmiBind()
protected void	rmiUnbind()
void	setAuthenticationType(String authenticationType)
void	setDynamicallyMounted(boolean dynamicallyMounted)
void	setFactory(String factory)
void	setGroupManagerService(JahiaGroupManagerService groupManagerService)
void	setGuestPassword(String password)
void	setGuestUser(String user)
void	setKey(String key)
void	setMainStorage(boolean mainStorage)
void	setMountPoint(String mountPoint)
void	setMountStatus(JCRMountPointNode.MountStatus status) Sets the mount status of this provider to the specified one.
void	setMountStatus(JCRMountPointNode.MountStatus status, String message) Sets the mount status of this provider to the specified one.
void	setMountStatusMessage(String mountStatusMessage)
void	setObserversUseRelativeRoot(boolean observersUseRelativePath)
void	setPatcher(Patcher patcher)
void	setProvidesDynamicMountPoints(boolean providesDynamicMountPoints)
void	setRegisterObservers(boolean registerObservers)
void	setRelativeRoot(String relativeRoot)
void	setRepository(javax.jcr.Repository repo)
void	setRepositoryName(String repositoryName)
void	setRmibind(String rmibind)
void	setService(JCRStoreService service)
void	setSessionFactory(JCRSessionFactory sessionFactory)
void	setSessionKeepAliveCheckInterval(long sessionKeepAliveCheckInterval) Deprecated. without no replacement
void	setSitesService(JahiaSitesService sitesService)
void	setSlowConnection(boolean slowConnection)
void	setSystemPassword(String password)
void	setSystemUser(String user)
void	setUrl(String url)
void	setUserManagerService(JahiaUserManagerService userManagerService)
void	setWebdavPath(String webdavPath)
void	start()
boolean	start(boolean checkAvailability) Starts this provider if possible, checking its availability before attempting the starting procedure if so requested.
void	stop()
void	undeployDefinitions(String systemId) Undeploy definitions registered with the given systemId from the underlying repository
protected void	unregisterCustomNodeTypes(String systemId, javax.jcr.Workspace ws)
protected void	unregisterObservers()

Methods inherited from class java.lang.Object

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

Field Detail

systemUser

protected String systemUser

systemPassword

protected String systemPassword

guestUser

protected String guestUser

guestPassword

protected String guestPassword

authenticationType

protected String authenticationType

rmibind

protected String rmibind

sessionFactory

protected JCRSessionFactory sessionFactory

repo

protected volatile javax.jcr.Repository repo

Constructor Detail

JCRStoreProvider

public JCRStoreProvider()

Method Detail

getKey

public String getKey()

setKey

public void setKey(String key)

getMountPoint

public String getMountPoint()

setMountPoint

public void setMountPoint(String mountPoint)

getWebdavPath

public String getWebdavPath()

getRelativeRoot

public String getRelativeRoot()

setRelativeRoot

public void setRelativeRoot(String relativeRoot)

getDepth

public int getDepth()

setWebdavPath

public void setWebdavPath(String webdavPath)

getHttpPath

public String getHttpPath()

getRepositoryName

public String getRepositoryName()

setRepositoryName

public void setRepositoryName(String repositoryName)

getFactory

public String getFactory()

setFactory

public void setFactory(String factory)

getUrl

public String getUrl()

setUrl

public void setUrl(String url)

setSystemUser

public void setSystemUser(String user)

setSystemPassword

public void setSystemPassword(String password)

setGuestUser

public void setGuestUser(String user)

setGuestPassword

public void setGuestPassword(String password)

getAuthenticationType

public String getAuthenticationType()

setAuthenticationType

public void setAuthenticationType(String authenticationType)

getRmibind

public String getRmibind()

setRmibind

public void setRmibind(String rmibind)

getUserManagerService

public JahiaUserManagerService getUserManagerService()

setUserManagerService

public void setUserManagerService(JahiaUserManagerService userManagerService)

getGroupManagerService

public JahiaGroupManagerService getGroupManagerService()

setGroupManagerService

public void setGroupManagerService(JahiaGroupManagerService groupManagerService)

getSitesService

public JahiaSitesService getSitesService()

setSitesService

public void setSitesService(JahiaSitesService sitesService)

getService

public JCRStoreService getService()

setService

public void setService(JCRStoreService service)

getSessionFactory

public JCRSessionFactory getSessionFactory()

setSessionFactory

public void setSessionFactory(JCRSessionFactory sessionFactory)

setSessionKeepAliveCheckInterval

@Deprecated
public void setSessionKeepAliveCheckInterval(long sessionKeepAliveCheckInterval)

Deprecated. without no replacement

getPatcher

public Patcher getPatcher()

setPatcher

public void setPatcher(Patcher patcher)

start

public void start()
           throws JahiaInitializationException

Throws:

JahiaInitializationException

start

public boolean start(boolean checkAvailability)
              throws JahiaInitializationException

Starts this provider if possible, checking its availability before attempting the starting procedure if so requested.

Parameters:

checkAvailability - whether or not to check the availability before attempting the starting procedure

Returns:

true if this provider is available or availability checking was not requested, false otherwise.

Throws:

JahiaInitializationException

isAvailable

public boolean isAvailable()

Same as isAvailable(false)

Returns:

whether this provider is available to serve content

isAvailable

public boolean isAvailable(boolean silent)

Checks whether this provider is available to serve content.

Parameters:

silent - true if the check should be done silently (i.e. without outputting information on the console), false otherwise

Returns:

true if this provider can serve content, false otherwise.

checkAvailability

public void checkAvailability()
                       throws javax.jcr.RepositoryException

Throws:

javax.jcr.RepositoryException

setMountStatus

public void setMountStatus(JCRMountPointNode.MountStatus status)

Sets the mount status of this provider to the specified one.

Parameters:

status - the new status of this provider

setMountStatus

public void setMountStatus(JCRMountPointNode.MountStatus status,
                           String message)

Sets the mount status of this provider to the specified one.

Parameters:

status - the new status of this provider

getMountStatusMessage

public String getMountStatusMessage()

setMountStatusMessage

public void setMountStatusMessage(String mountStatusMessage)

initNodeTypes

protected void initNodeTypes()
                      throws javax.jcr.RepositoryException,
                             IOException

Throws:

javax.jcr.RepositoryException

IOException

initObservers

protected void initObservers()
                      throws javax.jcr.RepositoryException

Throws:

javax.jcr.RepositoryException

initContent

protected void initContent()
                    throws javax.jcr.RepositoryException,
                           IOException

Throws:

javax.jcr.RepositoryException

IOException

initDynamicMountPoints

protected void initDynamicMountPoints()

stop

public void stop()

rmiUnbind

protected void rmiUnbind()

isRunning

@Deprecated
public boolean isRunning()

Deprecated. with no replacement

deployDefinitions

public void deployDefinitions(String systemId)
                       throws IOException,
                              javax.jcr.RepositoryException

Deploy definitions registered with the given systemId into the underlying repository

Parameters:

systemId -

Throws:

IOException

javax.jcr.RepositoryException - in case of JCR-related errors

registerNamespaces

public void registerNamespaces()
                        throws javax.jcr.RepositoryException

Deploy all namespaces into provider

Throws:

javax.jcr.RepositoryException - in case of JCR-related errors

undeployDefinitions

public void undeployDefinitions(String systemId)
                         throws IOException,
                                javax.jcr.RepositoryException

Undeploy definitions registered with the given systemId from the underlying repository

Parameters:

systemId -

Throws:

IOException

javax.jcr.RepositoryException - in case of JCR-related errors

getRepository

public javax.jcr.Repository getRepository()

rmiBind

protected void rmiBind()

createRepository

protected javax.jcr.Repository createRepository()

Creates an instance of the content repository.

Returns:

an instance of the Repository

setRepository

public void setRepository(javax.jcr.Repository repo)

getRepositoryByJNDI

protected javax.jcr.Repository getRepositoryByJNDI()

getRepositoryByRMI

protected javax.jcr.Repository getRepositoryByRMI()

getSession

public javax.jcr.Session getSession(javax.jcr.Credentials credentials,
                                    String workspace)
                             throws javax.jcr.RepositoryException

Throws:

javax.jcr.RepositoryException

getCredentials

protected javax.jcr.Credentials getCredentials(javax.jcr.Credentials originalCredentials)
                                        throws javax.jcr.PathNotFoundException,
                                               javax.jcr.RepositoryException,
                                               javax.jcr.ValueFormatException

Throws:

javax.jcr.PathNotFoundException

javax.jcr.RepositoryException

javax.jcr.ValueFormatException

getItemWrapper

public JCRItemWrapper getItemWrapper(javax.jcr.Item item,
                                     JCRSessionWrapper session)
                              throws javax.jcr.RepositoryException

Throws:

javax.jcr.RepositoryException

getNodeWrapper

public JCRNodeWrapper getNodeWrapper(javax.jcr.Node objectNode,
                                     JCRSessionWrapper session)
                              throws javax.jcr.RepositoryException

Throws:

javax.jcr.RepositoryException

getNodeWrapper

public JCRNodeWrapper getNodeWrapper(javax.jcr.Node objectNode,
                                     String path,
                                     JCRNodeWrapper parent,
                                     JCRSessionWrapper session)
                              throws javax.jcr.RepositoryException

Throws:

javax.jcr.RepositoryException

getPropertyWrapper

public JCRPropertyWrapper getPropertyWrapper(javax.jcr.Property prop,
                                             JCRSessionWrapper session)
                                      throws javax.jcr.RepositoryException

Throws:

javax.jcr.RepositoryException

canRegisterCustomNodeTypes

protected boolean canRegisterCustomNodeTypes()

registerCustomNodeTypes

protected void registerCustomNodeTypes(String systemId,
                                       javax.jcr.Workspace ws)
                                throws IOException,
                                       javax.jcr.RepositoryException

Throws:

IOException

javax.jcr.RepositoryException

unregisterCustomNodeTypes

protected void unregisterCustomNodeTypes(String systemId,
                                         javax.jcr.Workspace ws)
                                  throws IOException,
                                         javax.jcr.RepositoryException

Throws:

IOException

javax.jcr.RepositoryException

getUserFolder

public JCRNodeWrapper getUserFolder(JahiaUser user)
                             throws javax.jcr.RepositoryException

Throws:

javax.jcr.RepositoryException

getImportDropBoxes

public List<JCRNodeWrapper> getImportDropBoxes(String site,
                                               JahiaUser user)
                                        throws javax.jcr.RepositoryException

Throws:

javax.jcr.RepositoryException

getSiteFolder

public JCRNodeWrapper getSiteFolder(String site)
                             throws javax.jcr.RepositoryException

Throws:

javax.jcr.RepositoryException

getAbsoluteContextPath

public String getAbsoluteContextPath(javax.servlet.ServletRequest request)

isMainStorage

public boolean isMainStorage()

setMainStorage

public void setMainStorage(boolean mainStorage)

isDynamicallyMounted

public boolean isDynamicallyMounted()

setDynamicallyMounted

public void setDynamicallyMounted(boolean dynamicallyMounted)

isExportable

@Deprecated
public boolean isExportable()

Deprecated. now canExportNode and canExportProperty are used Indicates if the nodes, backed by this provider, are considered during export operation.

Returns:

true if the nodes, backed by this provider, are also included during the export operation; false if they are skipped

canCacheNode

public boolean canCacheNode(javax.jcr.Node node)

Checks if the specified node, backed by this provider, can be cached. This is useful e.g. in /files servlet which can cache the last modified data of the file to optimize the resource loading. A particular provider could override this method to return true for nodes, which are either read-only or can push observation events if their content is changed, to ensure cache consistency.

Returns:

true if the specified node can be cached; false otherwise

canExportNode

public boolean canExportNode(javax.jcr.Node node)

Indicates if the specified node, backed by this provider, is considered during export operation

Returns:

true if the specified node, backed by this provider, is included during the export operation false if it isn't

canExportProperty

public boolean canExportProperty(javax.jcr.Property property)

Indicates if the specified property, backed by this provider, is considered during export operation

Returns:

true if the specified property, backed by this provider, is included during the export operation false if it isn't

isDefault

public boolean isDefault()

dump

protected void dump(javax.jcr.Node n)
             throws javax.jcr.RepositoryException

Throws:

javax.jcr.RepositoryException

getQueryManager

public javax.jcr.query.QueryManager getQueryManager(JCRSessionWrapper session)
                                             throws javax.jcr.RepositoryException

Throws:

javax.jcr.RepositoryException

getSystemSession

public JCRSessionWrapper getSystemSession()
                                   throws javax.jcr.RepositoryException

Throws:

javax.jcr.RepositoryException

getSystemSession

public JCRSessionWrapper getSystemSession(String workspace)
                                   throws javax.jcr.RepositoryException

Throws:

javax.jcr.RepositoryException

isInitialized

public boolean isInitialized()

setProvidesDynamicMountPoints

public void setProvidesDynamicMountPoints(boolean providesDynamicMountPoints)

isReadOnly

public boolean isReadOnly()

isVersioningAvailable

public boolean isVersioningAvailable()

isLockingAvailable

public boolean isLockingAvailable()

isSearchAvailable

public boolean isSearchAvailable()

isUpdateMixinAvailable

public boolean isUpdateMixinAvailable()

isSlowConnection

public boolean isSlowConnection()

setSlowConnection

public void setSlowConnection(boolean slowConnection)

getWeakReferences

public javax.jcr.PropertyIterator getWeakReferences(JCRNodeWrapper node,
                                                    String propertyName,
                                                    javax.jcr.Session session)
                                             throws javax.jcr.RepositoryException

Get weak references of a node

Parameters:

node - node

propertyName - name of the property

session - session

Returns:

an iterator

Throws:

javax.jcr.RepositoryException - in case of JCR-related errors

compareTo

public int compareTo(JCRStoreProvider o)

Specified by:

compareTo in interface Comparable<JCRStoreProvider>

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getValidators

public Map<String,Constructor<?>> getValidators()

setRegisterObservers

public void setRegisterObservers(boolean registerObservers)

setObserversUseRelativeRoot

public void setObserversUseRelativeRoot(boolean observersUseRelativePath)

unregisterObservers

protected void unregisterObservers()

getGuestCredentials

protected javax.jcr.Credentials getGuestCredentials()

getSystemCredentials

protected javax.jcr.Credentials getSystemCredentials()