com.spectralogic.ds3client.helpers.pagination

Interface PaginatingCommand<E,T extends AbstractPaginationRequest,F extends AbstractPaginationResponse>

Type Parameters:

E - The type the iterator will return.

T - The AbstractPaginationRequest that the command will invoke

F - The AbstractPaginationResponse that will be returned by the AbstractPaginationRequest

All Known Implementing Classes:

GetObjectsFullDetailsPaginatingCommand

public interface PaginatingCommand<E,T extends AbstractPaginationRequest,F extends AbstractPaginationResponse>

This interface is used to implement the call specific logic for any Spectra S3 paginated request.

Method Summary

Modifier and Type	Method and Description
T	createRequest() Creates an initial request.
java.util.List<E>	getResponseContents(F response) Parses the response into the correct payload to be consumed by the iterator
F	invokeCommand(T paginationRequest) Invokes the request and returns the response

Method Detail

createRequest

T createRequest()

Creates an initial request. This should not modify any of the pagination values for the request

invokeCommand

F invokeCommand(T paginationRequest)
         throws java.io.IOException

Invokes the request and returns the response

Throws:

java.io.IOException

getResponseContents

java.util.List<E> getResponseContents(F response)

Parses the response into the correct payload to be consumed by the iterator