com.exalead.searchapi.xmlv10.client

Class SearchClientFactory

java.lang.Object

com.exalead.searchapi.xmlv10.client.SearchClientFactory

public class SearchClientFactory
extends java.lang.Object

Factory used to obtain a SearchClient instance which is the main component of the Search API Client See SearchClient for more information.

Constructor Summary

Constructors

Constructor and Description
SearchClientFactory()

Method Summary

Modifier and Type	Method and Description
static IntrospectionClient	createIntrospectionClient(ServerInfos[] servers)
static IntrospectionClient	createIntrospectionClient(java.lang.String url) Create an introspection client that will query one or several search-api urls
static IntrospectionClient	createIntrospectionClient(java.lang.String[] urls)
static SearchClient	createSearchClient(SearchAPIHttpClient client, SearchAPIVersion version, java.util.Properties options) Create a search client using a pre-built HTTP requestor.
static SearchClient	createSearchClient(ServerInfos[] servers, SearchAPIVersion version, java.util.Properties options) Create a search client that will query several search-api urls, with advanced parameters.
static SearchClient	createSearchClient(java.lang.String[] urls, SearchAPIVersion version) Create a search client that will query several search-api urls.
static SearchClient	createSearchClient(java.lang.String[] urls, SearchAPIVersion version, int maxConnectionsPerHost) Create a search client that will query several search-api urls.
static SearchClient	createSearchClient(java.lang.String[] urls, SearchAPIVersion version, int maxConnectionsPerHost, java.util.Properties options) Create a search client that will query several search-api urls, with advanced parameters.
static SearchClient	createSearchClient(java.lang.String[] urls, SearchAPIVersion version, java.util.Properties options) Create a search client that will query several search-api urls, with advanced parameters See createSearchClient(String[], SearchAPIVersion) and createSearchClient(String, SearchAPIVersion, Properties) for more information on parameters.
static SearchClient	createSearchClient(java.lang.String url, SearchAPIVersion version) Create a new search client.
static SearchClient	createSearchClient(java.lang.String url, SearchAPIVersion version, int maxConnectionsPerHost) Create a new SearchClient and set the number of maximum connections per host See createSearchClient(String, SearchAPIVersion) for details on the other parameters.
static SearchClient	createSearchClient(java.lang.String url, SearchAPIVersion version, int maxConnectionsPerHost, java.util.Properties options) Create a new SearchClient with advanced options and set the max.
static SearchClient	createSearchClient(java.lang.String url, SearchAPIVersion version, java.util.Properties options) Create a new SearchClient with advanced options.

Methods inherited from class java.lang.Object

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

Constructor Detail

SearchClientFactory

public SearchClientFactory()

Method Detail

createSearchClient

public static SearchClient createSearchClient(java.lang.String url,
                                              SearchAPIVersion version)
                                       throws java.net.MalformedURLException

Create a new search client. The URL must be

• For a CloudView 4.6 product, the URL of a XMLv10 search command
• For a CloudView 5.0 or 5.1 product, the URL of the GET command ("/search-api/search" by default)
• For a CloudView V6 product, the URL of a SearchCommand followed by /search ("/search-api/search" by default)

The following CloudView V6 releases are supported

• V6R2012x
• V6R2013
• V6R2013x

Parameters:

url - the url to query.

version - SearchAPIVersion.XMLV10_46 on a 4.6 product,SearchAPIVersion.XMLV10_50 on a 5.0 or 5.1 product, SearchAPIVersion.V6R2012X for a V6R2012x product, SearchAPIVersion.V6R2013 for a V6R2013 product SearchAPIVersion.V6R2013 for a V6R2013x product

Returns:

a thread-safe SearchClient instance. One instance for the whole application is enough.

Throws:

java.net.MalformedURLException - if the URL is invalid

createSearchClient

public static SearchClient createSearchClient(java.lang.String url,
                                              SearchAPIVersion version,
                                              int maxConnectionsPerHost)
                                       throws java.net.MalformedURLException

Create a new SearchClient and set the number of maximum connections per host See createSearchClient(String, SearchAPIVersion) for details on the other parameters.

Parameters:

options - Advanced options

Throws:

java.net.MalformedURLException

createSearchClient

public static SearchClient createSearchClient(java.lang.String url,
                                              SearchAPIVersion version,
                                              java.util.Properties options)
                                       throws java.net.MalformedURLException

Create a new SearchClient with advanced options. The available options are:

 http.max_number_of_connections_per_server=8
 
 # Use the Exalead HTTP failover client if available
 http.use_failover_client=true

 http.commons-httpclient.stale_checking_enabled=true
 http.use_commons-httpclient_if_available=true

 client.enable_query_validator=true

 # Only for (deprecated) DOM parsing
 dom_parsing.keep_namespaces=false

 # Only for (deprecated) JAXB object parsing
 object_unmarshalling.pool_size=5
 object_unmarshalling.lazy_pool_instanciation=false
 

See createSearchClient(String, SearchAPIVersion) for details on the other parameters.

Parameters:

options - Advanced options

Throws:

java.net.MalformedURLException

createSearchClient

public static SearchClient createSearchClient(java.lang.String url,
                                              SearchAPIVersion version,
                                              int maxConnectionsPerHost,
                                              java.util.Properties options)
                                       throws java.net.MalformedURLException

Create a new SearchClient with advanced options and set the max. number connections per host The available options are:

 http.max_number_of_connections_per_server=8
 
 # Use the Exalead HTTP failover client if available
 http.use_failover_client=true

 http.commons-httpclient.stale_checking_enabled=true
 http.use_commons-httpclient_if_available=true

 client.enable_query_validator=true

 # Only for (deprecated) DOM parsing
 dom_parsing.keep_namespaces=false

 # Only for (deprecated) JAXB object parsing
 object_unmarshalling.pool_size=5
 object_unmarshalling.lazy_pool_instanciation=false
 

See createSearchClient(String, SearchAPIVersion) for details on the other parameters.

Parameters:

options - Advanced options

Throws:

java.net.MalformedURLException

createSearchClient

public static SearchClient createSearchClient(java.lang.String[] urls,
                                              SearchAPIVersion version)
                                       throws java.net.MalformedURLException

Create a search client that will query several search-api urls. All URLs are supposed to be equivalent and must be running the same product. The requests will be dispatched according to a simple load balancing and failover mechanism. See createSearchClient(String, SearchAPIVersion) for details on the other parameters.

Throws:

java.net.MalformedURLException

createSearchClient

public static SearchClient createSearchClient(java.lang.String[] urls,
                                              SearchAPIVersion version,
                                              int maxConnectionsPerHost)
                                       throws java.net.MalformedURLException

Create a search client that will query several search-api urls. All URLs are supposed to be equivalent and must be running the same product. The requests will be dispatched according to a simple load balancing and failover mechanism. Set the number of maximum cnumber of connections per host See createSearchClient(String, SearchAPIVersion) for details on the other parameters.

Throws:

java.net.MalformedURLException

createSearchClient

public static SearchClient createSearchClient(java.lang.String[] urls,
                                              SearchAPIVersion version,
                                              java.util.Properties options)
                                       throws java.net.MalformedURLException

Create a search client that will query several search-api urls, with advanced parameters See createSearchClient(String[], SearchAPIVersion) and createSearchClient(String, SearchAPIVersion, Properties) for more information on parameters.

Throws:

java.net.MalformedURLException

createSearchClient

public static SearchClient createSearchClient(java.lang.String[] urls,
                                              SearchAPIVersion version,
                                              int maxConnectionsPerHost,
                                              java.util.Properties options)
                                       throws java.net.MalformedURLException

Create a search client that will query several search-api urls, with advanced parameters. Set the max. number of connections per host See createSearchClient(String[], SearchAPIVersion) and createSearchClient(String, SearchAPIVersion, Properties) for more information on parameters.

Throws:

java.net.MalformedURLException

createSearchClient

public static SearchClient createSearchClient(ServerInfos[] servers,
                                              SearchAPIVersion version,
                                              java.util.Properties options)
                                       throws java.net.MalformedURLException

Create a search client that will query several search-api urls, with advanced parameters. Use this method to connect to an authenticated search-api and to set the "isAlive" service for high-availability services. See createSearchClient(String[], SearchAPIVersion) and createSearchClient(String, SearchAPIVersion, Properties)

Throws:

java.net.MalformedURLException

createIntrospectionClient

public static IntrospectionClient createIntrospectionClient(java.lang.String url)
                                                     throws java.net.MalformedURLException

Create an introspection client that will query one or several search-api urls

Throws:

java.net.MalformedURLException

createIntrospectionClient

public static IntrospectionClient createIntrospectionClient(java.lang.String[] urls)
                                                     throws java.net.MalformedURLException

Throws:

java.net.MalformedURLException

createIntrospectionClient

public static IntrospectionClient createIntrospectionClient(ServerInfos[] servers)
                                                     throws java.net.MalformedURLException

Throws:

java.net.MalformedURLException

createSearchClient

public static SearchClient createSearchClient(SearchAPIHttpClient client,
                                              SearchAPIVersion version,
                                              java.util.Properties options)

Create a search client using a pre-built HTTP requestor. Internal usage.