de.hybris.platform.solrserver

Interface SolrServerService

All Known Implementing Classes:

DefaultSolrServerService

public interface SolrServerService

This represents the main entry point for all operations regarding Solr instances and servers.

Method Summary

Modifier and Type	Method and Description
SolrInstance	getInstanceForName(java.lang.String instanceName) Returns the configured Solr instance for a given name.
java.util.Map<java.lang.String,SolrInstance>	getInstances() Returns all configured Solr instances.
void	startServer(SolrInstance solrInstance) Starts the Solr server for a given instance.
void	startServers() Starts all Solr servers that are configured to be automatically started/stopped.
void	stopServer(SolrInstance solrInstance) Stops the Solr server for a given instance.
void	stopServers() Stops all Solr servers that are configured to be automatically started/stopped.

Method Detail

getInstances

java.util.Map<java.lang.String,SolrInstance> getInstances()

Returns all configured Solr instances. The key of the map is the name of the instance.

Returns:

the configured Solr instances

getInstanceForName

SolrInstance getInstanceForName(java.lang.String instanceName)
                         throws SolrInstanceNotFoundException

Returns the configured Solr instance for a given name.

Parameters:

instanceName - - the instance name

Returns:

the configured Solr instance

Throws:

SolrInstanceNotFoundException - if an instance is not found for the given name

startServer

void startServer(SolrInstance solrInstance)
          throws SolrServerException

Starts the Solr server for a given instance.

Parameters:

solrInstance - - the Solr instance

Throws:

SolrServerException - if an error occurs while starting the server.

stopServer

void stopServer(SolrInstance solrInstance)
         throws SolrServerException

Stops the Solr server for a given instance.

Parameters:

solrInstance - - the Solr instance

Throws:

SolrServerException - if an error occurs while stopping the server.

startServers

void startServers()
           throws SolrServerException

Starts all Solr servers that are configured to be automatically started/stopped.

Throws:

SolrServerException - if an error occurs while starting the servers, depending on configuration the errors might be ignored and the exception not thrown

See Also:

SolrInstance.isAutostart()

stopServers

void stopServers()
          throws SolrServerException

Stops all Solr servers that are configured to be automatically started/stopped.

Throws:

SolrServerException - if an error occurs while stopping the servers, depending on configuration the errors might be ignored and the exception not thrown

See Also:

SolrInstance.isAutostart()