Configuration
The virtual file system used by the search index.
<FileSystem class="org.apache.jackrabbit.core.fs.local.LocalFileSystem">
<param name="path" value="${rep.home}/repository" />
</FileSystem>
Jackrabbit provides a lot of choices for how you can configure the FileSystem. Choose the class (local, db, or in-mem) that best fits your use case.
See: http://jackrabbit.apache.org/jcr/jackrabbit-configuration.html#file-system-configuration and Jackrabbit Repository Configuration File#FileSystem.1
The persistence manager configuration for the search index.
<PersistenceManager class="org.apache.jackrabbit.core.persistence.pool.DerbyPersistenceManager">
<param name="url" value="jdbc:derby:${wsp.home}/db;create=true"/>
<param name="schemaObjectPrefix" value="${wsp.name}_"/>
</PersistenceManager>
Jackrabbit provides a lot of choices for how you can configure the PersistenceManager. Choose the class (pool or in-mem) that best fits your use case.
See: https://wiki.apache.org/jackrabbit/PersistenceManagerFAQ and Jackrabbit Repository Configuration File#PersistenceManager
Node names and property values are indexed as soon as the data is saved or as soon as the transaction is committed.
Text extraction is done asynchronously in a in a background thread. That means changed or added text is not available immediately, but after a short delay. The exact behaviour can be configured using the extractor* settings.
Index Location
path: The location of the index directory. This parameter is mandatory. A reasonable value is: ${wsp.home}/indexing_configuration.xml
Jackrabbit provides the following options in the class SearchIndex
indexingConfiguration | optional, default is /info/magnolia/jackrabbit/indexing_configuration_${wsp.name}.xml The default indexing configuration file is located in the core module. You have the option to create a workspace specific file with this setting. See Search Index Configuration File. The configuration parameter |
indexingConfigurationClass | optional The name of the class that implements |
analyzer | optional Sets the default analyzer in use for indexing. The default value is the |
directoryManager | optional The name of the class that implements |
useSimpleFSDirectory | optional Indicates whether the |
useCompoundFile | optional All files belonging to a segment have the same name with varying extensions. When using the Compound File format these files are collapsed into a single |
minMergeDocs | optional This setting no longer exists in Lucene 3.x. |
volatileIdleTime | optional The Lucene indexer does not write changes to the permanent index immediately. At first, indexer writes the changes to a volatile index. Once the volatile index reaches a certain size it is persisted to the permanent index. Also there is the option to set a timer, in seconds, to control how often changes are written. |
maxMergeDocs | optional While merging segments, Lucene will ensure that no segment with more than maxMergeDocs is created. |
mergeFactor | optional This value tells Lucene how many documents to store in memory before writing them to the disk, as well as how often to merge multiple segments together. With the default value of 10, Lucene will store 10 documents in memory before writing them to a single segment on the disk. |
maxFieldLength | optional Deprecated in Lucene 3.x. |
bufferSize | optional Maximum number of documents that are held in a pending queue until added to the index. |
cacheSize | optional Size of the document number cache. This cache maps UUIDs to lucene document numbers. If the doc number cache hits are poor then increasing this number could help. |
maxVolatileIndexSize | optional The maximum volatile index size in bytes until it is written to disk. The default value is 1MB. |
maxHistoryAge | optional The maximum age (in seconds) of the index history. The default value is 0. Which means, index commits are deleted as soon as they are not used anymore. |
initializeHierarchyCache | optional With the default value of |
See https://wiki.apache.org/lucene-java/ImproveIndexingSpeed
forceConsistencyCheck | optional Runs a consistency check on every startup. If false, a consistency check is only performed when the search index detects a prior forced shutdown. When a consistency check is performed it can delay the start of the system. So this should only be run when a search index inconsistency is suspected. For example, a node not found error. A UUID exists in the search index but the corresponding node is not found. On the other hand, a node exists but is not recorded in the index. In both cases the index is inconsistent with the data. |
autoRepair | optional Errors detected by a consistency check are automatically repaired. If false, errors are only written to the log. |
enableConsistencyCheck | optional If set |
redoLogFactoryClass | optional The name of the class that implements |
See https://documentation.magnolia-cms.com/display/DOCS/Repository+inconsistency
queryClass | optional, default is org.apache.jackrabbit.core.query.QueryImpl Class used to perform JCR Queries. |
respectDocumentOrder | optional If true and the query does not contain an 'order by' clause, result nodes will be in document order (the order in which the were indexed by the system). |
resultFetchSize | optional The number of results the query handler should initially fetch when a query is executed. Keep in mind that ACL checks must be performed on the result set. The larger the set the more time to load and check. |
termInfosIndexDivisor | optional An |
See https://wiki.apache.org/lucene-java/ImproveSearchingSpeed
extractorPoolSize | optional Defines the maximum number of background threads that are used to extract text from binary properties. If set to 0, then no background threads are allocated and text extractors run in the current thread. If you are using JR ver. 1.5 or better, then twice the number of available processors. |
extractorTimeout | optional A text extractor is executed using a background thread if it doesn't finish within this timeout defined in milliseconds. This parameter has no effect if |
extractorBackLogSize | optional The size of the extractor pool back log. If all threads in the pool are busy, incoming work is put into a wait queue. If the wait queue reaches the back log size, incoming extractor work will not be queued anymore but will be executed with the current thread. |
maxExtractLength | optional Positive values are used as-is, negative values are interpreted as factors of the |
forkJavaCommand | optional Java command used to fork external parser processes or null (the default) for in-process text extraction. Use this to better control system stability and reliability by forcing indexing of binary documents into separate JVM processes. Any problems caused by parsing large or malformed documents won't affect the main process. example values Linux: |
supportHighlighting | optional If set to |
excerptProviderClass | optional The name of the class that implements |
textFilterClasses | optional Deprecated in Jackrabbit 2.x. With Jackrabbit 2.x Apache Tika was introduced as the default binaries parser. By default Jackrabbit comes with a default |
tikaConfigPath | optional Set the location of the |
This allows users to use generalized language-dependent synonyms but more importantly very domain-specific synonyms like abbreviations or product names.
synonymProviderClass | optional The name of a class that implements |
synonymProviderConfigPath | optional The path to the synonym provider configuration file. This path interpreted relative to the |
spellCheckerClass | optional The name of a class that implements |
similarityClass | optional The name of a class that extends |
Workspace security is handled by the MagnoliaAccessProvider. See Jackrabbit Repository Configuration File#WorkspaceSecurity.
<WorkspaceSecurity> <AccessControlProvider class="info.magnolia.cms.core.MagnoliaAccessProvider" /> </WorkspaceSecurity>