Package com.basistech.rosette.api

Class HttpRosetteAPI

java.lang.Object

com.basistech.rosette.api.common.AbstractRosetteAPI

com.basistech.rosette.api.HttpRosetteAPI

All Implemented Interfaces:

AutoCloseable

public class HttpRosetteAPI
extends AbstractRosetteAPI

Access to the RosetteAPI via HTTP.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	HttpRosetteAPI.Builder	Builder for HttpRosetteAPI objects.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	BINDING_VERSION
static final String	DEFAULT_URL_BASE
static final String	SERVICE_NAME
static final String	USER_AGENT_STR

Fields inherited from class com.basistech.rosette.api.common.AbstractRosetteAPI

ADDRESS_SIMILARITY_SERVICE_PATH, CATEGORIES_SERVICE_PATH, DOC_ENDPOINTS, ENTITIES_SERVICE_PATH, EVENTS_SERVICE_PATH, INFO_SERVICE_PATH, LANGUAGE_SERVICE_PATH, MORPHOLOGY_SERVICE_PATH, NAME_DEDUPLICATION_SERVICE_PATH, NAME_SIMILARITY_SERVICE_PATH, NAME_TRANSLATION_SERVICE_PATH, NAMES_ENDPOINTS, PING_SERVICE_PATH, RECORD_SIMILARITY_SERVICE_PATH, RELATIONSHIPS_SERVICE_PATH, SEMANTIC_VECTORS_SERVICE_PATH, SENTENCES_SERVICE_PATH, SENTIMENT_SERVICE_PATH, SIMILAR_TERMS_SERVICE_PATH, SUPPORTED_LANGUAGES_SUBPATH, SYNTAX_DEPENDENCIES_SERVICE_PATH, TEXT_EMBEDDING_SERVICE_PATH, TOKENS_SERVICE_PATH, TOPICS_SERVICE_PATH, TRANSLITERATION_SERVICE_PATH

Method Summary

Modifier and Type	Method	Description
void	close()
RosetteRequest	createRosetteRequest(String endpoint, com.basistech.rosette.apimodel.Request request, Class<? extends com.basistech.rosette.apimodel.Response> responseClass)	Creates a RosetteRequest which can be sent concurrently through this HttpRosetteAPI
int	getFailureRetries()	Return failure retries.
com.basistech.rosette.apimodel.SupportedLanguagePairsResponse	getSupportedLanguagePairs(String endpoint)	Gets the set of language, script codes and transliteration scheme pairs supported by the specified Rosette API endpoint.
com.basistech.rosette.apimodel.SupportedLanguagesResponse	getSupportedLanguages(String endpoint)	Gets the set of language and script codes supported by the specified Rosette API endpoint.
com.basistech.rosette.apimodel.InfoResponse	info()	Gets information about the Rosette API, returns name, version, build number and build time.
<RequestType extends com.basistech.rosette.apimodel.Request> com.basistech.rosette.dm.AnnotatedText	perform(String endpoint, RequestType request)	Perform a request to an endpoint of the Rosette API.
<RequestType extends com.basistech.rosette.apimodel.Request, ResponseType extends com.basistech.rosette.apimodel.Response> ResponseType	perform(String endpoint, RequestType request, Class<ResponseType> responseClass)	Perform a request to an endpoint of the Rosette API.
<RequestType extends com.basistech.rosette.apimodel.Request, ResponseType extends com.basistech.rosette.apimodel.Response> Future<ResponseType>	performAsync(String endpoint, RequestType request, Class<ResponseType> responseClass)	This method always throws UnsupportedOperationException.
com.basistech.rosette.apimodel.PingResponse	ping()	Pings the Rosette API for a response indicating that the service is available.

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_URL_BASE

public static final String DEFAULT_URL_BASE

See Also:

• Constant Field Values

SERVICE_NAME

public static final String SERVICE_NAME

See Also:

• Constant Field Values

BINDING_VERSION

public static final String BINDING_VERSION

USER_AGENT_STR

public static final String USER_AGENT_STR

Method Details

getFailureRetries

public int getFailureRetries()

Return failure retries.

Returns:

failure retries

info

public com.basistech.rosette.apimodel.InfoResponse info()
                                                 throws IOException,
HttpRosetteAPIException

Gets information about the Rosette API, returns name, version, build number and build time.

Returns:

InfoResponse

Throws:

HttpRosetteAPIException - Rosette specific exception

IOException - General IO exception

ping

public com.basistech.rosette.apimodel.PingResponse ping()
                                                 throws IOException,
HttpRosetteAPIException

Pings the Rosette API for a response indicating that the service is available.

Returns:

PingResponse

Throws:

HttpRosetteAPIException - Rosette specific exception

IOException - General IO exception

getSupportedLanguages

public com.basistech.rosette.apimodel.SupportedLanguagesResponse getSupportedLanguages(String endpoint)
                                                                                throws HttpRosetteAPIException

Gets the set of language and script codes supported by the specified Rosette API endpoint.

Specified by:

getSupportedLanguages in class AbstractRosetteAPI

Parameters:

endpoint - Rosette API endpoint.

Returns:

SupportedLanguagesResponse

Throws:

HttpRosetteAPIException - for an error returned from the Rosette API.

getSupportedLanguagePairs

public com.basistech.rosette.apimodel.SupportedLanguagePairsResponse getSupportedLanguagePairs(String endpoint)
                                                                                        throws HttpRosetteAPIException

Gets the set of language, script codes and transliteration scheme pairs supported by the specified Rosette API endpoint.

Specified by:

getSupportedLanguagePairs in class AbstractRosetteAPI

Parameters:

endpoint - Rosette API endpoint.

Returns:

SupportedLanguagePairsResponse

Throws:

HttpRosetteAPIException - for an error returned from the Rosette API.

perform

public <RequestType extends com.basistech.rosette.apimodel.Request,
ResponseType extends com.basistech.rosette.apimodel.Response>
ResponseType perform(String endpoint,
 RequestType request,
 Class<ResponseType> responseClass)
              throws HttpRosetteAPIException

Description copied from class: AbstractRosetteAPI

Perform a request to an endpoint of the Rosette API.

Specified by:

perform in class AbstractRosetteAPI

Type Parameters:

RequestType - the type of the request object.

ResponseType - the type of the response object.

Parameters:

endpoint - which endpoint.

request - the data for the request.

responseClass - the Java Class object for the response object.

Returns:

the response.

Throws:

HttpRosetteAPIException - for an error returned from the Rosette API.

com.basistech.rosette.RosetteRuntimeException - for other errors, such as communications problems with HTTP.

perform

public <RequestType extends com.basistech.rosette.apimodel.Request>
com.basistech.rosette.dm.AnnotatedText perform(String endpoint,
 RequestType request)
                                        throws HttpRosetteAPIException

Description copied from class: AbstractRosetteAPI

Perform a request to an endpoint of the Rosette API.

Specified by:

perform in class AbstractRosetteAPI

Type Parameters:

RequestType - the type of the request object.

Parameters:

endpoint - which endpoint.

request - the data for the request.

Returns:

the response, AnnotatedText.

Throws:

HttpRosetteAPIException - for an error returned from the Rosette API.

com.basistech.rosette.RosetteRuntimeException - for other errors, such as communications problems with HTTP.

performAsync

public <RequestType extends com.basistech.rosette.apimodel.Request,
ResponseType extends com.basistech.rosette.apimodel.Response>
Future<ResponseType> performAsync(String endpoint,
 RequestType request,
 Class<ResponseType> responseClass)
                           throws HttpRosetteAPIException

This method always throws UnsupportedOperationException.

Specified by:

performAsync in class AbstractRosetteAPI

Type Parameters:

RequestType - The class of the request object for this endpoint.

ResponseType - the class of the response object for this endpoint.

Parameters:

endpoint - which endpoint.

request - the data for the request.

responseClass - the Java Class object for the response object.

Returns:

a Future for the response.

Throws:

HttpRosetteAPIException

createRosetteRequest

public RosetteRequest createRosetteRequest(String endpoint,
 com.basistech.rosette.apimodel.Request request,
 Class<? extends com.basistech.rosette.apimodel.Response> responseClass)

Creates a RosetteRequest which can be sent concurrently through this HttpRosetteAPI

Parameters:

endpoint - the endpoint to which the request is sent to

request - the request object

responseClass - Response's class

Returns:

RosetteRequest which when started sends the predefined request through this http client

close

public void close()
           throws IOException

Throws:

IOException