Classes

Class	Line #	Total Statements	% Filtered	Complexity	Uncovered Elements	TOTAL Coverage	Actions
SolrConfiguration	33	0	-	0	0	-1.0 -	Show methods

Class SolrConfiguration

Class SolrConfiguration	Line # 33	Total Statements 0	% Filtered -	Complexity 0	Uncovered Elements 0	TOTAL Coverage -1.0 -

 

Contributing tests

Source view

1		/*
2		* See the NOTICE file distributed with this work for additional
3		* information regarding copyright ownership.
4		*
5		* This is free software; you can redistribute it and/or modify it
6		* under the terms of the GNU Lesser General Public License as
7		* published by the Free Software Foundation; either version 2.1 of
8		* the License, or (at your option) any later version.
9		*
10		* This software is distributed in the hope that it will be useful,
11		* but WITHOUT ANY WARRANTY; without even the implied warranty of
12		* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13		* Lesser General Public License for more details.
14		*
15		* You should have received a copy of the GNU Lesser General Public
16		* License along with this software; if not, write to the Free
17		* Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
18		* 02110-1301 USA, or see the FSF site: http://www.fsf.org.
19		*/
20		package org.xwiki.search.solr.internal.api;
21
22		import java.io.InputStream;
23
24		import org.xwiki.component.annotation.Role;
25
26		/**
27		* Provides configuration for Solr.
28		*
29		* @version $Id: c73db125e018182275643e9acbc5bf825abcc8d8 $
30		* @since 4.5M1
31		*/
32		@Role
		- Uncovered Elements: 0 (0) Complexity: 0 Complexity Density: -
33		public interface SolrConfiguration
34		{
35		/**
36		* @return the type of Solr server used. Supported values: "embedded" or "remote".
37		*/
38		String getServerType();
39
40		/**
41		* @param instanceType the instance type value for which configuration is requested.
42		* @param propertyName the name of the configuration property that is requested.
43		* @param defaultValue the default value to return if the requested value is not set.
44		* @return the instance specific configuration value.
45		* @param <T> the type of the default parameter.
46		*/
47		<T> T getInstanceConfiguration(String instanceType, String propertyName, T defaultValue);
48
49		/**
50		* Retrieves the configuration files required by the Solr instance's home directory in order to initialize.
51		*
52		* @return a map of (fileName, fileURL) to be used to initialize the Solr instance.
53		*/
54		InputStream getHomeDirectoryConfiguration();
55
56		// Indexer
57
58		/**
59		* @return the size of the batch when indexing enqueued entities
60		* @since 5.1M2
61		*/
62		int getIndexerBatchSize();
63
64		/**
65		* @return the size of the batch when indexing enqueued entities
66		* @since 5.1M2
67		*/
68		int getIndexerBatchMaxLengh();
69
70		/**
71		* @return the maximum size of the indexer queue
72		* @since 5.1M2
73		*/
74		int getIndexerQueueCapacity();
75
76		/**
77		* @return true if a full synchronization job between the database and SOLR index should be run when XWiki starts
78		* @since 6.1M2
79		*/
80		boolean synchronizeAtStartup();
81		}