io.ably.lib.http

Class BasePaginatedQuery<T>

java.lang.Object

io.ably.lib.http.BasePaginatedQuery<T>

Type Parameters:

T -

All Implemented Interfaces:

HttpCore.ResponseHandler<BasePaginatedResult<T>>

public class BasePaginatedQuery<T>
extends java.lang.Object
implements HttpCore.ResponseHandler<BasePaginatedResult<T>>

A paginated query base implementation that can be used sync or asynchronously.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BasePaginatedQuery.ResultRequest<T> Wraps a Http.Request> to fixate on either a sync or an async interface.

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.util.regex.Pattern	linkPattern internal
protected static java.util.regex.Pattern	urlPattern

Constructor Summary

Constructors

Constructor and Description
BasePaginatedQuery(Http http, java.lang.String path, Param[] headers, Param[] params, HttpCore.BodyHandler<T> bodyHandler) Construct a PaginatedQuery
BasePaginatedQuery(Http http, java.lang.String path, Param[] headers, Param[] params, HttpCore.RequestBody requestBody, HttpCore.BodyHandler<T> bodyHandler) Construct a PaginatedQuery

Method Summary

Modifier and Type	Method and Description
Http.Request<BasePaginatedResult<T>>	exec(java.lang.String method) Get the result of the first query
BasePaginatedQuery.ResultRequest<T>	get() Get the result of the first query
BasePaginatedResult<T>	handleResponse(HttpCore.Response response, ErrorInfo error)
protected static java.util.HashMap<java.lang.String,java.lang.String>	parseLinks(java.util.Collection<java.lang.String> linkHeaders)

Methods inherited from class java.lang.Object

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

Field Detail

linkPattern

protected static java.util.regex.Pattern linkPattern

internal

urlPattern

protected static java.util.regex.Pattern urlPattern

Constructor Detail

BasePaginatedQuery

public BasePaginatedQuery(Http http,
                          java.lang.String path,
                          Param[] headers,
                          Param[] params,
                          HttpCore.BodyHandler<T> bodyHandler)

Construct a PaginatedQuery

Parameters:

http - the http instance

path - the path of the resource being queried

headers - headers to pass into the first and all relative queries

params - params to pass into the initial query

bodyHandler - handler to parse response bodies for first and all relative queries

BasePaginatedQuery

public BasePaginatedQuery(Http http,
                          java.lang.String path,
                          Param[] headers,
                          Param[] params,
                          HttpCore.RequestBody requestBody,
                          HttpCore.BodyHandler<T> bodyHandler)

Construct a PaginatedQuery

Parameters:

http - the http instance

path - the path of the resource being queried

headers - headers to pass into the first and all relative queries

params - params to pass into the initial query

bodyHandler - handler to parse response bodies for first and all relative queries

Method Detail

get

public BasePaginatedQuery.ResultRequest<T> get()

Get the result of the first query

Returns:

A ResultRequest giving the first page of results together with any available links to related results pages.

exec

public Http.Request<BasePaginatedResult<T>> exec(java.lang.String method)

Get the result of the first query

Returns:

A Http.Request> giving the first page of results together with any available links to related results pages.

handleResponse

public BasePaginatedResult<T> handleResponse(HttpCore.Response response,
                                             ErrorInfo error)
                                      throws AblyException

Specified by:

handleResponse in interface HttpCore.ResponseHandler<BasePaginatedResult<T>>

Throws:

AblyException

parseLinks

protected static java.util.HashMap<java.lang.String,java.lang.String> parseLinks(java.util.Collection<java.lang.String> linkHeaders)