de.hybris.platform.solrserver.impl

Class AbstractSolrServerController

java.lang.Object

de.hybris.platform.solrserver.impl.AbstractSolrServerController

All Implemented Interfaces:

SolrServerController

Direct Known Subclasses:

AbstractSolrServerControllerTest.AbstractSolrServerControllerSpy, UnixSolrServerController, WindowsSolrServerController

public abstract class AbstractSolrServerController
extends java.lang.Object
implements SolrServerController

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	AbstractSolrServerController.CommandResult
protected static class	AbstractSolrServerController.ServerStatus
protected static interface	AbstractSolrServerController.ServerStatusFunction
protected static class	AbstractSolrServerController.ServerStatusOutput

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CONFIGSETS_PATH
static java.lang.String	CORES_PATH
static java.lang.String	FORCE_RESTART
static boolean	FORCE_RESTART_DEFAULT_VALUE
static java.lang.String	JSON_REGEX
static java.lang.String	MAX_STATUS_RETRIES
static int	MAX_STATUS_RETRIES_DEFAULT_VALUE
static java.lang.String	RUNNING_CHECK_REGEX
static java.lang.String	SOLR_START_COMMAND
static java.lang.String	SOLR_STATUS_COMMAND
static java.lang.String	SOLR_STOP_COMMAND
static java.lang.String	STATUS_INTERVAL
static long	STATUS_INTERVAL_DEFAULT_VALUE
static java.lang.String	TIMEOUT
static long	TIMEOUT_DEFAULT_VALUE
static java.lang.String	ZK_COLLECTION_PARAM
static java.lang.String	ZK_CONFDIR_PARAM
static java.lang.String	ZK_CONFNAME_PARAM
static java.lang.String	ZK_DATA_PATH
static java.lang.String	ZK_NAME_PARAM
static java.lang.String	ZK_RUNZK_PARAM
static java.lang.String	ZK_SOLRHOME_PARAM
static java.lang.String	ZK_UPLOAD_CONFIG_COMMAND
static java.lang.String	ZK_VAL_PARAM

Constructor Summary

Constructors

Constructor and Description
AbstractSolrServerController()

Method Summary

Modifier and Type	Method and Description
protected AbstractSolrServerController.CommandResult	callSolrCommand(SolrInstance solrInstance, java.lang.String command, boolean logOutput)
protected AbstractSolrServerController.CommandResult	callZKClientCommand(SolrInstance solrInstance, java.lang.String command, java.util.Map<java.lang.String,java.lang.String> parameters, boolean logOutput)
protected java.util.Map<java.lang.Integer,AbstractSolrServerController.ServerStatusOutput>	collectServerStatusOutput(java.lang.String commandOutput)
protected abstract void	configureSolrCommandInvocation(SolrInstance solrInstance, java.lang.ProcessBuilder processBuilder, java.lang.String command)
protected void	configureSolrCommandParams(SolrInstance solrInstance, java.lang.ProcessBuilder processBuilder)
protected abstract void	configureZKCommandInvocation(SolrInstance solrInstance, java.lang.ProcessBuilder processBuilder, java.lang.String command)
protected void	configureZKCommandParams(java.lang.ProcessBuilder processBuilder, java.util.Map<java.lang.String,java.lang.String> zkParameters)
protected void	ensureToStartSolr(SolrInstance solrInstance)
protected void	ensureToStopSolr(SolrInstance solrInstance)
protected int	getMaxStatusRetries()
protected AbstractSolrServerController.ServerStatus	getSolrServerStatus(SolrInstance solrInstance)
protected long	getStatusInterval()
protected long	getTimeout()
protected boolean	isCorrespondingServerForInstance(SolrInstance solrInstance, AbstractSolrServerController.ServerStatus serverStatus)
protected boolean	isForceRestart()
protected java.lang.String	resolveZkHost(SolrInstance solrInstance)
protected AbstractSolrServerController.ServerStatus	retryGetStatusUntilConditionIsTrue(SolrInstance solrInstance, AbstractSolrServerController.ServerStatusFunction condition, java.lang.String retryMessage, java.lang.String errorMessage)
void	start(SolrInstance solrInstance) Starts the Solr server for a given instance.
void	stop(SolrInstance solrInstance) Stops the Solr server for a given instance.
protected void	uploadConfigurationToZK(SolrInstance solrInstance)

Methods inherited from class java.lang.Object

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

Field Detail

RUNNING_CHECK_REGEX

public static final java.lang.String RUNNING_CHECK_REGEX

See Also:

Constant Field Values

JSON_REGEX

public static final java.lang.String JSON_REGEX

See Also:

Constant Field Values

SOLR_STATUS_COMMAND

public static final java.lang.String SOLR_STATUS_COMMAND

See Also:

Constant Field Values

SOLR_START_COMMAND

public static final java.lang.String SOLR_START_COMMAND

See Also:

Constant Field Values

SOLR_STOP_COMMAND

public static final java.lang.String SOLR_STOP_COMMAND

See Also:

Constant Field Values

ZK_UPLOAD_CONFIG_COMMAND

public static final java.lang.String ZK_UPLOAD_CONFIG_COMMAND

See Also:

Constant Field Values

ZK_COLLECTION_PARAM

public static final java.lang.String ZK_COLLECTION_PARAM

See Also:

Constant Field Values

ZK_VAL_PARAM

public static final java.lang.String ZK_VAL_PARAM

See Also:

Constant Field Values

ZK_NAME_PARAM

public static final java.lang.String ZK_NAME_PARAM

See Also:

Constant Field Values

ZK_SOLRHOME_PARAM

public static final java.lang.String ZK_SOLRHOME_PARAM

See Also:

Constant Field Values

ZK_RUNZK_PARAM

public static final java.lang.String ZK_RUNZK_PARAM

See Also:

Constant Field Values

ZK_CONFNAME_PARAM

public static final java.lang.String ZK_CONFNAME_PARAM

See Also:

Constant Field Values

ZK_CONFDIR_PARAM

public static final java.lang.String ZK_CONFDIR_PARAM

See Also:

Constant Field Values

FORCE_RESTART

public static final java.lang.String FORCE_RESTART

See Also:

Constant Field Values

FORCE_RESTART_DEFAULT_VALUE

public static final boolean FORCE_RESTART_DEFAULT_VALUE

See Also:

Constant Field Values

TIMEOUT

public static final java.lang.String TIMEOUT

See Also:

Constant Field Values

TIMEOUT_DEFAULT_VALUE

public static final long TIMEOUT_DEFAULT_VALUE

See Also:

Constant Field Values

MAX_STATUS_RETRIES

public static final java.lang.String MAX_STATUS_RETRIES

See Also:

Constant Field Values

MAX_STATUS_RETRIES_DEFAULT_VALUE

public static final int MAX_STATUS_RETRIES_DEFAULT_VALUE

See Also:

Constant Field Values

STATUS_INTERVAL

public static final java.lang.String STATUS_INTERVAL

See Also:

Constant Field Values

STATUS_INTERVAL_DEFAULT_VALUE

public static final long STATUS_INTERVAL_DEFAULT_VALUE

See Also:

Constant Field Values

CONFIGSETS_PATH

public static final java.lang.String CONFIGSETS_PATH

See Also:

Constant Field Values

CORES_PATH

public static final java.lang.String CORES_PATH

See Also:

Constant Field Values

ZK_DATA_PATH

public static final java.lang.String ZK_DATA_PATH

See Also:

Constant Field Values

Constructor Detail

AbstractSolrServerController

public AbstractSolrServerController()

Method Detail

start

public void start(SolrInstance solrInstance)
           throws SolrServerException

Description copied from interface: SolrServerController

Starts the Solr server for a given instance.

Specified by:

start in interface SolrServerController

Parameters:

solrInstance - - the Solr instance

Throws:

SolrServerException - - if an error occurs while starting the Solr server

ensureToStartSolr

protected void ensureToStartSolr(SolrInstance solrInstance)
                          throws SolrServerException,
                                 java.lang.InterruptedException

Throws:

SolrServerException

java.lang.InterruptedException

uploadConfigurationToZK

protected void uploadConfigurationToZK(SolrInstance solrInstance)
                                throws SolrServerException,
                                       java.lang.InterruptedException

Throws:

SolrServerException

java.lang.InterruptedException

stop

public void stop(SolrInstance solrInstance)
          throws SolrServerException

Description copied from interface: SolrServerController

Stops the Solr server for a given instance.

Specified by:

stop in interface SolrServerController

Parameters:

solrInstance - - the Solr instance

Throws:

SolrServerException - - if an error occurs while stopping the Solr server

ensureToStopSolr

protected void ensureToStopSolr(SolrInstance solrInstance)
                         throws SolrServerException,
                                java.lang.InterruptedException

Throws:

SolrServerException

java.lang.InterruptedException

callSolrCommand

protected AbstractSolrServerController.CommandResult callSolrCommand(SolrInstance solrInstance,
                                                                     java.lang.String command,
                                                                     boolean logOutput)
                                                              throws SolrServerException,
                                                                     java.lang.InterruptedException

Throws:

SolrServerException

java.lang.InterruptedException

callZKClientCommand

protected AbstractSolrServerController.CommandResult callZKClientCommand(SolrInstance solrInstance,
                                                                         java.lang.String command,
                                                                         java.util.Map<java.lang.String,java.lang.String> parameters,
                                                                         boolean logOutput)
                                                                  throws SolrServerException,
                                                                         java.lang.InterruptedException

Throws:

SolrServerException

java.lang.InterruptedException

configureSolrCommandInvocation

protected abstract void configureSolrCommandInvocation(SolrInstance solrInstance,
                                                       java.lang.ProcessBuilder processBuilder,
                                                       java.lang.String command)

configureZKCommandInvocation

protected abstract void configureZKCommandInvocation(SolrInstance solrInstance,
                                                     java.lang.ProcessBuilder processBuilder,
                                                     java.lang.String command)

configureSolrCommandParams

protected void configureSolrCommandParams(SolrInstance solrInstance,
                                          java.lang.ProcessBuilder processBuilder)

configureZKCommandParams

protected void configureZKCommandParams(java.lang.ProcessBuilder processBuilder,
                                        java.util.Map<java.lang.String,java.lang.String> zkParameters)

resolveZkHost

protected java.lang.String resolveZkHost(SolrInstance solrInstance)

getSolrServerStatus

protected AbstractSolrServerController.ServerStatus getSolrServerStatus(SolrInstance solrInstance)
                                                                 throws SolrServerException,
                                                                        java.lang.InterruptedException

Throws:

SolrServerException

java.lang.InterruptedException

collectServerStatusOutput

protected java.util.Map<java.lang.Integer,AbstractSolrServerController.ServerStatusOutput> collectServerStatusOutput(java.lang.String commandOutput)

retryGetStatusUntilConditionIsTrue

protected AbstractSolrServerController.ServerStatus retryGetStatusUntilConditionIsTrue(SolrInstance solrInstance,
                                                                                       AbstractSolrServerController.ServerStatusFunction condition,
                                                                                       java.lang.String retryMessage,
                                                                                       java.lang.String errorMessage)
                                                                                throws SolrServerException,
                                                                                       java.lang.InterruptedException

Throws:

SolrServerException

java.lang.InterruptedException

isCorrespondingServerForInstance

protected boolean isCorrespondingServerForInstance(SolrInstance solrInstance,
                                                   AbstractSolrServerController.ServerStatus serverStatus)
                                            throws SolrServerException

Throws:

SolrServerException

isForceRestart

protected boolean isForceRestart()

getMaxStatusRetries

protected int getMaxStatusRetries()

getTimeout

protected long getTimeout()

getStatusInterval

protected long getStatusInterval()