com.datasift.client

Class DataSiftConfig

java.lang.Object

com.datasift.client.DataSiftConfig

public class DataSiftConfig
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
protected String	apiKey
protected boolean	compatibleSSLProtocolsFound
protected int	connectTimeout
protected String	host
protected io.higgs.http.client.HttpRequestBuilder	http This instance should be used as a base for configurations.
protected boolean	manualPort
protected int	port
protected boolean	sslEnabled
protected List<String>	sslProtocols
protected String	urlEncodingFormat
protected String	username
protected String	versionPrefix
protected String	wsHost

Constructor Summary

Constructors

Constructor and Description
DataSiftConfig()
DataSiftConfig(String username, String apiKey) Initialize a new config instance with the given username and api key

Method Summary

Methods

Modifier and Type	Method and Description
DataSiftConfig	auth(String username, String apiKey) Provide the user credentials that should be used for authentication
String	authAsHeader()
URI	baseURL()
boolean	compatibleSSLProtocolsFound()
int	connectTimeout()
void	connectTimeout(int connectTimeout)
String	getApiKey()
String	getClientVersion()
String	getUsername()
String	host()
DataSiftConfig	host(String host)
io.higgs.http.client.HttpRequestBuilder	http()
boolean	isAutoReconnect()
boolean	isSslEnabled()
URI	newAPIEndpointURI(String endpoint) Generate a new URI object given an endpoint relative to the base url of this configuration.
URI	newAPIEndpointURI(URI endpoint) Generate a new URI object given an endpoint relative to the base url of this configuration.
int	port()
void	port(int p)
String	protocol()
DataSiftConfig	proxy(String host, int port) Sets a host and port for a proxy that all requests should be sent to
DataSiftConfig	proxy(String host, int port, String username, String password)
void	setAutoReconnect(boolean autoReconnect) Sets whether streams are automatically reconnected when a websocket connection is closed
void	setSslEnabled(boolean sslEnabled)
String[]	sslProtocols() Gets an array of compatible SSL protocols found on this JVM
String	urlEncodingFormat()
DataSiftConfig	urlEncodingFormat(String format) Sets the format that should be used to encode URL parameters when the option arises e.g.
String	versionPrefix()
String	wsHost()
DataSiftConfig	wsHost(String host)

Methods inherited from class java.lang.Object

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

Field Detail

compatibleSSLProtocolsFound

protected boolean compatibleSSLProtocolsFound

sslProtocols

protected List<String> sslProtocols

username

protected String username

apiKey

protected String apiKey

sslEnabled

protected boolean sslEnabled

host

protected String host

wsHost

protected String wsHost

http

protected io.higgs.http.client.HttpRequestBuilder http

This instance should be used as a base for configurations. All new requests should use HttpRequestBuilder.copy() Although a single instance would work, this keeps things simple and ensures no stale data is passed in subsequent requests. It is also very cheap in terms of Netty's thread usage because Higgs re-uses the same event loop group so it'll never be creating a whole new load of resources for each instance.

versionPrefix

protected String versionPrefix

urlEncodingFormat

protected String urlEncodingFormat

port

protected int port

manualPort

protected boolean manualPort

connectTimeout

protected int connectTimeout

Constructor Detail

DataSiftConfig

public DataSiftConfig()

DataSiftConfig

public DataSiftConfig(String username,
              String apiKey)

Initialize a new config instance with the given username and api key

Parameters:

username - the DataSift username

apiKey - the DataSift API key

Method Detail

auth

public DataSiftConfig auth(String username,
                  String apiKey)

Provide the user credentials that should be used for authentication

Parameters:

username - the DataSift username

apiKey - the DataSift API key

Returns:

this object for further configuration

proxy

public DataSiftConfig proxy(String host,
                   int port)

Sets a host and port for a proxy that all requests should be sent to

Parameters:

host - proxy host

port - proxy port

Returns:

this

proxy

public DataSiftConfig proxy(String host,
                   int port,
                   String username,
                   String password)

Parameters:

username - the username the proxy requires

password - the password the proxy requires

Returns:

this

protocol

public String protocol()

Returns:

The HTTP protocol prefix to use. If SSL is enabled this will be "https://" if not it'll be "http://"

host

public DataSiftConfig host(String host)

host

public String host()

Returns:

The host name to which all api calls with this configurations will be made

wsHost

public DataSiftConfig wsHost(String host)

wsHost

public String wsHost()

Returns:

The host name used to streaming

port

public int port()

Returns:

The port on which connections should be made

port

public void port(int p)

baseURL

public URI baseURL()

Returns:

A base URL to the DataSift API. e.g. https://api.datasift.com/v1/

newAPIEndpointURI

public URI newAPIEndpointURI(String endpoint)

Generate a new URI object given an endpoint relative to the base url of this configuration. For example, if the base URL is https://api.datasift.com/v1/ and the endpoint parameters is validate this will return the URI https://api.datasift.com/v1/validate. Technically any path acceptable by URI.resolve(String) is acceptable

Parameters:

endpoint - the endpoint to return a URI for.

Returns:

a new URI with the resolved URL that is safe to manipulate

newAPIEndpointURI

public URI newAPIEndpointURI(URI endpoint)

Generate a new URI object given an endpoint relative to the base url of this configuration. For example, if the base URL is https://api.datasift.com/v1/ and the endpoint parameters is validate this will return the URI https://api.datasift.com/v1/validate. Technically any path acceptable by URI.resolve(URI) is acceptable

Parameters:

endpoint - the endpoint to return a URI for.

Returns:

a new URI with the resolved URL that is safe to manipulate

versionPrefix

public String versionPrefix()

Returns:

The API version prefix to use, e.g. v1

getUsername

public String getUsername()

getApiKey

public String getApiKey()

isSslEnabled

public boolean isSslEnabled()

setSslEnabled

public void setSslEnabled(boolean sslEnabled)

authAsHeader

public String authAsHeader()

http

public io.higgs.http.client.HttpRequestBuilder http()

urlEncodingFormat

public String urlEncodingFormat()

Returns:

The format that should be used to URL encode prameters

urlEncodingFormat

public DataSiftConfig urlEncodingFormat(String format)

Sets the format that should be used to encode URL parameters when the option arises e.g. ISO-8859-1 or UTF-8

Parameters:

format - the format

Returns:

this

isAutoReconnect

public boolean isAutoReconnect()

setAutoReconnect

public void setAutoReconnect(boolean autoReconnect)

Sets whether streams are automatically reconnected when a websocket connection is closed

Parameters:

autoReconnect - true or false, defaults to true

sslProtocols

public String[] sslProtocols()

Gets an array of compatible SSL protocols found on this JVM

Returns:

an array of SSL protocols or NULL if none are available

compatibleSSLProtocolsFound

public boolean compatibleSSLProtocolsFound()

Returns:

true if at least one compatible secure protocol is available

connectTimeout

public int connectTimeout()

connectTimeout

public void connectTimeout(int connectTimeout)

getClientVersion

public String getClientVersion()