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, LanguageIdentification, LanguageTranslation, MachineTranslation, MessageResonance, NaturalLanguageClassifier, PersonalityInsights, QuestionAndAnswer, RelationshipExtraction, SpeechToText, TextToSpeech, ToneAnalyzer, TradeoffAnalytics, VisualInsights, VisualRecognition

public abstract class WatsonService
extends Object

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

Author:

German Attanasio Ruiz (germanatt@us.ibm.com)

See Also:

IBM Watson Developer Cloud

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	FORWARD_SLASH The FORWARD_SLASH.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
protected org.apache.http.HttpResponse	execute(org.apache.http.client.methods.HttpRequestBase request) Execute the Http request.
protected <T> T	executeRequest(Request request, Class<T> returnType) Execute the request and return the POJO that represent the response.
protected void	executeWithoutResponse(org.apache.http.client.methods.HttpRequestBase request) Execute the Http request and discard the response.
protected String	getApiKey() Gets the API key.
protected String	getDefaultContentType() Gets the default content type.
protected org.apache.http.params.HttpParams	getDefaultRequestParams() Gets the default request.
String	getEndPoint() Gets the API end point.
org.apache.http.client.HttpClient	getHttpClient() Gets the http client.
org.apache.http.client.HttpClient	getThreadSafeClient() Gets the thread safe client.
void	setApiKey(String apiKey) Sets the API key.
protected void	setAuthentication(org.apache.http.client.methods.HttpRequestBase request) Sets the authentication.
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

FORWARD_SLASH

protected static final String FORWARD_SLASH

The FORWARD_SLASH.

See Also:

Constant Field Values

Constructor Detail

WatsonService

public WatsonService()

Instantiates a new Watson service.

Method Detail

executeWithoutResponse

protected void executeWithoutResponse(org.apache.http.client.methods.HttpRequestBase 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

execute

protected org.apache.http.HttpResponse execute(org.apache.http.client.methods.HttpRequestBase request)

Execute the Http request.

Parameters:

request - the http request

Returns:

the http response

getApiKey

protected String getApiKey()

Gets the API key.

Returns:

the API key

getDefaultContentType

protected String getDefaultContentType()

Gets the default content type.

Returns:

the default content type

getDefaultRequestParams

protected org.apache.http.params.HttpParams getDefaultRequestParams()

Gets the default request.

Returns:

the default request

getEndPoint

public String getEndPoint()

Gets the API end point.

Returns:

the API end point

getHttpClient

public org.apache.http.client.HttpClient getHttpClient()

Gets the http client.

Returns:

the http client

getThreadSafeClient

public org.apache.http.client.HttpClient getThreadSafeClient()

Gets the thread safe client.

Returns:

the thread safe client

setApiKey

public void setApiKey(String apiKey)

Sets the API key.

Parameters:

apiKey - the new API key

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

setAuthentication

protected void setAuthentication(org.apache.http.client.methods.HttpRequestBase request)

Sets the authentication.

Parameters:

request - the new authentication

executeRequest

protected <T> T executeRequest(Request request,
                               Class<T> returnType)

Execute the request and return the POJO that represent the response.

Type Parameters:

T - The POJO that represents the response object

Parameters:

request - the request

returnType - the POJO class to be parsed from the response

Returns:

the POJO object that represent the response

toString

public String toString()

Overrides:

toString in class Object