SpringJackrabbitRepository (Jahia Server Implementation 8.0.0.0 API)

java.lang.Object
- org.apache.jackrabbit.commons.AbstractRepository
- - org.jahia.services.content.impl.jackrabbit.SpringJackrabbitRepository

All Implemented Interfaces:

javax.jcr.Repository, org.apache.jackrabbit.api.JackrabbitRepository, ReadOnlyModeCapable, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware, org.springframework.web.context.ServletContextAware
```
public class SpringJackrabbitRepository
extends org.apache.jackrabbit.commons.AbstractRepository
implements org.apache.jackrabbit.api.JackrabbitRepository, org.springframework.web.context.ServletContextAware, org.springframework.context.ApplicationContextAware, ReadOnlyModeCapable
```
Spring-configured Jackrabbit repository. User: toto Date: Feb 9, 2009 Time: 11:21:20 AM

Field Summary
- Fields inherited from interface org.apache.jackrabbit.api.JackrabbitRepository
  OPTION_PRINCIPAL_MANAGEMENT_SUPPORTED, OPTION_PRIVILEGE_MANAGEMENT_SUPPORTED, OPTION_USER_MANAGEMENT_SUPPORTED
- 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

Constructor Summary

Constructors
Constructor and Description

SpringJackrabbitRepository()

Constructors
Constructor and Description
`SpringJackrabbitRepository()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected org.apache.jackrabbit.api.JackrabbitRepository`	`createRepository()` Creates a repository instance based on the contained JNDI reference.
`org.apache.jackrabbit.core.cluster.ClusterNode`	`getClusterNode()` Jackrabbit cluster node instance or `null` if clustering is not activated.
`long`	`getClusterRevision()` Returns current Jackrabbit cluster node revision or `0` if clustering is not activated.
`org.springframework.core.io.Resource`	`getConfigFile()`
`String`	`getDescriptor(String key)` Delegated to the underlying repository instance.
`String[]`	`getDescriptorKeys()` Delegated to the underlying repository instance.
`javax.jcr.Value`	`getDescriptorValue(String key)`
`javax.jcr.Value[]`	`getDescriptorValues(String key)`
`org.springframework.core.io.Resource`	`getHomeDir()`
`static SpringJackrabbitRepository`	`getInstance()` Returns a singleton instance of this class.
`int`	`getReadOnlyModePriority()` Get the priority of the service.
`org.apache.jackrabbit.api.JackrabbitRepository`	`getRepository()`
`String`	`getServletContextAttributeName()`
`boolean`	`isSingleValueDescriptor(String key)`
`javax.jcr.Session`	`login(javax.jcr.Credentials credentials, String workspaceName)` Delegated to the underlying repository instance.
`void`	`setApplicationContext(org.springframework.context.ApplicationContext applicationContext)`
`void`	`setConfigFile(org.springframework.core.io.Resource configFile)`
`void`	`setDataStoreGarbageCollectorBeanId(String dataStoreGarbageCollectorBeanId)`
`void`	`setHomeDir(org.springframework.core.io.Resource homeDir)`
`void`	`setPerformMigrationToDataStoreIfNeeded(boolean performMigrationToDataStoreIfNeeded)`
`void`	`setServletContext(javax.servlet.ServletContext servletContext)`
`void`	`setServletContextAttributeName(String servletContextAttributeName)`
`void`	`setSettings(SettingsBean settings)`
`void`	`setTimeoutSwitchingToReadOnlyMode(long timeoutSwitchingToReadOnlyMode)` Set timeout waiting until switching to read only mode is possible.
`void`	`shutdown()` Delegated to the underlying repository instance.
`void`	`start()`
`void`	`stop()`
`void`	`switchReadOnlyMode(boolean enable)` Enable/disable read-only mode for a specific functional area this ReadOnlyModeCapable is responsible for.
`void`	`syncClusterNode()` Performs the sync on the Jackrabbit cluster node.

Methods inherited from class org.apache.jackrabbit.commons.AbstractRepository
isStandardDescriptor, login, login, login, login

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.jackrabbit.api.JackrabbitRepository
login

Methods inherited from interface javax.jcr.Repository
isStandardDescriptor, login, login, login

- Constructor Detail
  - SpringJackrabbitRepository
```
public SpringJackrabbitRepository()
```
- Method Detail
  - getInstance
```
public static SpringJackrabbitRepository getInstance()
```
    Returns a singleton instance of this class.
    
    Returns:
    
    a singleton instance of this class
  - getConfigFile
```
public org.springframework.core.io.Resource getConfigFile()
```
  - setConfigFile
```
public void setConfigFile(org.springframework.core.io.Resource configFile)
```
  - getHomeDir
```
public org.springframework.core.io.Resource getHomeDir()
```
  - setHomeDir
```
public void setHomeDir(org.springframework.core.io.Resource homeDir)
```
  - getServletContextAttributeName
```
public String getServletContextAttributeName()
```
  - setServletContextAttributeName
```
public void setServletContextAttributeName(String servletContextAttributeName)
```
  - setServletContext
```
public void setServletContext(javax.servlet.ServletContext servletContext)
```
    Specified by:
    
    setServletContext in interface org.springframework.web.context.ServletContextAware
  - createRepository
```
protected org.apache.jackrabbit.api.JackrabbitRepository createRepository()
                                                                   throws javax.jcr.RepositoryException,
                                                                          IOException
```
    Creates a repository instance based on the contained JNDI reference. Can be overridden by subclasses to return different repositories. A subclass can access the JNDI reference through the
    
    Returns:
    
    repository instance
    
    Throws:
    
    javax.jcr.RepositoryException - if the repository could not be created
    
    IOException
  - start
```
public void start()
           throws javax.jcr.RepositoryException,
                  IOException
```
    Throws:
    
    javax.jcr.RepositoryException
    
    IOException
  - stop
```
public void stop()
```
  - login
```
public javax.jcr.Session login(javax.jcr.Credentials credentials,
                               String workspaceName)
                        throws javax.jcr.LoginException,
                               javax.jcr.NoSuchWorkspaceException,
                               javax.jcr.RepositoryException
```
    Delegated to the underlying repository instance.
    
    Specified by:
    
    login in interface javax.jcr.Repository
    
    Throws:
    
    javax.jcr.LoginException
    
    javax.jcr.NoSuchWorkspaceException
    
    javax.jcr.RepositoryException
  - getDescriptor
```
public String getDescriptor(String key)
```
    Delegated to the underlying repository instance.
    
    Specified by:
    
    getDescriptor in interface javax.jcr.Repository
  - getDescriptorKeys
```
public String[] getDescriptorKeys()
```
    Delegated to the underlying repository instance.
    
    Specified by:
    
    getDescriptorKeys 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
  - getRepository
```
public org.apache.jackrabbit.api.JackrabbitRepository getRepository()
```
  - shutdown
```
public void shutdown()
```
    Delegated to the underlying repository instance.
    
    Specified by:
    
    shutdown in interface org.apache.jackrabbit.api.JackrabbitRepository
  - setApplicationContext
```
public void setApplicationContext(org.springframework.context.ApplicationContext applicationContext)
                           throws org.springframework.beans.BeansException
```
    Specified by:
    
    setApplicationContext in interface org.springframework.context.ApplicationContextAware
    
    Throws:
    
    org.springframework.beans.BeansException
  - setDataStoreGarbageCollectorBeanId
```
public void setDataStoreGarbageCollectorBeanId(String dataStoreGarbageCollectorBeanId)
```
  - setSettings
```
public void setSettings(SettingsBean settings)
```
  - setPerformMigrationToDataStoreIfNeeded
```
public void setPerformMigrationToDataStoreIfNeeded(boolean performMigrationToDataStoreIfNeeded)
```
  - getClusterNode
```
public org.apache.jackrabbit.core.cluster.ClusterNode getClusterNode()
```
    Jackrabbit cluster node instance or null if clustering is not activated.
    
    Returns:
    
    Jackrabbit cluster node instance or null if clustering is not activated
  - getClusterRevision
```
public long getClusterRevision()
```
    Returns current Jackrabbit cluster node revision or 0 if clustering is not activated.
    
    Returns:
    
    current Jackrabbit cluster node revision or 0 if clustering is not activated
  - syncClusterNode
```
public void syncClusterNode()
```
    Performs the sync on the Jackrabbit cluster node. If clustering is not activated this method does nothing. Possible exceptions during cluster sync are logged by not propagated upper by this method.
  - 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
  - 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
  - setTimeoutSwitchingToReadOnlyMode
```
public void setTimeoutSwitchingToReadOnlyMode(long timeoutSwitchingToReadOnlyMode)
```
    Set timeout waiting until switching to read only mode is possible.
    
    Parameters:
    
    timeoutSwitchingToReadOnlyMode - Timeout waiting until switching to read only mode is possible, ms.

Class SpringJackrabbitRepository

Field Summary

Fields inherited from interface org.apache.jackrabbit.api.JackrabbitRepository

Fields inherited from interface javax.jcr.Repository

Constructor Summary

Method Summary

Methods inherited from class org.apache.jackrabbit.commons.AbstractRepository

Methods inherited from class java.lang.Object

Methods inherited from interface org.apache.jackrabbit.api.JackrabbitRepository

Methods inherited from interface javax.jcr.Repository

Constructor Detail

SpringJackrabbitRepository

Method Detail

getInstance

getConfigFile

setConfigFile

getHomeDir

setHomeDir

getServletContextAttributeName

setServletContextAttributeName

setServletContext

createRepository

start

stop

login

getDescriptor

getDescriptorKeys

isSingleValueDescriptor

getDescriptorValue

getDescriptorValues

getRepository

shutdown

setApplicationContext

setDataStoreGarbageCollectorBeanId

setSettings

setPerformMigrationToDataStoreIfNeeded

getClusterNode

getClusterRevision

syncClusterNode

switchReadOnlyMode

getReadOnlyModePriority

setTimeoutSwitchingToReadOnlyMode