org.gbif.registry.search.guice

Class RegistrySearchModule

java.lang.Object

com.google.inject.PrivateModule

org.gbif.service.guice.PrivateServiceModule

org.gbif.registry.search.guice.RegistrySearchModule

All Implemented Interfaces:

com.google.inject.Module

public class RegistrySearchModule
extends org.gbif.service.guice.PrivateServiceModule

A guice module that sets up implementation of the search services and gives SOLR providers for search.

The current implementation uses an embedded SOLR index, that uses a SOLR RAM directory. This is satisfactory while indexes remain small, and while we opt to rebuild the index on startup. Future implementations might consider using an external SOLR server, thus this method signatures use abstract SOLR type, and not a concrete implementation to allow for future changes.

A note on the gbif-common-search SolrModule org.gbif.common.search.inject.SolrModule:

The org.gbif.common.search.inject.SolrModule was considered for use here, but discarded because in its current implementation:

• The org.gbif.common.search.solr.builders.EmbeddedServerBuilder does not support multiple cores, but that is anticipated as a future requirement for this project
• The org.gbif.common.search.solr.builders.EmbeddedServerBuilder does not allow someone to supply additional configuration files (it was developed for unit test purposes only)
• The SOLR server desired requires only 3 lines of code to instantiate. The implementor felt that readability is improved keeping this together
• org.gbif.common.search.inject.SolrModule is complex as it provides configuration based declaration (e.g. to support varying deployments. The implementor felt that was an additional learning curve that is unnecessary to put on future developers of this project. That said, should this project require flexible deployment options in the future, developers would be wise to consider adding multi-core support to the org.gbif.common.search.inject.SolrModule

Constructor Summary

Constructors

Constructor and Description
RegistrySearchModule(Properties properties)

Method Summary

Modifier and Type	Method and Description
void	configureService()
org.apache.solr.client.solrj.SolrClient	datasetSolr(String solrHome) A provider of the SolrServer to use with a dataset search.

Methods inherited from class com.google.inject.PrivateModule

configure

Methods inherited from class java.lang.Object

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

Constructor Detail

RegistrySearchModule

public RegistrySearchModule(Properties properties)

Method Detail

configureService

public void configureService()

Specified by:

configureService in class org.gbif.service.guice.PrivateServiceModule

datasetSolr

@Provides
 @Exposed
public org.apache.solr.client.solrj.SolrClient datasetSolr(String solrHome)
                                                                        throws URISyntaxException,
                                                                               IOException

A provider of the SolrServer to use with a dataset search. Named as such, to allow multiple providers (e.g. solr cores) should this be required in the future.

Returns:

An embedded solr server that uses the configuration in /solr on the classpath

Throws:

URISyntaxException - If /solr configuration is not found on the classpath

IOException