io.ably.lib.http

Class PaginatedQuery<T>

java.lang.Object

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

Type Parameters:

T - the body response type.

All Implemented Interfaces:

Http.ResponseHandler<PaginatedResult<T>>

public class PaginatedQuery<T>
extends java.lang.Object
implements Http.ResponseHandler<PaginatedResult<T>>

An object that encapsulates parameters of a REST query with a paginated response

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	PaginatedQuery.ResultPage A private class encapsulating the result of a single page response

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
PaginatedQuery(Http http, java.lang.String path, Param[] headers, Param[] params, Http.BodyHandler<T> bodyHandler) Construct a PaginatedQuery
PaginatedQuery(Http http, java.lang.String path, Param[] headers, Param[] params, Http.RequestBody requestBody, Http.BodyHandler<T> bodyHandler) Construct a PaginatedQuery

Method Summary

Modifier and Type	Method and Description
PaginatedResult<T>	exec(java.lang.String method) Get the result of the first query
PaginatedResult<T>	get() Get the result of the first query
PaginatedResult<T>	handleResponse(Http.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

PaginatedQuery

public PaginatedQuery(Http http,
                      java.lang.String path,
                      Param[] headers,
                      Param[] params,
                      Http.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

PaginatedQuery

public PaginatedQuery(Http http,
                      java.lang.String path,
                      Param[] headers,
                      Param[] params,
                      Http.RequestBody requestBody,
                      Http.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 PaginatedResult<T> get()
                       throws AblyException

Get the result of the first query

Returns:

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

Throws:

AblyException

exec

public PaginatedResult<T> exec(java.lang.String method)
                        throws AblyException

Get the result of the first query

Returns:

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

Throws:

AblyException

handleResponse

public PaginatedResult<T> handleResponse(Http.Response response,
                                         ErrorInfo error)
                                  throws AblyException

Specified by:

handleResponse in interface Http.ResponseHandler<PaginatedResult<T>>

Throws:

AblyException

parseLinks

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