com.ibm.watson.developer_cloud.service

Class WatsonService

java.lang.Object

com.ibm.watson.developer_cloud.service.WatsonService

Direct Known Subclasses:

AlchemyService, ConceptExpansion, ConceptInsights, DialogService, DocumentConversion, LanguageTranslation, NaturalLanguageClassifier, PersonalityInsights, RelationshipExtraction, RetrieveAndRank, SpeechToText, TextToSpeech, ToneAnalyzer, ToneAnalyzer, TradeoffAnalytics, VisualInsights, VisualRecognition, VisualRecognition

public abstract class WatsonService
extends Object

Watson service abstract common functionality of various Watson Services. It handle authentication and default url

See Also:

IBM Watson Developer Cloud

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	VERSION

Constructor Summary

Constructors

Constructor and Description
WatsonService(String name) Instantiates a new Watson service.

Method Summary

Modifier and Type	Method and Description
protected com.squareup.okhttp.OkHttpClient	configureHttpClient() Configures the HTTP client.
protected com.squareup.okhttp.Response	execute(com.squareup.okhttp.Request request) Execute the HTTP request.
protected <T extends GenericModel> T	executeRequest(com.squareup.okhttp.Request request, Class<T> returnType) Executes the HTTP Request, reads and parses the HTTP Response.
protected void	executeWithoutResponse(com.squareup.okhttp.Request request) Execute the HTTP request and discard the response.
protected String	getApiKey() Gets the API key.
String	getEndPoint() Gets the API end point.
String	getName() Gets the name.
String	getToken() Gets an authorization token that can be use to authorize API calls.
void	setApiKey(String apiKey) Sets the API key.
protected void	setAuthentication(com.squareup.okhttp.Request.Builder builder) Sets the authentication.
void	setDefaultHeaders(Map<String,String> headers) Set the default headers to be used on every HTTP request.
void	setEndPoint(String endPoint) Sets the end point.
void	setUsernameAndPassword(String username, String password) Sets the username and password.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

VERSION

protected static final String VERSION

See Also:

Constant Field Values

Constructor Detail

WatsonService

public WatsonService(String name)

Instantiates a new Watson service.

Parameters:

name - the service name

Method Detail

configureHttpClient

protected com.squareup.okhttp.OkHttpClient configureHttpClient()

Configures the HTTP client.

Returns:

the HTTP client

execute

protected com.squareup.okhttp.Response execute(com.squareup.okhttp.Request request)

Execute the HTTP request.

Parameters:

request - the HTTP request

Returns:

the HTTP response

executeRequest

protected <T extends GenericModel> T executeRequest(com.squareup.okhttp.Request request,
                                                    Class<T> returnType)

Executes the HTTP Request, reads and parses the HTTP Response.

Type Parameters:

T - the POJO class that represents the response

Parameters:

request - the request

returnType - the return type

Returns:

the POJO object

executeWithoutResponse

protected void executeWithoutResponse(com.squareup.okhttp.Request request)

Execute the HTTP request and discard the response. Use this when you don't want to get the response but you want to make sure we read it so that the underline connection is released

Parameters:

request - the request

getApiKey

protected String getApiKey()

Gets the API key.

Returns:

the API key

getEndPoint

public String getEndPoint()

Gets the API end point.

Returns:

the API end point

getToken

public String getToken()

Gets an authorization token that can be use to authorize API calls.

Returns:

the token

getName

public String getName()

Gets the name.

Returns:

the name

setApiKey

public void setApiKey(String apiKey)

Sets the API key.

Parameters:

apiKey - the new API key

setAuthentication

protected void setAuthentication(com.squareup.okhttp.Request.Builder builder)

Sets the authentication.

Parameters:

builder - the new authentication

setEndPoint

public void setEndPoint(String endPoint)

Sets the end point.

Parameters:

endPoint - the new end point

setUsernameAndPassword

public void setUsernameAndPassword(String username,
                                   String password)

Sets the username and password.

Parameters:

username - the username

password - the password

setDefaultHeaders

public void setDefaultHeaders(Map<String,String> headers)

Set the default headers to be used on every HTTP request.

Parameters:

headers - name value pairs of headers

toString

public String toString()

Overrides:

toString in class Object