|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object atg.nucleus.logging.VariableArgumentApplicationLoggingImpl atg.nucleus.GenericService atg.search.formhandlers.SearchContext
public class SearchContext
This component provides a place to store session data for use by search form handlers.
Field Summary | |
---|---|
static java.lang.String |
CLASS_VERSION
Class version string |
Fields inherited from class atg.nucleus.GenericService |
---|
SERVICE_INFO_KEY |
Fields inherited from interface atg.nucleus.logging.TraceApplicationLogging |
---|
DEFAULT_LOG_TRACE_STATUS |
Fields inherited from interface atg.nucleus.logging.ApplicationLogging |
---|
DEFAULT_LOG_DEBUG_STATUS, DEFAULT_LOG_ERROR_STATUS, DEFAULT_LOG_INFO_STATUS, DEFAULT_LOG_WARNING_STATUS |
Constructor Summary | |
---|---|
SearchContext()
|
Method Summary | |
---|---|
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()
|
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 |
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 |
Methods inherited from class atg.nucleus.logging.VariableArgumentApplicationLoggingImpl |
---|
vlogDebug, vlogDebug, vlogDebug, vlogDebug, vlogError, vlogError, vlogError, vlogError, vlogInfo, vlogInfo, vlogInfo, vlogInfo, vlogTrace, vlogTrace, vlogTrace, vlogTrace, vlogWarning, vlogWarning, vlogWarning, vlogWarning |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static java.lang.String CLASS_VERSION
Constructor Detail |
---|
public SearchContext()
Method Detail |
---|
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 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 token
atg.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 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()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |