com.ibasco.agql.core

Class AbstractRestClient

java.lang.Object

com.ibasco.agql.core.AbstractClient<AbstractWebRequest,AbstractWebResponse>

com.ibasco.agql.core.AbstractRestClient

All Implemented Interfaces:

Client, Closeable, AutoCloseable

Direct Known Subclasses:

CocWebApiClient, SteamWebApiClient

public abstract class AbstractRestClient
extends AbstractClient<AbstractWebRequest,AbstractWebResponse>

Abstract AbstractRestClient class.

Author:

Rafael Luis Ibasco

Constructor Summary

Constructors

Constructor and Description
AbstractRestClient() Some rest clients do not require authentication
AbstractRestClient(HttpOptions options) Create a new client using the provided HttpOptions
AbstractRestClient(String authToken) Constructor accepting a String representing the authentication token for the provider

Method Summary

Modifier and Type	Method and Description
protected void	applyAuthenticationScheme(org.asynchttpclient.RequestBuilder requestBuilder, String authToken) Override this method if the client requires authentication.
protected HttpMessenger	createMessenger(Options options) Factory method for Messenger.
protected abstract AbstractWebApiResponse	createWebApiResponse(org.asynchttpclient.Response response) A factory method that creates an AbstractWebApiResponse instance based on the Http Response
String	getAuthToken() Getter for the field authToken.
protected void	registerContentTypeProcessor(String contentType, ContentTypeProcessor processor) Register custom content processors based on the value defined in the Content-Type header
protected void	removeContentTypeProcessor(String contentType) removeContentTypeProcessor.
protected CompletableFuture<AbstractWebResponse>	send(AbstractWebRequest message) send.
void	setAuthToken(String authToken) Setter for the field authToken.

Methods inherited from class com.ibasco.agql.core.AbstractClient

close, getExecutor, getMessenger, getOptions, id, send, send

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractRestClient

public AbstractRestClient()

Some rest clients do not require authentication

AbstractRestClient

public AbstractRestClient(String authToken)

Constructor accepting a String representing the authentication token for the provider

Parameters:

authToken - A String containing the authentication token for the provider

AbstractRestClient

public AbstractRestClient(HttpOptions options)

Create a new client using the provided HttpOptions

Parameters:

options - The HttpOptions to be used by the client

Method Detail

registerContentTypeProcessor

protected void registerContentTypeProcessor(String contentType,
                                            ContentTypeProcessor processor)

Register custom content processors based on the value defined in the Content-Type header

Parameters:

contentType - A String Content-Type identifier

processor - The ContentTypeProcessor that will handle the response body conversion

createMessenger

protected HttpMessenger createMessenger(Options options)

Factory method for Messenger.

Factory method for creating the default HttpMessenger

Parameters:

options - a Options object

Returns:

a Messenger object

send

protected CompletableFuture<AbstractWebResponse> send(AbstractWebRequest message)

send.

Parameters:

message - a AbstractWebRequest object

Returns:

a CompletableFuture object

applyAuthenticationScheme

protected void applyAuthenticationScheme(org.asynchttpclient.RequestBuilder requestBuilder,
                                         String authToken)

Override this method if the client requires authentication.

Parameters:

requestBuilder - The RequestBuilder containing the request parameters of the concrete Request

authToken - A String representing the authetntication token to be passed to the provider

createWebApiResponse

protected abstract AbstractWebApiResponse createWebApiResponse(org.asynchttpclient.Response response)

A factory method that creates an AbstractWebApiResponse instance based on the Http Response

Parameters:

response - The Http Response received by the transport

Returns:

A Concrete implementation of AbstractWebApiResponse

removeContentTypeProcessor

protected void removeContentTypeProcessor(String contentType)

removeContentTypeProcessor.

Parameters:

contentType - a String object

getAuthToken

public String getAuthToken()

Getter for the field authToken.

Returns:

a String object

setAuthToken

public void setAuthToken(String authToken)

Setter for the field authToken.

Parameters:

authToken - a String object