io.ably.lib.http

Class Http

java.lang.Object

io.ably.lib.http.Http

public class Http
extends java.lang.Object

Http Support class for HTTP REST operations supporting host fallback in the case of host unavailability and authentication. Internal

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Http.AuthRequiredException Exception signifying that an http request failed with a WWW-Authenticate response
static interface	Http.BodyHandler<T> Interface for an entity that performs type-specific processing on an http response body
static class	Http.ByteArrayRequestBody A RequestBody wrapping a byte array
static class	Http.FormRequestBody
static class	Http.JsonRequestBody A RequestBody wrapping a JSON-serialisable object
static interface	Http.RequestBody Interface for an entity that supplies an http request body
static class	Http.Response A type encapsulating an http response
static interface	Http.ResponseHandler<T> Interface for an entity that performs type-specific processing on an http response

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DELETE
static java.lang.String	GET
static java.lang.String	POST
static java.lang.String	PUT

Constructor Summary

Constructors

Constructor and Description
Http(ClientOptions options, Auth auth) Public API

Method Summary

Modifier and Type	Method and Description
<T> T	ablyHttpExecute(java.lang.String path, java.lang.String method, Param[] headers, Param[] params, Http.RequestBody requestBody, Http.ResponseHandler<T> responseHandler) Make a synchronous HTTP request to an Ably endpoint, using the Ably auth credentials and fallback hosts if necessary
<T> T	del(java.lang.String path, Param[] headers, Param[] params, Http.ResponseHandler<T> responseHandler) HTTP DEL for Ably host, with fallbacks
<T> T	exec(java.lang.String path, java.lang.String method, Param[] headers, Param[] params, Http.RequestBody requestBody, Http.ResponseHandler<T> responseHandler) HTTP request for Ably host, with fallbacks
void	finalize()
<T> T	get(java.lang.String path, Param[] headers, Param[] params, Http.ResponseHandler<T> responseHandler) HTTP GET for Ably host, with fallbacks
java.lang.String	getHost() Gets host for this HTTP client
<T> T	getUri(java.lang.String uri, Param[] headers, Param[] params, Http.ResponseHandler<T> responseHandler) HTTP GET for non-Ably host
byte[]	getUrl(java.lang.String url) Simple HTTP GET; no auth, headers, returning response body as byte[]
java.lang.String	getUrlString(java.lang.String url) Simple HTTP GET; no auth, headers, returning response body as string
<T> T	httpExecute(java.net.URL url, java.net.Proxy proxy, java.lang.String method, Param[] headers, Http.RequestBody requestBody, boolean withCredentials, Http.ResponseHandler<T> responseHandler) Make a synchronous HTTP request specified by URL and proxy
<T> T	httpExecute(java.net.URL url, java.lang.String method, Param[] headers, Http.RequestBody requestBody, Http.ResponseHandler<T> responseHandler) Make a synchronous HTTP request to non-Ably endpoint, specified by URL and using the configured proxy, if any
<T> T	httpExecuteWithRetry(java.net.URL url, java.lang.String method, Param[] headers, Http.RequestBody requestBody, Http.ResponseHandler<T> responseHandler, boolean allowAblyAuth) Make a synchronous HTTP request specified by URL and proxy, retrying if necessary on WWW-Authenticate
<T> T	post(java.lang.String path, Param[] headers, Param[] params, Http.RequestBody requestBody, Http.ResponseHandler<T> responseHandler) HTTP POST for Ably host, with fallbacks
<T> T	postUri(java.lang.String uri, Param[] headers, Param[] params, Http.ResponseHandler<T> responseHandler) HTTP POST with data in form encoding for non-Ably host
<T> T	put(java.lang.String path, Param[] headers, Param[] params, Http.RequestBody requestBody, Http.ResponseHandler<T> responseHandler) HTTP PUT for Ably host, with fallbacks
void	setHost(java.lang.String host) Sets host for this HTTP client

Methods inherited from class java.lang.Object

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

Field Detail

GET

public static final java.lang.String GET

See Also:

Constant Field Values

PUT

public static final java.lang.String PUT

See Also:

Constant Field Values

POST

public static final java.lang.String POST

See Also:

Constant Field Values

DELETE

public static final java.lang.String DELETE

See Also:

Constant Field Values

Constructor Detail

Http

public Http(ClientOptions options,
            Auth auth)
     throws AblyException

Public API

Throws:

AblyException

Method Detail

setHost

public void setHost(java.lang.String host)

Sets host for this HTTP client

Parameters:

host - URL string

getHost

public java.lang.String getHost()

Gets host for this HTTP client

Returns:

getUrlString

public java.lang.String getUrlString(java.lang.String url)
                              throws AblyException

Simple HTTP GET; no auth, headers, returning response body as string

Parameters:

url -

Returns:

Throws:

AblyException

getUrl

public byte[] getUrl(java.lang.String url)
              throws AblyException

Simple HTTP GET; no auth, headers, returning response body as byte[]

Parameters:

url -

Returns:

Throws:

AblyException

getUri

public <T> T getUri(java.lang.String uri,
                    Param[] headers,
                    Param[] params,
                    Http.ResponseHandler<T> responseHandler)
             throws AblyException

HTTP GET for non-Ably host

Parameters:

uri -

headers -

params -

responseHandler -

Returns:

Throws:

AblyException

get

public <T> T get(java.lang.String path,
                 Param[] headers,
                 Param[] params,
                 Http.ResponseHandler<T> responseHandler)
          throws AblyException

HTTP GET for Ably host, with fallbacks

Parameters:

path -

headers -

params -

responseHandler -

Returns:

Throws:

AblyException

put

public <T> T put(java.lang.String path,
                 Param[] headers,
                 Param[] params,
                 Http.RequestBody requestBody,
                 Http.ResponseHandler<T> responseHandler)
          throws AblyException

HTTP PUT for Ably host, with fallbacks

Parameters:

path -

headers -

params -

requestBody -

responseHandler -

Returns:

Throws:

AblyException

postUri

public <T> T postUri(java.lang.String uri,
                     Param[] headers,
                     Param[] params,
                     Http.ResponseHandler<T> responseHandler)
              throws AblyException

HTTP POST with data in form encoding for non-Ably host

Parameters:

uri -

headers -

params -

responseHandler -

Returns:

Throws:

AblyException

post

public <T> T post(java.lang.String path,
                  Param[] headers,
                  Param[] params,
                  Http.RequestBody requestBody,
                  Http.ResponseHandler<T> responseHandler)
           throws AblyException

HTTP POST for Ably host, with fallbacks

Parameters:

path -

headers -

params -

requestBody -

responseHandler -

Returns:

Throws:

AblyException

del

public <T> T del(java.lang.String path,
                 Param[] headers,
                 Param[] params,
                 Http.ResponseHandler<T> responseHandler)
          throws AblyException

HTTP DEL for Ably host, with fallbacks

Parameters:

path -

headers -

params -

responseHandler -

Returns:

Throws:

AblyException

exec

public <T> T exec(java.lang.String path,
                  java.lang.String method,
                  Param[] headers,
                  Param[] params,
                  Http.RequestBody requestBody,
                  Http.ResponseHandler<T> responseHandler)
           throws AblyException

HTTP request for Ably host, with fallbacks

Parameters:

path -

method -

headers -

params -

requestBody -

responseHandler -

Returns:

Throws:

AblyException

finalize

public void finalize()

Overrides:

finalize in class java.lang.Object

ablyHttpExecute

public <T> T ablyHttpExecute(java.lang.String path,
                             java.lang.String method,
                             Param[] headers,
                             Param[] params,
                             Http.RequestBody requestBody,
                             Http.ResponseHandler<T> responseHandler)
                      throws AblyException

Make a synchronous HTTP request to an Ably endpoint, using the Ably auth credentials and fallback hosts if necessary

Parameters:

path -

method -

headers -

params -

requestBody -

responseHandler -

Returns:

Throws:

AblyException

httpExecute

public <T> T httpExecute(java.net.URL url,
                         java.lang.String method,
                         Param[] headers,
                         Http.RequestBody requestBody,
                         Http.ResponseHandler<T> responseHandler)
                  throws AblyException

Make a synchronous HTTP request to non-Ably endpoint, specified by URL and using the configured proxy, if any

Parameters:

url -

method -

headers -

requestBody -

withCredentials -

responseHandler -

Returns:

Throws:

AblyException

httpExecute

public <T> T httpExecute(java.net.URL url,
                         java.net.Proxy proxy,
                         java.lang.String method,
                         Param[] headers,
                         Http.RequestBody requestBody,
                         boolean withCredentials,
                         Http.ResponseHandler<T> responseHandler)
                  throws AblyException

Make a synchronous HTTP request specified by URL and proxy

Parameters:

url -

proxy -

method -

headers -

requestBody -

withCredentials -

responseHandler -

Returns:

Throws:

AblyException

httpExecuteWithRetry

public <T> T httpExecuteWithRetry(java.net.URL url,
                                  java.lang.String method,
                                  Param[] headers,
                                  Http.RequestBody requestBody,
                                  Http.ResponseHandler<T> responseHandler,
                                  boolean allowAblyAuth)
                           throws AblyException

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

Parameters:

url -

proxy -

method -

headers -

requestBody -

responseHandler -

Returns:

Throws:

AblyException