com.ibm.watson.developer_cloud.service

Class WatsonService

java.lang.Object

com.ibm.watson.developer_cloud.service.WatsonService

Direct Known Subclasses:

Assistant, Assistant, CompareComply, Conversation, Discovery, LanguageTranslator, NaturalLanguageClassifier, NaturalLanguageUnderstanding, PersonalityInsights, SpeechToText, TextToSpeech, ToneAnalyzer, VisualRecognition

public abstract class WatsonService
extends java.lang.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 okhttp3.Headers	defaultHeaders The default headers.
protected static java.util.regex.Pattern	JSON_MIME_PATTERN
protected static java.util.regex.Pattern	JSON_PATCH_MIME_PATTERN
protected static java.lang.String	MESSAGE_CODE The Constant MESSAGE_CODE.
protected static java.lang.String	MESSAGE_ERROR The Constant MESSAGE_ERROR.
protected boolean	skipAuthentication The skip authentication.
protected static java.lang.String	VERSION The Constant VERSION.

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
void	configureClient(HttpConfigOptions options) Configures the OkHttpClient based on the passed-in options.
protected okhttp3.OkHttpClient	configureHttpClient() Configure the OkHttpClient.
protected <T> ServiceCall<T>	createServiceCall(okhttp3.Request request, ResponseConverter<T> converter) Creates the service call.
protected java.lang.String	getApiKey() Gets the API key.
java.lang.String	getEndPoint() Gets the API end point.
java.lang.String	getName() Gets the name.
protected java.lang.String	getPassword() Gets the password.
ServiceCall<java.lang.String>	getToken() Gets an authorization token that can be use to authorize API calls.
protected java.lang.String	getUsername() Gets the username.
static boolean	isJsonMimeType(java.lang.String mimeType) Returns true iff the specified mimeType indicates a JSON-related content type.
static boolean	isJsonPatchMimeType(java.lang.String mimeType) Returns true iff the specified mimeType indicates a "Json Patch"-related content type.
protected boolean	isTokenManagerSet() Checks the status of the tokenManager.
protected <T> T	processServiceCall(ResponseConverter<T> converter, okhttp3.Response response) Process service call.
void	setApiKey(java.lang.String apiKey) Sets the API key.
protected void	setAuthentication(okhttp3.Request.Builder builder) Sets the authentication.
void	setDefaultHeaders(java.util.Map<java.lang.String,java.lang.String> headers) Set the default headers to be used on every HTTP request.
protected void	setDefaultHeaders(okhttp3.Request.Builder builder) Sets the default headers including User-Agent.
void	setEndPoint(java.lang.String endPoint) Sets the end point.
void	setIamCredentials(IamOptions iamOptions) Sets IAM information.
void	setSkipAuthentication(boolean skipAuthentication) Sets the skip authentication.
void	setUsernameAndPassword(java.lang.String username, java.lang.String password) Sets the username and password.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

defaultHeaders

protected okhttp3.Headers defaultHeaders

The default headers.

skipAuthentication

protected boolean skipAuthentication

The skip authentication.

MESSAGE_CODE

protected static final java.lang.String MESSAGE_CODE

The Constant MESSAGE_CODE.

See Also:

Constant Field Values

MESSAGE_ERROR

protected static final java.lang.String MESSAGE_ERROR

The Constant MESSAGE_ERROR.

See Also:

Constant Field Values

VERSION

protected static final java.lang.String VERSION

The Constant VERSION.

See Also:

Constant Field Values

JSON_MIME_PATTERN

protected static final java.util.regex.Pattern JSON_MIME_PATTERN

JSON_PATCH_MIME_PATTERN

protected static final java.util.regex.Pattern JSON_PATCH_MIME_PATTERN

Constructor Detail

WatsonService

public WatsonService(java.lang.String name)

Instantiates a new Watson service.

Parameters:

name - the service name

Method Detail

isJsonMimeType

public static boolean isJsonMimeType(java.lang.String mimeType)

Returns true iff the specified mimeType indicates a JSON-related content type. (e.g. application/json, application/json-patch+json, application/merge-patch+json, etc.).

Parameters:

mimeType - the mimetype to consider

Returns:

true if the mimeType indicates a JSON-related content type

isJsonPatchMimeType

public static boolean isJsonPatchMimeType(java.lang.String mimeType)

Returns true iff the specified mimeType indicates a "Json Patch"-related content type. (e.g. application/json-patch+json)).

Parameters:

mimeType - the mimetype to consider

Returns:

true if the mimeType indicates a JSON-related content type

configureHttpClient

protected okhttp3.OkHttpClient configureHttpClient()

Configure the OkHttpClient. This method will be called by the constructor and can be used to customize the client that the service will use to perform the http calls.

Returns:

the OkHttpClient

configureClient

public void configureClient(HttpConfigOptions options)

Configures the OkHttpClient based on the passed-in options.

Parameters:

options - the HttpConfigOptions object for modifying the client

setDefaultHeaders

protected void setDefaultHeaders(okhttp3.Request.Builder builder)

Sets the default headers including User-Agent.

Parameters:

builder - the new default headers

createServiceCall

protected final <T> ServiceCall<T> createServiceCall(okhttp3.Request request,
                                   ResponseConverter<T> converter)

Creates the service call.

Type Parameters:

T - the generic type

Parameters:

request - the request

converter - the converter

Returns:

the service call

getApiKey

protected java.lang.String getApiKey()

Gets the API key.

Returns:

the API key

getUsername

protected java.lang.String getUsername()

Gets the username.

Returns:

the username

getPassword

protected java.lang.String getPassword()

Gets the password.

Returns:

the password

getEndPoint

public java.lang.String getEndPoint()

Gets the API end point.

Returns:

the API end point

getToken

public ServiceCall<java.lang.String> getToken()

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

Returns:

the token

isTokenManagerSet

protected boolean isTokenManagerSet()

Checks the status of the tokenManager.

Returns:

true if the tokenManager has been set

getName

public java.lang.String getName()

Gets the name.

Returns:

the name

setApiKey

public void setApiKey(java.lang.String apiKey)

Sets the API key.

Parameters:

apiKey - the new API key

setAuthentication

protected void setAuthentication(okhttp3.Request.Builder builder)

Sets the authentication. Okhttp3 compliant.

Parameters:

builder - the new authentication

setEndPoint

public void setEndPoint(java.lang.String endPoint)

Sets the end point.

Parameters:

endPoint - the new end point. Will be ignored if empty or null

setUsernameAndPassword

public void setUsernameAndPassword(java.lang.String username,
                          java.lang.String password)

Sets the username and password.

Parameters:

username - the username

password - the password

setDefaultHeaders

public void setDefaultHeaders(java.util.Map<java.lang.String,java.lang.String> headers)

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

Parameters:

headers - name value pairs of headers

setIamCredentials

public void setIamCredentials(IamOptions iamOptions)

Sets IAM information. Be aware that if you pass in an access token using this method, you accept responsibility for managing the access token yourself. You must set a new access token before this one expires. Failing to do so will result in authentication errors after this token expires.

Parameters:

iamOptions - object containing values to be used for authenticating with IAM

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

processServiceCall

protected <T> T processServiceCall(ResponseConverter<T> converter,
                       okhttp3.Response response)

Process service call.

Type Parameters:

T - the generic type

Parameters:

converter - the converter

response - the response

Returns:

the t

setSkipAuthentication

public void setSkipAuthentication(boolean skipAuthentication)

Sets the skip authentication.

Parameters:

skipAuthentication - the new skip authentication