public class SearchContext extends GenericService
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CLASS_VERSION
Class version string
|
SERVICE_INFO_KEY
DEFAULT_LOG_TRACE_STATUS
DEFAULT_LOG_DEBUG_STATUS, DEFAULT_LOG_ERROR_STATUS, DEFAULT_LOG_INFO_STATUS, DEFAULT_LOG_WARNING_STATUS
Constructor and Description |
---|
SearchContext() |
Modifier and Type | Method and Description |
---|---|
void |
clearSearchSessions() |
java.lang.String[] |
getFailoverConnections() |
int |
getMaxAttemptsBeforeFailover() |
java.lang.String |
getPrimaryConnection() |
SearchClient |
getSearchClient() |
atg.search.events.SearchMessageTools |
getSearchMessageService() |
atg.search.client.SearchSession |
getSearchSession(java.lang.String pRequestChainToken)
Get the search session used to track user in ATG Search.
|
boolean |
isFiringSearchEvents() |
boolean |
isUseSmallReportingResponse() |
void |
mapSearchSession(java.lang.String pRequestChainToken,
atg.search.client.SearchSession pSearchSession,
java.lang.String pPreviousRequestChainToken)
maps the request chain id to the search session, replacing any prior mapping of the session.
|
void |
reconnect() |
void |
setFailoverConnections(java.lang.String[] pFailoverConnections) |
void |
setFiringSearchEvents(boolean pFiringSearchEvents)
Controls whether reporting logging is enabled.
|
void |
setMaxAttemptsBeforeFailover(int pMaxAttemptsBeforeFailover) |
void |
setPrimaryConnection(java.lang.String pPrimaryConnection) |
void |
setSearchClient(SearchClient searchClient) |
void |
setSearchMessageService(atg.search.events.SearchMessageTools pSearchMessageService)
Set the search message service for reporting
|
void |
setSearchSession(atg.search.client.SearchSession pSearchSession)
Sets the search session and clears any mapped sessions, since the two
types of session data are incompatible
|
void |
setUseSmallReportingResponse(boolean pUseSmallReportingResponse) |
addLogListener, createAdminServlet, doStartService, doStopService, getAbsoluteName, getAdminServlet, getAdminServletOutputStreamEncoding, getLoggingForVlogging, getLogListenerCount, getLogListeners, getName, getNameContext, getNucleus, getRoot, getServiceConfiguration, getServiceInfo, isAdminServletUseServletOutputStream, isLoggingDebug, isLoggingError, isLoggingInfo, isLoggingTrace, isLoggingWarning, isRunning, logDebug, logDebug, logDebug, logError, logError, logError, logInfo, logInfo, logInfo, logTrace, logTrace, logTrace, logWarning, logWarning, logWarning, nameContextElementBound, nameContextElementUnbound, removeLogListener, reResolveThis, resolveName, resolveName, resolveName, resolveName, sendLogEvent, setAdminServletOutputStreamEncoding, setAdminServletUseServletOutputStream, setLoggingDebug, setLoggingError, setLoggingInfo, setLoggingTrace, setLoggingWarning, setNucleus, setServiceInfo, startService, stopService
vlogDebug, vlogDebug, vlogDebug, vlogDebug, vlogDebugTrace, vlogError, vlogError, vlogError, vlogError, vlogInfo, vlogInfo, vlogInfo, vlogInfo, vlogTrace, vlogTrace, vlogTrace, vlogTrace, vlogWarning, vlogWarning, vlogWarning, vlogWarning
public int getMaxAttemptsBeforeFailover()
public void setMaxAttemptsBeforeFailover(int pMaxAttemptsBeforeFailover)
public void reconnect() throws atg.search.client.SearchClientException
atg.search.client.SearchClientException
public SearchClient getSearchClient() throws atg.search.client.SearchClientException
atg.search.client.SearchClientException
- if it could not be initializedpublic void setSearchClient(SearchClient searchClient)
public atg.search.client.SearchSession getSearchSession(java.lang.String pRequestChainToken)
pRequestChainToken
- a request chain token, or null if there isn't one.public void setSearchSession(atg.search.client.SearchSession pSearchSession)
pSearchSession
- the Search sessionpublic void mapSearchSession(java.lang.String pRequestChainToken, atg.search.client.SearchSession pSearchSession, java.lang.String pPreviousRequestChainToken) throws atg.search.client.SearchClientException
pRequestChainToken
- request chain identifier from the responsepSearchSession
- the ATG Search sessionpPreviousRequestChainToken
- optional previous tokenatg.search.client.SearchClientException
- if the token is null or emptypublic boolean isFiringSearchEvents()
public void setFiringSearchEvents(boolean pFiringSearchEvents)
pFiringSearchEvents
- true if reporting logging should be enabledpublic boolean isUseSmallReportingResponse()
public void setUseSmallReportingResponse(boolean pUseSmallReportingResponse)
pUseSmallReportingResponse
- true to enable use of small response objects for reportingpublic atg.search.events.SearchMessageTools getSearchMessageService()
public void setSearchMessageService(atg.search.events.SearchMessageTools pSearchMessageService)
pSearchMessageService
- public java.lang.String getPrimaryConnection()
public void setPrimaryConnection(java.lang.String pPrimaryConnection)
public java.lang.String[] getFailoverConnections()
public void setFailoverConnections(java.lang.String[] pFailoverConnections)
public void clearSearchSessions()