org.apache.jackrabbit.oak.plugins.index.solr.util

Class OakSolrUtils

java.lang.Object

org.apache.jackrabbit.oak.plugins.index.solr.util.OakSolrUtils

public class OakSolrUtils
extends Object

Utilities for Oak Solr integration.

Constructor Summary

Constructors

Constructor and Description
OakSolrUtils()

Method Summary

Methods

Modifier and Type	Method and Description
static <T extends OakSolrConfigurationProvider> OakSolrConfigurationProvider	adaptOsgiOakSolrConfigurationProvider(Class<T> providerClass) adapt the OSGi Solr OakSolrConfigurationProvider service of a given extending class and tries to instantiate it if non existing.
static org.apache.jackrabbit.oak.spi.query.QueryIndexProvider	adaptOsgiQueryIndexProvider() adapts the OSGi Solr QueryIndexProvider service
static <T extends SolrServerProvider> SolrServerProvider	adaptOsgiSolrServerProvider(Class<T> providerClass) adapt the OSGi Solr SolrServerProvider service of a given extending class and tries to instantiate it if non existing.
static boolean	checkServerAlive(org.apache.solr.client.solrj.SolrServer solrServer) Check if a given Solr instance is alive
static void	commitByPolicy(org.apache.solr.client.solrj.SolrServer solrServer, CommitPolicy commitPolicy) Trigger a Solr commit on the basis of the given commit policy (e.g.
static <T extends OakSolrConfigurationProvider> OakSolrConfigurationProvider	getOakSolrConfigurationProvider(Class<T> providerClass)
static <T extends SolrServerProvider> SolrServerProvider	getSolrServerProvider(Class<T> providerClass)

Methods inherited from class java.lang.Object

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

Constructor Detail

OakSolrUtils

public OakSolrUtils()

Method Detail

checkServerAlive

public static boolean checkServerAlive(@Nonnull
                       org.apache.solr.client.solrj.SolrServer solrServer)
                                throws IOException,
                                       org.apache.solr.client.solrj.SolrServerException

Check if a given Solr instance is alive

Parameters:

solrServer - the SolrServer used to communicate with the Solr instance

Returns:

true if the given Solr instance is alive and responding

Throws:

IOException - if any low level IO error occurs

org.apache.solr.client.solrj.SolrServerException - if any error occurs while trying to communicate with the Solr instance

adaptOsgiQueryIndexProvider

public static org.apache.jackrabbit.oak.spi.query.QueryIndexProvider adaptOsgiQueryIndexProvider()

adapts the OSGi Solr QueryIndexProvider service

Returns:

a SolrQueryIndexProvider

adaptOsgiSolrServerProvider

public static <T extends SolrServerProvider> SolrServerProvider adaptOsgiSolrServerProvider(Class<T> providerClass)

adapt the OSGi Solr SolrServerProvider service of a given extending class and tries to instantiate it if non existing.

Type Parameters:

T - the SolrServerProvider extension

Parameters:

providerClass - the Class extending SolrServerProvider to adapt or instantiate

Returns:

a SolrServerProvider adapted from the OSGi service, or a directly instantiated one or null if both failed

getSolrServerProvider

public static <T extends SolrServerProvider> SolrServerProvider getSolrServerProvider(Class<T> providerClass)

adaptOsgiOakSolrConfigurationProvider

public static <T extends OakSolrConfigurationProvider> OakSolrConfigurationProvider adaptOsgiOakSolrConfigurationProvider(Class<T> providerClass)

adapt the OSGi Solr OakSolrConfigurationProvider service of a given extending class and tries to instantiate it if non existing.

Type Parameters:

T - the OakSolrConfigurationProvider extension

Parameters:

providerClass - the Class extending OakSolrConfigurationProvider to adapt or instantiate

Returns:

a OakSolrConfigurationProvider adapted from the OSGi service, or a directly instantiated one or null if both failed

getOakSolrConfigurationProvider

public static <T extends OakSolrConfigurationProvider> OakSolrConfigurationProvider getOakSolrConfigurationProvider(Class<T> providerClass)

commitByPolicy

public static void commitByPolicy(org.apache.solr.client.solrj.SolrServer solrServer,
                  CommitPolicy commitPolicy)
                           throws IOException,
                                  org.apache.solr.client.solrj.SolrServerException

Trigger a Solr commit on the basis of the given commit policy (e.g. hard, soft, auto)

Parameters:

solrServer - the SolrServer used to communicate with the Solr instance

commitPolicy - the CommitPolicy used to commit changes to a Solr index

Throws:

IOException - if any low level IO error occurs

org.apache.solr.client.solrj.SolrServerException - if any error occurs while trying to communicate with the Solr instance