|
|||||||||
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.routing.RoutingSearchService
public class RoutingSearchService
Processes all search requests.
Field Summary | |
---|---|
static java.lang.String |
APP_SERVER_TYPE
|
static java.lang.String |
CLASS_VERSION
|
static java.lang.String |
ID_SPACE
|
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 | |
---|---|
RoutingSearchService()
|
Method Summary | |
---|---|
atg.search.client.SearchSession |
beginSession()
|
java.lang.String |
beginSession(SessionConfig pSessionConfig)
Start a search session. |
void |
doStartService()
This is called after a Service has been created, placed into the naming hierarchy, and initialized with its configured property values. |
void |
endSession(java.lang.String pSessionXml)
This method doesn't do anything. |
protected MergeRequest |
generateMergeRequest(ClientRequest request,
java.util.List engineResponses)
Generates merge request |
protected MergeRequest |
generateMergeRequest2(SearchRequest request,
java.util.List engineResponses)
Generates merge request |
java.lang.String |
getAppServerType()
Return the app server type. |
atg.service.cache.persistent.CacheService |
getCacheService()
|
int |
getDefaultMergeBufferSize()
|
long |
getMaxUncachedRequestDurationMs()
The maximum amount of time, in milliseconds, that a search request can take before it will be cached. |
atg.adapter.gsa.GSARepository |
getRepository()
|
RoutingSystemService |
getRoutingSystemService()
|
SearchEngine |
getRunningSearchEngineForPartition(SearchEnvironment env,
PhysicalPartition part)
|
java.util.Collection |
getSearchEnvironmentTargets()
|
SearchStrategy |
getSearchStrategyService()
|
SearchStrategy.StrategyType |
getStrategyType()
|
boolean |
isKeepingResponseXml()
|
Results |
search(ClientRequest request,
java.lang.String envName)
Submits the request to the specified search environment. |
QueryRequest.Response |
search(QueryRequest request)
Entrypoint for query request. |
void |
setCacheService(atg.service.cache.persistent.CacheService pCacheService)
|
void |
setDefaultMergeBufferSize(int defaultMergeBufferSize)
|
void |
setKeepingResponseXml(boolean pKeepingResponseXml)
|
void |
setMaxUncachedRequestDurationMs(long pDuration)
The maximum amount of time, in milliseconds, that a search request can take before it will be cached. |
void |
setRepository(atg.adapter.gsa.GSARepository repository)
|
void |
setRoutingSystemService(RoutingSystemService routingSystemService)
|
void |
setSearchStrategyService(SearchStrategy pSearchStrategy)
|
void |
setStrategyType(SearchStrategy.StrategyType pStrategyType)
|
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 final java.lang.String APP_SERVER_TYPE
public static final java.lang.String CLASS_VERSION
public static final java.lang.String ID_SPACE
Constructor Detail |
---|
public RoutingSearchService()
Method Detail |
---|
public atg.adapter.gsa.GSARepository getRepository()
public void setRepository(atg.adapter.gsa.GSARepository repository)
public int getDefaultMergeBufferSize()
public void setDefaultMergeBufferSize(int defaultMergeBufferSize)
public SearchStrategy getSearchStrategyService()
public void setSearchStrategyService(SearchStrategy pSearchStrategy)
public boolean isKeepingResponseXml()
public void setKeepingResponseXml(boolean pKeepingResponseXml)
public SearchStrategy.StrategyType getStrategyType()
public void setStrategyType(SearchStrategy.StrategyType pStrategyType)
public RoutingSystemService getRoutingSystemService()
public void setRoutingSystemService(RoutingSystemService routingSystemService)
public void setCacheService(atg.service.cache.persistent.CacheService pCacheService)
public atg.service.cache.persistent.CacheService getCacheService()
public void setMaxUncachedRequestDurationMs(long pDuration)
pDuration
- the maximum request time for non-cached queries
or zero to disable this feature.public long getMaxUncachedRequestDurationMs()
public void doStartService() throws ServiceException
GenericService
doStartService
in class GenericService
ServiceException
- if the Service had a problem starting uppublic java.lang.String beginSession(SessionConfig pSessionConfig) throws RoutingException
pSessionConfig
- the session configuration
RoutingException
public void endSession(java.lang.String pSessionXml) throws RoutingException
pSessionXml
- ignored
RoutingException
public atg.search.client.SearchSession beginSession() throws SearchClientException
SearchClientException
public java.lang.String getAppServerType()
public SearchEngine getRunningSearchEngineForPartition(SearchEnvironment env, PhysicalPartition part)
part
- partition of interest
protected MergeRequest generateMergeRequest(ClientRequest request, java.util.List engineResponses)
request
- the original request. merge settings come from the mergeSettings
optional mergeSettings attribute in the request's attribute mapengineResponses
- the SearchEngineResponse
s for the request
protected MergeRequest generateMergeRequest2(SearchRequest request, java.util.List engineResponses)
request
- the original request. merge settings come from the mergeSettings
optional mergeSettings attribute in the request's attribute mapengineResponses
- the SearchEngineResponse
s for the request
public Results search(ClientRequest request, java.lang.String envName) throws RoutingException
request
- a search requestenvName
- name of the search environment to search, in this format:
envName[:[logicalPartitionName]:[service-specific-identifier]:[physicalPartitionId]]
Note that if the target includes more than just the envName, then all of the colons are required.
For example, myEnvName:myLPName::
, or myEnvName::mySvcId:
, or myEnvName:myLPName::myPhysicalPartitionId
.
RoutingException
- if anything is wrong with the search or the environmentpublic QueryRequest.Response search(QueryRequest request) throws SearchClientException
request
- query request
SearchClientException
public java.util.Collection getSearchEnvironmentTargets() throws SearchClientException
SearchEnvironmentTarget
SearchClientException
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |