com.exalead.search.searchapi

Class Command

java.lang.Object

com.exalead.search.searchapi.Command

All Implemented Interfaces:

com.exalead.search.SearchEventListener

Direct Known Subclasses:

BaseFetchCommand, BaseSearchCommand, DictionaryCommand, GeoCommand, IsAliveCommand, SecurityCommand, SuggestCommand

public abstract class Command
extends java.lang.Object
implements com.exalead.search.SearchEventListener

Field Summary

Fields

Modifier and Type	Field and Description
protected SearchAPIDelegate	delegate
protected static org.apache.log4j.Logger	logger
static java.lang.ThreadLocal<com.exalead.search.searchapi.Command.CommandQueryState>	queryState
protected java.util.concurrent.atomic.AtomicInteger	runningQueries
protected java.util.concurrent.atomic.AtomicInteger	startingQueries

Constructor Summary

Constructors

Constructor and Description
Command()

Method Summary

Modifier and Type	Method and Description
abstract void	configure() Build the configuration
abstract void	execute(java.lang.String pathInfo, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse resp) Execute the command
void	onDeinit() When this is called, this command is not used anymore, and the lock has been released.
void	onPreReconfiguration() Called when this command is about to be removed following a SearchAPI reconfiguration.
void	onQueryDone() Tell the command that a query has completed
void	onQueryStarted() Tell the command that a query has successfully started.
void	onQueryStarting() Tell the command that a command will start.
void	onReconfigurationStarting() Called when this command is about to be removed following a SearchAPI reconfiguration.
protected static java.lang.String	removeJettyStuff(java.lang.String in)
protected static void	sendError(javax.servlet.http.HttpServletResponse resp, int httpCode, java.lang.String type, java.lang.String msg, java.lang.Throwable e)
void	setSearchAPIDelegate(SearchAPIDelegate delegate)
void	waitForStartingQueries() Called at the beginning of a dynamic reconfiguration cycle.

Methods inherited from class java.lang.Object

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

Field Detail

delegate

protected SearchAPIDelegate delegate

queryState

public static java.lang.ThreadLocal<com.exalead.search.searchapi.Command.CommandQueryState> queryState

startingQueries

protected java.util.concurrent.atomic.AtomicInteger startingQueries

runningQueries

protected java.util.concurrent.atomic.AtomicInteger runningQueries

logger

protected static org.apache.log4j.Logger logger

Constructor Detail

Command

public Command()

Method Detail

setSearchAPIDelegate

public void setSearchAPIDelegate(SearchAPIDelegate delegate)

onQueryStarting

public void onQueryStarting()

Tell the command that a command will start. This is called in the critical section by the delegate

Specified by:

onQueryStarting in interface com.exalead.search.SearchEventListener

onQueryStarted

public void onQueryStarted()

Tell the command that a query has successfully started.

Specified by:

onQueryStarted in interface com.exalead.search.SearchEventListener

onQueryDone

public void onQueryDone()

Tell the command that a query has completed

Specified by:

onQueryDone in interface com.exalead.search.SearchEventListener

waitForStartingQueries

public void waitForStartingQueries()

Called at the beginning of a dynamic reconfiguration cycle. This must wait for all queries that are currently "starting" to be "started". A query can be declared as started when it does not access search targets anymore.

execute

public abstract void execute(java.lang.String pathInfo,
                             javax.servlet.http.HttpServletRequest req,
                             javax.servlet.http.HttpServletResponse resp)
                      throws javax.servlet.ServletException,
                             java.io.IOException

Execute the command

Parameters:

pathInfo - The path relative to the command base

Throws:

javax.servlet.ServletException

java.io.IOException

configure

public abstract void configure()
                        throws java.lang.Exception

Build the configuration

Throws:

java.lang.Exception

onPreReconfiguration

public void onPreReconfiguration()
                          throws java.lang.Exception

Called when this command is about to be removed following a SearchAPI reconfiguration. When this is called, queries can still be coming on the command, the new commands are not yet build, and the lock has not yet been taken.

Throws:

java.lang.Exception

onReconfigurationStarting

public void onReconfigurationStarting()
                               throws java.lang.Exception

Called when this command is about to be removed following a SearchAPI reconfiguration. When this is called, no new query can arrive on the command, and the new commands are not yet built. This method should be as fast as possible, as it is called under lock.

Throws:

java.lang.Exception

onDeinit

public void onDeinit()
              throws java.lang.Exception

When this is called, this command is not used anymore, and the lock has been released.

Throws:

java.lang.Exception

removeJettyStuff

protected static java.lang.String removeJettyStuff(java.lang.String in)

sendError

protected static void sendError(javax.servlet.http.HttpServletResponse resp,
                                int httpCode,
                                java.lang.String type,
                                java.lang.String msg,
                                java.lang.Throwable e)
                         throws java.io.IOException

Throws:

java.io.IOException