Package io.ably.lib.http

Class HttpCore

java.lang.Object

io.ably.lib.http.HttpCore

public class HttpCore
extends Object

HttpCore performs authenticated HTTP synchronously. Internal; use Http or HttpScheduler instead.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	HttpCore.AuthRequiredException	Exception signifying that an httpCore request failed with a WWW-Authenticate response
static interface	HttpCore.BodyHandler<T>	Interface for an entity that performs type-specific processing on an httpCore response body
static interface	HttpCore.RequestBody	Interface for an entity that supplies an httpCore request body
static class	HttpCore.Response	A type encapsulating an httpCore response
static interface	HttpCore.ResponseHandler<T>	Interface for an entity that performs type-specific processing on an httpCore response

Field Summary

Fields

Modifier and Type	Field	Description
final int	port
final String	scheme

Constructor Summary

Constructors

Constructor	Description
HttpCore(ClientOptions options, Auth auth, PlatformAgentProvider platformAgentProvider)	Public API

Method Summary

Modifier and Type	Method	Description
String	getPreferredHost()	Gets host for this HTTP client
String	getPrimaryHost()	Gets host for this HTTP client
<T> T	httpExecute(URL url, String method, Param[] headers, HttpCore.RequestBody requestBody, boolean withCredentials, HttpCore.ResponseHandler<T> responseHandler)	Make a synchronous HTTP request specified by URL and proxy
<T> T	httpExecuteWithRetry(URL url, String method, Param[] headers, HttpCore.RequestBody requestBody, HttpCore.ResponseHandler<T> responseHandler, boolean requireAblyAuth)	Make a synchronous HTTP request specified by URL and proxy, retrying if necessary on WWW-Authenticate
HttpCore	injectDynamicAgents(Map<String,String> wrapperSDKAgents)	[Internal Method]
void	setPreferredHost(String host)	Sets host for this HTTP client

Methods inherited from class java.lang.Object

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

Field Details

scheme

public final String scheme

port

public final int port

Constructor Details

HttpCore

public HttpCore(ClientOptions options,
 Auth auth,
 PlatformAgentProvider platformAgentProvider)
         throws AblyException

Public API

Throws:

AblyException

Method Details

httpExecuteWithRetry

public <T> T httpExecuteWithRetry(URL url,
 String method,
 Param[] headers,
 HttpCore.RequestBody requestBody,
 HttpCore.ResponseHandler<T> responseHandler,
 boolean requireAblyAuth)
                           throws AblyException

Make a synchronous HTTP request specified by URL and proxy, retrying if necessary on WWW-Authenticate

Parameters:

url -

method -

headers -

requestBody -

responseHandler -

Returns:

Throws:

AblyException

getPreferredHost

public String getPreferredHost()

Gets host for this HTTP client

Returns:

setPreferredHost

public void setPreferredHost(String host)

Sets host for this HTTP client

Parameters:

host - URL string

getPrimaryHost

public String getPrimaryHost()

Gets host for this HTTP client

Returns:

httpExecute

public <T> T httpExecute(URL url,
 String method,
 Param[] headers,
 HttpCore.RequestBody requestBody,
 boolean withCredentials,
 HttpCore.ResponseHandler<T> responseHandler)
                  throws AblyException

Make a synchronous HTTP request specified by URL and proxy

Parameters:

url -

method -

headers -

requestBody -

withCredentials -

responseHandler -

Returns:

Throws:

AblyException

injectDynamicAgents

public HttpCore injectDynamicAgents(Map<String,String> wrapperSDKAgents)

[Internal Method]

We use this method to implement proxy Realtime / Rest clients that add additional agents to the underlying client.