com.algolia.search.saas

Class AbstractClient

Object

com.algolia.search.saas.AbstractClient

Direct Known Subclasses:

Client, PlacesClient

public abstract class AbstractClient
extends Object

An abstract API client.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractClient.LibraryVersion A version of a software library.

Method Summary

Modifier and Type	Method and Description
void	addUserAgent(AbstractClient.LibraryVersion userAgent) Add a software library to the list of user agents.
String	getApplicationID()
int	getConnectTimeout() Get the connection timeout.
String	getHeader(String name) Get an HTTP header.
int	getHostDownDelay() Get the timeout for retrying connection to a down host.
String[]	getReadHosts()
int	getReadTimeout() Get the default read timeout.
int	getSearchTimeout() Get the read timeout for search requests.
AbstractClient.LibraryVersion[]	getUserAgents() Retrieve the list of declared user agents.
String[]	getWriteHosts()
boolean	hasUserAgent(AbstractClient.LibraryVersion userAgent) Test whether a user agent is declared.
void	removeUserAgent(AbstractClient.LibraryVersion userAgent) Remove a software library from the list of user agents.
void	setCompletionExecutor(java.util.concurrent.Executor completionExecutor) Change the executor on which completion handlers are executed.
void	setConnectTimeout(int connectTimeout) Set the connection timeout.
void	setHeader(String name, String value) Set an HTTP header that will be sent with every request.
void	setHostDownDelay(int hostDownDelay) Set the timeout for retrying connection to a down host.
void	setHosts(String... hosts) Set read and write hosts to the same value (convenience method).
void	setReadHosts(String... hosts)
void	setReadTimeout(int readTimeout) Set the default read timeout.
void	setSearchTimeout(int searchTimeout) Set the read timeout for search requests.
void	setWriteHosts(String... hosts)

Methods inherited from class Object

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

Method Detail

getApplicationID

public String getApplicationID()

setHeader

public void setHeader(@NonNull
                      String name,
                      @Nullable
                      String value)

Set an HTTP header that will be sent with every request.

Parameters:

name - Header name.

value - Value for the header. If null, the header will be removed.

getHeader

public String getHeader(@NonNull
                        String name)

Get an HTTP header.

Parameters:

name - Header name.

getReadHosts

public String[] getReadHosts()

setReadHosts

public void setReadHosts(@NonNull
                         String... hosts)

getWriteHosts

public String[] getWriteHosts()

setWriteHosts

public void setWriteHosts(@NonNull
                          String... hosts)

setHosts

public void setHosts(@NonNull
                     String... hosts)

Set read and write hosts to the same value (convenience method).

Parameters:

hosts - New hosts. Must not be empty.

getConnectTimeout

public int getConnectTimeout()

Get the connection timeout.

Returns:

The connection timeout (ms).

setConnectTimeout

public void setConnectTimeout(int connectTimeout)

Set the connection timeout.

Parameters:

connectTimeout - The new connection timeout (ms).

getReadTimeout

public int getReadTimeout()

Get the default read timeout.

Returns:

The default read timeout (ms).

setReadTimeout

public void setReadTimeout(int readTimeout)

Set the default read timeout.

Parameters:

readTimeout - The default read timeout (ms).

getSearchTimeout

public int getSearchTimeout()

Get the read timeout for search requests.

Returns:

The read timeout for search requests (ms).

setSearchTimeout

public void setSearchTimeout(int searchTimeout)

Set the read timeout for search requests.

Parameters:

searchTimeout - The read timeout for search requests (ms).

getHostDownDelay

public int getHostDownDelay()

Get the timeout for retrying connection to a down host.

Returns:

The delay before connecting again to a down host (ms).

setHostDownDelay

public void setHostDownDelay(int hostDownDelay)

Set the timeout for retrying connection to a down host.

Parameters:

hostDownDelay - The delay before connecting again to a down host (ms).

addUserAgent

public void addUserAgent(@NonNull
                         AbstractClient.LibraryVersion userAgent)

Add a software library to the list of user agents.

Parameters:

userAgent - The library to add.

removeUserAgent

public void removeUserAgent(@NonNull
                            AbstractClient.LibraryVersion userAgent)

Remove a software library from the list of user agents.

Parameters:

userAgent - The library to remove.

getUserAgents

@NonNull
public AbstractClient.LibraryVersion[] getUserAgents()

Retrieve the list of declared user agents.

Returns:

The declared user agents.

hasUserAgent

public boolean hasUserAgent(@NonNull
                            AbstractClient.LibraryVersion userAgent)

Test whether a user agent is declared.

Parameters:

userAgent - The user agent to look for.

Returns:

true if it is declared on this client, false otherwise.

setCompletionExecutor

public void setCompletionExecutor(@NonNull
                                  java.util.concurrent.Executor completionExecutor)

Change the executor on which completion handlers are executed. By default, completion handlers are executed on the main thread.

Parameters:

completionExecutor - The new completion executor to use.