org.dizitart.no2.sync

Class DataGateClient

java.lang.Object

org.dizitart.no2.sync.DataGateClient

public class DataGateClient
extends java.lang.Object

Represents a DataGate server client for synchronous access.

Since:

1.0

Constructor Summary

Constructors

Constructor and Description
DataGateClient(java.lang.String serverBaseUrl) Instantiates a new DataGateClient.

Method Summary

Modifier and Type	Method and Description
DataGateClient	connectTimeout(long milliseconds) Sets the connection timeout for the underlying http client.
protected okhttp3.OkHttpClient	getHttpClient() Gets the underlying http client for the server-client communication.
protected java.lang.String	getServerBaseUrl() Gets the server base url.
DataGateClient	readTimeout(long milliseconds) Sets the read timeout for the underlying http client.
DataGateClient	trustAllCerts() Trust all certificates.
DataGateClient	withAuth(java.lang.String username, java.lang.String password) Sets user credentials for basic authentication.
DataGateClient	withProxy(java.net.Proxy proxy) Sets the proxy details to connect to DataGate server.
DataGateClient	withUserAgent(UserAgent userAgent) Sets the UserAgent details.

Methods inherited from class java.lang.Object

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

Constructor Detail

DataGateClient

public DataGateClient(java.lang.String serverBaseUrl)

Instantiates a new DataGateClient.

Parameters:

serverBaseUrl - the server base url

Method Detail

withAuth

public DataGateClient withAuth(java.lang.String username,
                               java.lang.String password)

Sets user credentials for basic authentication.

Parameters:

username - the username

password - the password

Returns:

the DataGateClient

withProxy

public DataGateClient withProxy(java.net.Proxy proxy)

Sets the proxy details to connect to DataGate server.

Parameters:

proxy - the proxy

Returns:

the DataGateClient

trustAllCerts

public DataGateClient trustAllCerts()

Trust all certificates.

Returns:

the DataGateClient

readTimeout

public DataGateClient readTimeout(long milliseconds)

Sets the read timeout for the underlying http client.

Parameters:

milliseconds - the timeout value in milliseconds

Returns:

the DataGateClient

connectTimeout

public DataGateClient connectTimeout(long milliseconds)

Sets the connection timeout for the underlying http client.

Parameters:

milliseconds - the timeout value in milliseconds

Returns:

the DataGateClient

withUserAgent

public DataGateClient withUserAgent(UserAgent userAgent)

Sets the UserAgent details. The user agent details helps to generate several analytics in DataGate server.

Parameters:

userAgent - the UserAgent

Returns:

the DataGateClient

getServerBaseUrl

protected java.lang.String getServerBaseUrl()

Gets the server base url.

Returns:

the remote url

getHttpClient

protected okhttp3.OkHttpClient getHttpClient()

Gets the underlying http client for the server-client communication.

Returns:

the http client