org.opennms.plugins.elasticsearch.rest

Class RestClientFactory

java.lang.Object

org.opennms.plugins.elasticsearch.rest.RestClientFactory

public class RestClientFactory
extends Object

This factory wraps the JestClientFactory to provide instances of JestClient.

Constructor Summary

Constructors

Constructor and Description
RestClientFactory(String elasticSearchURL, String esusername, String espassword) Create a RestClientFactory.

Method Summary

Modifier and Type	Method and Description
io.searchbox.client.JestClient	getJestClient()
int	getRetries()
int	getSocketTimeout()
int	getTimeout()
void	setRetries(int retries) Set the number of times the REST operation will be retried if an exception is thrown during the operation.
void	setSocketTimeout(int timeout) Set the socket timeout (SO_TIMEOUT) for the REST connections.
void	setTimeout(int timeout) Set the connection timeout for the REST connections.

Methods inherited from class java.lang.Object

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

Constructor Detail

RestClientFactory

public RestClientFactory(String elasticSearchURL,
                         String esusername,
                         String espassword)
                  throws MalformedURLException

Create a RestClientFactory.

Parameters:

elasticSearchURL - Elasticsearch URL, either a single URL or multiple URLs that are comma-separated without spaces

esusername - Optional HTTP username

espassword - Optional HTTP password

Throws:

MalformedURLException

Method Detail

getRetries

public int getRetries()

setRetries

public void setRetries(int retries)

Set the number of times the REST operation will be retried if an exception is thrown during the operation.

Parameters:

retries - Number of retries.

getSocketTimeout

public int getSocketTimeout()

setSocketTimeout

public void setSocketTimeout(int timeout)

Set the socket timeout (SO_TIMEOUT) for the REST connections. This is the maximum period of inactivity while waiting for incoming data. A default value of 3000 is specified in io.searchbox.client.config.ClientConfig.AbstractBuilder.

Parameters:

timeout - Timeout in milliseconds.

getTimeout

public int getTimeout()

setTimeout

public void setTimeout(int timeout)

Set the connection timeout for the REST connections. A default value of 3000 is specified in io.searchbox.client.config.ClientConfig.AbstractBuilder. This is also used as the minimum interval between successive retries if the connection is refused in a shorter amount of time.

Parameters:

timeout - Timeout in milliseconds.

getJestClient

public io.searchbox.client.JestClient getJestClient()