com.yahoo.search.federation.vespa

Class VespaSearcher

java.lang.Object

com.yahoo.component.AbstractComponent

com.yahoo.component.chain.ChainedComponent

com.yahoo.processing.Processor

com.yahoo.search.Searcher

com.yahoo.search.cluster.PingableSearcher

com.yahoo.search.cluster.ClusterSearcher<Connection>

com.yahoo.search.federation.http.HTTPSearcher

com.yahoo.search.federation.http.HTTPProviderSearcher

com.yahoo.search.federation.http.ConfiguredHTTPProviderSearcher

com.yahoo.search.federation.vespa.VespaSearcher

All Implemented Interfaces:

com.yahoo.component.Component, NodeManager<Connection>, Comparable<com.yahoo.component.Component>

Deprecated.

@Deprecated
public class VespaSearcher
extends ConfiguredHTTPProviderSearcher

Backend searcher for external Vespa clusters (queried over http).

If the "sources" argument should be honored on an external cluster when using YQL+, override chooseYqlSources(Set).

Author:

Arne Bergene Fossaa, Steinar Knutsen

Nested Class Summary

Nested classes/interfaces inherited from class com.yahoo.search.federation.http.HTTPSearcher

HTTPSearcher.SearcherHttpClient, HTTPSearcher.ThrowingCertificateStore

Field Summary

Fields

Modifier and Type	Field and Description
private Query.Type	queryType Deprecated.
private ThreadLocal<XMLReader>	readerHolder Deprecated.
private com.yahoo.collections.Tuple2<String,com.yahoo.component.Version>	segmenterVersion Deprecated.
private static com.yahoo.processing.request.CompoundName	select Deprecated.
private static com.yahoo.processing.request.CompoundName	streamingGroupname Deprecated.
private static com.yahoo.processing.request.CompoundName	streamingSelection Deprecated.
private static com.yahoo.processing.request.CompoundName	streamingUserid Deprecated.

Fields inherited from class com.yahoo.search.federation.http.HTTPProviderSearcher

cacheName, log

Fields inherited from class com.yahoo.search.federation.http.HTTPSearcher

certificateProxy, IP_ADDRESS_UNKNOWN, LOG_CONNECT_TIMEOUT_PREFIX, LOG_HEADER_PREFIX, LOG_HITCOUNT, LOG_HOST, LOG_IP_ADDRESS, LOG_LATENCY_CONNECT, LOG_LATENCY_FINISH, LOG_LATENCY_START, LOG_PATH, LOG_PORT, LOG_PROXY_HOST, LOG_PROXY_PORT, LOG_PROXY_TYPE, LOG_QUERY_PARAM_PREFIX, LOG_READ_TIMEOUT_PREFIX, LOG_RESPONSE_HEADER_PREFIX, LOG_SCHEME, LOG_STATUS, LOG_URI, useCertificate, YCA_HTTP_HEADER

Fields inherited from class com.yahoo.component.AbstractComponent

isDeconstructable

Constructor Summary

Constructors

Constructor and Description
VespaSearcher(com.yahoo.component.ComponentId id, ProviderConfig config, QrBinaryCacheConfig c, QrBinaryCacheRegionConfig r, com.yahoo.statistics.Statistics statistics) Deprecated. Create an instance from configuration
VespaSearcher(com.yahoo.component.ComponentId id, ProviderConfig config, QrBinaryCacheConfig c, QrBinaryCacheRegionConfig r, com.yahoo.statistics.Statistics statistics, com.yahoo.language.Linguistics linguistics) Deprecated. Create an instance from configuration
VespaSearcher(String idString, String host, int port, String path) Deprecated. Create an instance from direct parameters having a single connection.

Method Summary

Modifier and Type	Method and Description
(package private) void	addProperty(Map<String,String> queryMap, Query query, com.yahoo.processing.request.CompoundName property) Deprecated.
protected void	chooseYqlSources(Set<String> sources) Deprecated. Choose which source arguments to use for the external cluster when generating a YQL+ query string.
protected void	chooseYqlSummaryFields(Set<String> summaryFields) Deprecated. Choose which summary fields to request from the external cluster when generating a YQL+ query string.
Map<String,String>	getCacheKey(Query q) Deprecated.
URI	getPingURI(Connection connection) Deprecated. Returns the canonical Vespa ping URI, http://host:port/status.html
Map<String,String>	getQueryMap(Query query) Deprecated. Returns the key-value pairs that should be added as properties to the request url sent to the service.
private Map<String,String>	getQueryMapWithoutHitsOffset(Query query) Deprecated.
private XMLReader	getReader() Deprecated.
protected com.yahoo.collections.Tuple2<String,com.yahoo.component.Version>	getSegmenterVersion() Deprecated. Get the segmenter version data used when creating YQL queries.
String	marshalQuery(Query query) Deprecated. Serialize the query parameter for outgoing queries.
String	marshalQuery(QueryTree root) Deprecated.
private String	marshalRoot(Item root) Deprecated.
(package private) Query.Type	toQueryType(ProviderConfig.QueryType.Enum providerQueryType) Deprecated.
void	unmarshal(InputStream stream, long contentLength, Result result) Deprecated. Unmarshal the stream by converting it to hits and adding the hits to the given result.

Methods inherited from class com.yahoo.search.federation.http.ConfiguredHTTPProviderSearcher

fill

Methods inherited from class com.yahoo.search.federation.http.HTTPProviderSearcher

addNonExcludedSourceProperties, configureCache, inspectAndReturnFinalResult, logResponseLatency, search, unmarshal

Methods inherited from class com.yahoo.search.federation.http.HTTPSearcher

checkPing, cleanupHttpEntity, createClient, createMalformedUrlError, createRequest, createRequest, createRequestMeta, getConnectionManager, getEntity, getEntity, getParameters, getPath, getPingPath, getRequestEntity, getRequestHeaders, getResponse, getResponse, getResponse, getResponse, getURI, getURI, ping, shutdownConnectionManagers

Methods inherited from class com.yahoo.search.cluster.ClusterSearcher

deconstruct, failed, fill, getFirstConnection, getHasher, getMonitor, log, ping, robustSearch, search, search, shouldRetry, timedOut, working

Methods inherited from class com.yahoo.search.cluster.PingableSearcher

ping

Methods inherited from class com.yahoo.search.Searcher

ensureFilled, getLogger, process, toString

Methods inherited from class com.yahoo.component.chain.ChainedComponent

getAnnotatedDependencies, getDefaultAnnotatedDependencies, getDependencies, initDependencies

Methods inherited from class com.yahoo.component.AbstractComponent

clone, compareTo, getClassName, getId, getIdString, hasInitializedId, initId, isDeconstructable, setIsDeconstructable

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.yahoo.search.cluster.NodeManager

pingIterationCompleted

Field Detail

readerHolder

private final ThreadLocal<XMLReader> readerHolder

Deprecated.

queryType

private final Query.Type queryType

Deprecated.

segmenterVersion

private final com.yahoo.collections.Tuple2<String,com.yahoo.component.Version> segmenterVersion

Deprecated.

select

private static final com.yahoo.processing.request.CompoundName select

Deprecated.

streamingUserid

private static final com.yahoo.processing.request.CompoundName streamingUserid

Deprecated.

streamingGroupname

private static final com.yahoo.processing.request.CompoundName streamingGroupname

Deprecated.

streamingSelection

private static final com.yahoo.processing.request.CompoundName streamingSelection

Deprecated.

Constructor Detail

VespaSearcher

public VespaSearcher(com.yahoo.component.ComponentId id,
                     ProviderConfig config,
                     QrBinaryCacheConfig c,
                     QrBinaryCacheRegionConfig r,
                     com.yahoo.statistics.Statistics statistics)

Deprecated.

Create an instance from configuration

VespaSearcher

@Inject
public VespaSearcher(com.yahoo.component.ComponentId id,
                             ProviderConfig config,
                             QrBinaryCacheConfig c,
                             QrBinaryCacheRegionConfig r,
                             com.yahoo.statistics.Statistics statistics,
                             @Nullable
                             com.yahoo.language.Linguistics linguistics)

Deprecated.

Create an instance from configuration

Parameters:

linguistics - used for generating meta info for YQL+

VespaSearcher

public VespaSearcher(String idString,
                     String host,
                     int port,
                     String path)

Deprecated.

Create an instance from direct parameters having a single connection. Useful for testing

Method Detail

addProperty

void addProperty(Map<String,String> queryMap,
                 Query query,
                 com.yahoo.processing.request.CompoundName property)

Deprecated.

getQueryMap

public Map<String,String> getQueryMap(Query query)

Deprecated.

Description copied from class: HTTPProviderSearcher

Returns the key-value pairs that should be added as properties to the request url sent to the service. Must be overridden in subclasses to add the key-values expected by the service in question, unless HTTPSearcher.getURI(com.yahoo.search.Query, com.yahoo.search.federation.http.Connection) (from which this is called) is overridden.

This default implementation returns the query.properties() prefixed by "source.[sourceName]" or "property.[propertyName]" (by calling HTTPProviderSearcher.addNonExcludedSourceProperties(com.yahoo.search.Query, java.util.Map<java.lang.String, java.lang.String>)).

Overrides:

getQueryMap in class HTTPProviderSearcher

getCacheKey

public Map<String,String> getCacheKey(Query q)

Deprecated.

Specified by:

getCacheKey in class HTTPProviderSearcher

getQueryMapWithoutHitsOffset

private Map<String,String> getQueryMapWithoutHitsOffset(Query query)

Deprecated.

toQueryType

Query.Type toQueryType(ProviderConfig.QueryType.Enum providerQueryType)

Deprecated.

marshalQuery

public String marshalQuery(Query query)

Deprecated.

Serialize the query parameter for outgoing queries. For YQL+ queries, sources and fields will be set to all sources and all fields, to follow the behavior of other query types.

Parameters:

query - the current, outgoing query

Returns:

a string to include in an HTTP request

marshalQuery

public String marshalQuery(QueryTree root)

Deprecated.

marshalRoot

private String marshalRoot(Item root)

Deprecated.

getReader

private XMLReader getReader()

Deprecated.

unmarshal

public void unmarshal(InputStream stream,
                      long contentLength,
                      Result result)

Deprecated.

Description copied from class: HTTPProviderSearcher

Unmarshal the stream by converting it to hits and adding the hits to the given result. A convenience hook called by the default unmarshal(entity,result). Override this in subclasses which does not override unmarshal(entity,result).

This default implementation throws an exception.

Overrides:

unmarshal in class HTTPProviderSearcher

Parameters:

stream - the stream of data returned

contentLength - the length of the content in bytes if known, or a negative number if unknown

result - the result to which unmarshalled data should be added

getPingURI

public URI getPingURI(Connection connection)
               throws MalformedURLException,
                      URISyntaxException

Deprecated.

Returns the canonical Vespa ping URI, http://host:port/status.html

Overrides:

getPingURI in class HTTPSearcher

Throws:

MalformedURLException

URISyntaxException

getSegmenterVersion

protected com.yahoo.collections.Tuple2<String,com.yahoo.component.Version> getSegmenterVersion()

Deprecated.

Get the segmenter version data used when creating YQL queries. Useful if overriding marshalQuery(Query).

Returns:

a tuple with the name of the segmenting engine in use, and its version

chooseYqlSources

protected void chooseYqlSources(Set<String> sources)

Deprecated.

Choose which source arguments to use for the external cluster when generating a YQL+ query string. This is called from marshalQuery(Query). The default implementation clears the set, i.e. requests all sources. Other implementations may modify the source set as they see fit, or simply do nothing.

Parameters:

sources - the set of source names to use for the outgoing query

chooseYqlSummaryFields

protected void chooseYqlSummaryFields(Set<String> summaryFields)

Deprecated.

Choose which summary fields to request from the external cluster when generating a YQL+ query string. This is called from marshalQuery(Query). The default implementation clears the set, i.e. requests all fields. Other implementations may modify the summary field set as they see fit, or simply do nothing.

Parameters:

summaryFields - the set of source names to use for the outgoing query