com.primus.ae.searchclient
Class SearchClient

java.lang.Object
  com.primus.ae.searchclient.SearchClient

Deprecated. as of 9.0. Use SearchClient instead.

public class SearchClient
extends java.lang.Object

ATG Search client. Entrypoint for client searches.

Constructor Summary

SearchClient()
Deprecated.

SearchClient(java.util.Properties p)
Deprecated. The following properties must be specified:

searchclient.appservertype=local|rmi

searchclient.hostname=hostname of server

searchclient.hostport=listening port of server, e.g., 1099 or 6060

searchclient.messageservice=component path to the messaging service, usually /atg/search/events/SearchMessageService

Method Summary

SearchSession	beginSession(SessionConfig sessionConfig) Deprecated. Begins the user search session, and retrieves user-specified option sets from the server.
java.lang.String	doSearch(ClientRequest request, SearchSession searchSession) Deprecated.
void	endSession(SearchSession searchSession) Deprecated. Ends the user's search session
static Results	extractResults(ClientRequest request, java.lang.String resultXml) Deprecated. as of Search 2006.3
java.util.Collection	getSearchEnvironmentTargets() Deprecated.
atg.search.events.SearchMessageTools	getSearchMessageService() Deprecated.
boolean	isLoggingSearchEvents() Deprecated.
Results	search(ClientRequest request, SearchSession searchSession) Deprecated. Submits a request to ES using the provided search session.
Results	search(ClientRequest request, java.lang.String searchEnvironmentName) Deprecated.
void	setLoggingSearchEvents(boolean pLoggingSearchEvents) Deprecated.
void	setSearchMessageService(atg.search.events.SearchMessageTools pSearchMessageService) Deprecated.

Methods inherited from class java.lang.Object

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

Constructor Detail

SearchClient

public SearchClient()

Deprecated.

SearchClient

public SearchClient(java.util.Properties p)
             throws com.primus.ae.searchclient.SearchClientException

Deprecated.

The following properties must be specified:

searchclient.appservertype=local|rmi

searchclient.hostname=hostname of server

searchclient.hostport=listening port of server, e.g., 1099 or 6060

searchclient.messageservice=component path to the messaging service, usually /atg/search/events/SearchMessageService

Parameters:

p - appserver properties

Throws:

SearchClientException - if there is a propblem in connecting to the application server

Method Detail

getSearchMessageService

public atg.search.events.SearchMessageTools getSearchMessageService()

Deprecated.

setSearchMessageService

public void setSearchMessageService(atg.search.events.SearchMessageTools pSearchMessageService)

Deprecated.

isLoggingSearchEvents

public boolean isLoggingSearchEvents()

Deprecated.

setLoggingSearchEvents

public void setLoggingSearchEvents(boolean pLoggingSearchEvents)

Deprecated.

beginSession

public SearchSession beginSession(SessionConfig sessionConfig)

Deprecated.

Begins the user search session, and retrieves user-specified option sets from the server.

Parameters:

sessionConfig - configuration parameters for the session

Returns:

SearchSession object

Throws:

java.lang.RuntimeException - that wraps any application server related exceptions

endSession

public void endSession(SearchSession searchSession)

Deprecated.

Ends the user's search session

Parameters:

searchSession - The return value of beginSession

Throws:

java.lang.RuntimeException - that wraps any application server related exceptions

search

public Results search(ClientRequest request,
                      SearchSession searchSession)

Deprecated.

Submits a request to ES using the provided search session. Only the search environment name and possibly the page offsets from the session is used

Parameters:

request - The request to be submitted

searchSession - The session to use for the request.

Returns:

a collection of search results

Throws:

java.lang.RuntimeException - that wraps any application server related exceptions

getSearchEnvironmentTargets

public java.util.Collection getSearchEnvironmentTargets()

Deprecated.

Returns:

a List of SearchEnvironmentTarget

search

public Results search(ClientRequest request,
                      java.lang.String searchEnvironmentName)

Deprecated.

Submits a request to ES using the provided search session

Parameters:

request - The request to be submitted

searchEnvironmentName - The search environment name to use for the request

Returns:

a collection of search results

Throws:

java.lang.RuntimeException - that wraps any application server related exceptions

extractResults

public static Results extractResults(ClientRequest request,
                                     java.lang.String resultXml)
                              throws com.primus.searchstudio.InvalidResponseXMLException

Deprecated. as of Search 2006.3

extracts results from the xml.

Parameters:

request -

resultXml -

Returns:

Throws:

com.primus.searchstudio.InvalidResponseXMLException

doSearch

public java.lang.String doSearch(ClientRequest request,
                                 SearchSession searchSession)
                          throws atg.search.routing.RoutingException

Deprecated.

returns raw xml from a search. Involves a double parse. Do not use this method. Instead call Results.getResponseXml

Parameters:

request -

searchSession -

Returns:

Throws:

atg.search.routing.RoutingException