org.jahia.services.content

Class JCRSessionFactory

java.lang.Object

org.jahia.services.content.JCRSessionFactory

All Implemented Interfaces:

javax.jcr.Repository, ReadOnlyModeCapable, org.springframework.beans.factory.Aware, org.springframework.web.context.ServletContextAware

public class JCRSessionFactory
extends Object
implements javax.jcr.Repository, org.springframework.web.context.ServletContextAware, ReadOnlyModeCapable

The entry point into the content repositories provided by the JCRStoreProvider list. Instead of using this class for creating and using sessions, please rather use the JCRTemplate.

Author:

toto

See Also:

JCRTemplate

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_PROVIDER_KEY
protected ThreadLocal<Map<String,Map<String,JCRSessionWrapper>>>	systemSession
protected ThreadLocal<Map<String,Map<String,JCRSessionWrapper>>>	userSession

Fields inherited from interface javax.jcr.Repository

IDENTIFIER_STABILITY, IDENTIFIER_STABILITY_INDEFINITE_DURATION, IDENTIFIER_STABILITY_METHOD_DURATION, IDENTIFIER_STABILITY_SAVE_DURATION, IDENTIFIER_STABILITY_SESSION_DURATION, LEVEL_1_SUPPORTED, LEVEL_2_SUPPORTED, NODE_TYPE_MANAGEMENT_AUTOCREATED_DEFINITIONS_SUPPORTED, NODE_TYPE_MANAGEMENT_INHERITANCE, NODE_TYPE_MANAGEMENT_INHERITANCE_MINIMAL, NODE_TYPE_MANAGEMENT_INHERITANCE_MULTIPLE, NODE_TYPE_MANAGEMENT_INHERITANCE_SINGLE, NODE_TYPE_MANAGEMENT_MULTIPLE_BINARY_PROPERTIES_SUPPORTED, NODE_TYPE_MANAGEMENT_MULTIVALUED_PROPERTIES_SUPPORTED, NODE_TYPE_MANAGEMENT_ORDERABLE_CHILD_NODES_SUPPORTED, NODE_TYPE_MANAGEMENT_OVERRIDES_SUPPORTED, NODE_TYPE_MANAGEMENT_PRIMARY_ITEM_NAME_SUPPORTED, NODE_TYPE_MANAGEMENT_PROPERTY_TYPES, NODE_TYPE_MANAGEMENT_RESIDUAL_DEFINITIONS_SUPPORTED, NODE_TYPE_MANAGEMENT_SAME_NAME_SIBLINGS_SUPPORTED, NODE_TYPE_MANAGEMENT_UPDATE_IN_USE_SUPORTED, NODE_TYPE_MANAGEMENT_VALUE_CONSTRAINTS_SUPPORTED, OPTION_ACCESS_CONTROL_SUPPORTED, OPTION_ACTIVITIES_SUPPORTED, OPTION_BASELINES_SUPPORTED, OPTION_JOURNALED_OBSERVATION_SUPPORTED, OPTION_LIFECYCLE_SUPPORTED, OPTION_LOCKING_SUPPORTED, OPTION_NODE_AND_PROPERTY_WITH_SAME_NAME_SUPPORTED, OPTION_NODE_TYPE_MANAGEMENT_SUPPORTED, OPTION_OBSERVATION_SUPPORTED, OPTION_QUERY_SQL_SUPPORTED, OPTION_RETENTION_SUPPORTED, OPTION_SHAREABLE_NODES_SUPPORTED, OPTION_SIMPLE_VERSIONING_SUPPORTED, OPTION_TRANSACTIONS_SUPPORTED, OPTION_UNFILED_CONTENT_SUPPORTED, OPTION_UPDATE_MIXIN_NODE_TYPES_SUPPORTED, OPTION_UPDATE_PRIMARY_NODE_TYPE_SUPPORTED, OPTION_VERSIONING_SUPPORTED, OPTION_WORKSPACE_MANAGEMENT_SUPPORTED, OPTION_XML_EXPORT_SUPPORTED, OPTION_XML_IMPORT_SUPPORTED, QUERY_FULL_TEXT_SEARCH_SUPPORTED, QUERY_JOINS, QUERY_JOINS_INNER, QUERY_JOINS_INNER_OUTER, QUERY_JOINS_NONE, QUERY_LANGUAGES, QUERY_STORED_QUERIES_SUPPORTED, QUERY_XPATH_DOC_ORDER, QUERY_XPATH_POS_INDEX, REP_NAME_DESC, REP_VENDOR_DESC, REP_VENDOR_URL_DESC, REP_VERSION_DESC, SPEC_NAME_DESC, SPEC_VERSION_DESC, WRITE_SUPPORTED

Method Summary

Modifier and Type	Method and Description
void	addProvider(JCRStoreProvider p) Registers the JCR store provider.
void	addProvider(String key, String mountPoint, JCRStoreProvider p) Deprecated. use addProvider(JCRStoreProvider) instead
boolean	areMultipleMountPointsRegistered() Returns true if more than one (default) mount points are registered.
void	closeAllSessions()
javax.jcr.Session	findSameSession(JCRStoreProvider provider, String userID, String ws, boolean system)
JahiaUser	getCurrentAliasedUser()
Locale	getCurrentLocale()
Calendar	getCurrentPreviewDate()
String	getCurrentServletPath()
JCRSessionWrapper	getCurrentSession(String workspace, Locale locale, Locale fallbackLocale, boolean system)
JCRSessionWrapper	getCurrentSystemSession(String workspace, Locale locale, Locale fallbackLocale)
JahiaUser	getCurrentUser()
JCRSessionWrapper	getCurrentUserSession()
JCRSessionWrapper	getCurrentUserSession(String workspace)
JCRSessionWrapper	getCurrentUserSession(String workspace, Locale locale)
JCRSessionWrapper	getCurrentUserSession(String workspace, Locale locale, Locale fallbackLocale)
JCRStoreProvider	getDefaultProvider()
String	getDescriptor(String s)
String[]	getDescriptorKeys()
javax.jcr.Value	getDescriptorValue(String key)
javax.jcr.Value[]	getDescriptorValues(String key)
Locale	getFallbackLocale()
static JCRSessionFactory	getInstance()
Map<String,JCRStoreProvider>	getMountPoints() Returns a read-only view of the known mount points.
javax.jcr.NamespaceRegistry	getNamespaceRegistry()
JCRStoreProvider	getProvider(String path) Returns the provider which is handling the provided node path.
JCRStoreProvider	getProvider(String path, boolean includeDefault) Returns the provider which is handling the provided node path.
List<JCRStoreProvider>	getProviderList() Returns a list of providers ordered by registration order.
Map<String,JCRStoreProvider>	getProviders()
Boolean	getReadOnlyCacheEnabled()
int	getReadOnlyModePriority() Get the priority of the service.
protected JCRSessionWrapper	getSystemSession()
protected JCRSessionWrapper	getSystemSession(String username, String realm, String workspace, Locale locale)
protected JCRSessionWrapper	getUserSession(String username, String realm, String workspace, Locale locale)
org.springframework.validation.beanvalidation.LocalValidatorFactoryBean	getValidatorFactoryBean()
boolean	isSingleValueDescriptor(String key)
boolean	isStandardDescriptor(String key)
JCRSessionWrapper	login()
JCRSessionWrapper	login(javax.jcr.Credentials credentials)
JCRSessionWrapper	login(javax.jcr.Credentials credentials, String workspace)
JCRSessionWrapper	login(String workspace)
void	removeProvider(String key) Unregister a provider
void	setCurrentAliasedUser(JahiaUser user)
void	setCurrentLocale(Locale locale)
void	setCurrentPreviewDate(Calendar previewDate)
void	setCurrentServletPath(String path)
void	setCurrentUser(JahiaUser user)
void	setDescriptors(Map<String,String> descriptors)
void	setFallbackLocale(Locale locale)
void	setReadOnlyCacheEnabled(Boolean readOnlyCacheEnabled)
void	setServletContext(javax.servlet.ServletContext servletContext)
void	setServletContextAttributeName(String servletContextAttributeName)
void	setUserService(JahiaUserManagerService userService)
void	setValidatorFactoryBean(org.springframework.validation.beanvalidation.LocalValidatorFactoryBean validatorFactoryBean)
void	start()
void	switchReadOnlyMode(boolean enable) Enable/disable read-only mode for a specific functional area this ReadOnlyModeCapable is responsible for.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_PROVIDER_KEY

public static final String DEFAULT_PROVIDER_KEY

See Also:

Constant Field Values

userSession

protected ThreadLocal<Map<String,Map<String,JCRSessionWrapper>>> userSession

systemSession

protected ThreadLocal<Map<String,Map<String,JCRSessionWrapper>>> systemSession

Method Detail

start

public void start()

setServletContextAttributeName

public void setServletContextAttributeName(String servletContextAttributeName)

setServletContext

public void setServletContext(javax.servlet.ServletContext servletContext)

Specified by:

setServletContext in interface org.springframework.web.context.ServletContextAware

setDescriptors

public void setDescriptors(Map<String,String> descriptors)

setUserService

public void setUserService(JahiaUserManagerService userService)

getCurrentUserSession

public JCRSessionWrapper getCurrentUserSession()
                                        throws javax.jcr.RepositoryException

Throws:

javax.jcr.RepositoryException

getCurrentUserSession

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

Throws:

javax.jcr.RepositoryException

getCurrentUserSession

public JCRSessionWrapper getCurrentUserSession(String workspace,
                                               Locale locale)
                                        throws javax.jcr.RepositoryException

Throws:

javax.jcr.RepositoryException

getCurrentUserSession

public JCRSessionWrapper getCurrentUserSession(String workspace,
                                               Locale locale,
                                               Locale fallbackLocale)
                                        throws javax.jcr.RepositoryException

Throws:

javax.jcr.RepositoryException

getCurrentSystemSession

public JCRSessionWrapper getCurrentSystemSession(String workspace,
                                                 Locale locale,
                                                 Locale fallbackLocale)
                                          throws javax.jcr.RepositoryException

Throws:

javax.jcr.RepositoryException

getCurrentSession

public JCRSessionWrapper getCurrentSession(String workspace,
                                           Locale locale,
                                           Locale fallbackLocale,
                                           boolean system)
                                    throws javax.jcr.RepositoryException

Throws:

javax.jcr.RepositoryException

getSystemSession

protected JCRSessionWrapper getSystemSession()
                                      throws javax.jcr.RepositoryException

Throws:

javax.jcr.RepositoryException

getSystemSession

protected JCRSessionWrapper getSystemSession(String username,
                                             String realm,
                                             String workspace,
                                             Locale locale)
                                      throws javax.jcr.RepositoryException

Throws:

javax.jcr.RepositoryException

getUserSession

protected JCRSessionWrapper getUserSession(String username,
                                           String realm,
                                           String workspace,
                                           Locale locale)
                                    throws javax.jcr.RepositoryException

Throws:

javax.jcr.RepositoryException

getDescriptorKeys

public String[] getDescriptorKeys()

Specified by:

getDescriptorKeys in interface javax.jcr.Repository

getDescriptor

public String getDescriptor(String s)

Specified by:

getDescriptor in interface javax.jcr.Repository

findSameSession

public javax.jcr.Session findSameSession(JCRStoreProvider provider,
                                         String userID,
                                         String ws,
                                         boolean system)
                                  throws javax.jcr.RepositoryException

Throws:

javax.jcr.RepositoryException

login

public JCRSessionWrapper login(javax.jcr.Credentials credentials,
                               String workspace)
                        throws javax.jcr.LoginException,
                               javax.jcr.NoSuchWorkspaceException,
                               javax.jcr.RepositoryException

Specified by:

login in interface javax.jcr.Repository

Throws:

javax.jcr.LoginException

javax.jcr.NoSuchWorkspaceException

javax.jcr.RepositoryException

login

public JCRSessionWrapper login(javax.jcr.Credentials credentials)
                        throws javax.jcr.LoginException,
                               javax.jcr.RepositoryException

Specified by:

login in interface javax.jcr.Repository

Throws:

javax.jcr.LoginException

javax.jcr.RepositoryException

login

public JCRSessionWrapper login(String workspace)
                        throws javax.jcr.LoginException,
                               javax.jcr.NoSuchWorkspaceException,
                               javax.jcr.RepositoryException

Specified by:

login in interface javax.jcr.Repository

Throws:

javax.jcr.LoginException

javax.jcr.NoSuchWorkspaceException

javax.jcr.RepositoryException

login

public JCRSessionWrapper login()
                        throws javax.jcr.LoginException,
                               javax.jcr.RepositoryException

Specified by:

login in interface javax.jcr.Repository

Throws:

javax.jcr.LoginException

javax.jcr.RepositoryException

isStandardDescriptor

public boolean isStandardDescriptor(String key)

Specified by:

isStandardDescriptor in interface javax.jcr.Repository

isSingleValueDescriptor

public boolean isSingleValueDescriptor(String key)

Specified by:

isSingleValueDescriptor in interface javax.jcr.Repository

getDescriptorValue

public javax.jcr.Value getDescriptorValue(String key)

Specified by:

getDescriptorValue in interface javax.jcr.Repository

getDescriptorValues

public javax.jcr.Value[] getDescriptorValues(String key)

Specified by:

getDescriptorValues in interface javax.jcr.Repository

getMountPoints

public Map<String,JCRStoreProvider> getMountPoints()

Returns a read-only view of the known mount points.

Returns:

a read-only view of the known mount points.

getProviders

public Map<String,JCRStoreProvider> getProviders()

getDefaultProvider

public JCRStoreProvider getDefaultProvider()

addProvider

public void addProvider(JCRStoreProvider p)

Registers the JCR store provider.

Parameters:

p - the provider instance

addProvider

@Deprecated
public void addProvider(String key,
                                    String mountPoint,
                                    JCRStoreProvider p)

Deprecated. use addProvider(JCRStoreProvider) instead

Registers the JCR store provider.

Parameters:

key - the key of the provider

mountPoint - provider's mount point

p - the provider instance

removeProvider

public void removeProvider(String key)

Unregister a provider

Parameters:

key - the key of the provider

getProviderList

public List<JCRStoreProvider> getProviderList()

Returns a list of providers ordered by registration order. This is important because some providers are more "low-level" than others.

Returns:

an ORDERED list of providers

getInstance

public static JCRSessionFactory getInstance()

closeAllSessions

public void closeAllSessions()

getProvider

public JCRStoreProvider getProvider(String path)

Returns the provider which is handling the provided node path. If there is no other provider which can handle the specified node path, the default Jackrabbit ("/") provider is returned.

Parameters:

path - the node path to be checked

Returns:

the provider which handles the provided node path or the default provider if there is no other provider which can handle the specified node path

getProvider

public JCRStoreProvider getProvider(String path,
                                    boolean includeDefault)

Returns the provider which is handling the provided node path.

Parameters:

path - the node path to be checked

includeDefault - if true the default provider is considered; otherwise only the non-default providers (others that "/") are checked.

Returns:

the provider which handles the provided node path or null if there is no such provider; note, please, if includeDefault parameter is passed with true value the default provider is returned if there is no other provider which can handle the specified node path

getNamespaceRegistry

public javax.jcr.NamespaceRegistry getNamespaceRegistry()
                                                 throws javax.jcr.RepositoryException

Throws:

javax.jcr.RepositoryException

getCurrentUser

public JahiaUser getCurrentUser()

setCurrentUser

public void setCurrentUser(JahiaUser user)

getCurrentLocale

public Locale getCurrentLocale()

setCurrentLocale

public void setCurrentLocale(Locale locale)

getFallbackLocale

public Locale getFallbackLocale()

setFallbackLocale

public void setFallbackLocale(Locale locale)

getCurrentAliasedUser

public JahiaUser getCurrentAliasedUser()

setCurrentAliasedUser

public void setCurrentAliasedUser(JahiaUser user)

getReadOnlyCacheEnabled

public Boolean getReadOnlyCacheEnabled()

setReadOnlyCacheEnabled

public void setReadOnlyCacheEnabled(Boolean readOnlyCacheEnabled)

getCurrentServletPath

public String getCurrentServletPath()

setCurrentServletPath

public void setCurrentServletPath(String path)

setCurrentPreviewDate

public void setCurrentPreviewDate(Calendar previewDate)

getCurrentPreviewDate

public Calendar getCurrentPreviewDate()

getValidatorFactoryBean

public org.springframework.validation.beanvalidation.LocalValidatorFactoryBean getValidatorFactoryBean()

setValidatorFactoryBean

public void setValidatorFactoryBean(org.springframework.validation.beanvalidation.LocalValidatorFactoryBean validatorFactoryBean)

areMultipleMountPointsRegistered

public boolean areMultipleMountPointsRegistered()

Returns true if more than one (default) mount points are registered.

Returns:

true if more than one (default) mount points are registered; false otherwise

getReadOnlyModePriority

public int getReadOnlyModePriority()

Description copied from interface: ReadOnlyModeCapable

Get the priority of the service.

Specified by:

getReadOnlyModePriority in interface ReadOnlyModeCapable

Returns:

the priority of the service; higher priority means earlier invocation of switchReadOnlyMode when switching read only mode on, and later invocation when switching it off

switchReadOnlyMode

public void switchReadOnlyMode(boolean enable)

Description copied from interface: ReadOnlyModeCapable

Enable/disable read-only mode for a specific functional area this ReadOnlyModeCapable is responsible for.

Specified by:

switchReadOnlyMode in interface ReadOnlyModeCapable

Parameters:

enable - true in case the read-only mode should be enabled; false otherwise