fr.gouv.vitam.common.external.client

Class VitamRequestIterator<T>

java.lang.Object

fr.gouv.vitam.common.external.client.VitamRequestIterator<T>

All Implemented Interfaces:

VitamAutoCloseable, AutoCloseable, Iterator<T>

public class VitamRequestIterator<T>
extends Object
implements VitamAutoCloseable, Iterator<T>

Utility to help with Http based Cursor that implements real Database Cursor on server side

Constructor Summary

Constructors

Constructor and Description
VitamRequestIterator(MockOrRestClient client, String method, String path, Class<T> responseType, javax.ws.rs.core.MultivaluedHashMap<String,Object> headers, com.fasterxml.jackson.databind.JsonNode request) Constructor Note: if of type AbstractMockClient or derived, request will be the returned unique result.

Method Summary

Modifier and Type	Method and Description
void	close()
static String	getCursorId(javax.ws.rs.core.HttpHeaders headers) Helper for server side to get the cursor Id
boolean	hasNext()
static boolean	isEndOfCursor(boolean xcursor, String xcursorId) Helper for server side to check if this is a ending of cursor
static boolean	isEndOfCursor(javax.ws.rs.core.HttpHeaders headers) Helper for server side to check if this is a end of cursor
static boolean	isNewCursor(boolean xcursor, String xcursorId) Helper for server side to check if this is a creation of cursor
static boolean	isNewCursor(javax.ws.rs.core.HttpHeaders headers) Helper for server side to check if this is a creation of cursor
T	next()
static javax.ws.rs.core.Response.ResponseBuilder	setHeaders(javax.ws.rs.core.Response.ResponseBuilder builder, boolean active, String xcursorId) Helper for server and client to set the needed headers

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Iterator

forEachRemaining, remove

Constructor Detail

VitamRequestIterator

public VitamRequestIterator(MockOrRestClient client,
                            String method,
                            String path,
                            Class<T> responseType,
                            javax.ws.rs.core.MultivaluedHashMap<String,Object> headers,
                            com.fasterxml.jackson.databind.JsonNode request)

Constructor

Note: if of type AbstractMockClient or derived, request will be the returned unique result.

Parameters:

client - the client to use

method - the method to use

path - the path to use

responseType - the type of the response to be returned

headers - the headers to use, could be null

request - the request to use, could be null

Throws:

IllegalArgumentException - if one of mandatory arguments is null or empty

Method Detail

close

public void close()

Specified by:

close in interface VitamAutoCloseable

Specified by:

close in interface AutoCloseable

hasNext

public boolean hasNext()

Specified by:

hasNext in interface Iterator<T>

Returns:

true if there is a next element

Throws:

javax.ws.rs.BadRequestException - (RuntimeException) if the request is in error

next

public T next()

Specified by:

next in interface Iterator<T>

isEndOfCursor

public static boolean isEndOfCursor(javax.ws.rs.core.HttpHeaders headers)

Helper for server side to check if this is a end of cursor

Parameters:

headers -

Returns:

True if the cursor is to be ended on Server side

Throws:

IllegalStateException - if the headers are not consistent

isEndOfCursor

public static boolean isEndOfCursor(boolean xcursor,
                                    String xcursorId)

Helper for server side to check if this is a ending of cursor

Parameters:

xcursor -

xcursorId -

Returns:

True if the cursor is to be ended on Server side

isNewCursor

public static boolean isNewCursor(javax.ws.rs.core.HttpHeaders headers)

Helper for server side to check if this is a creation of cursor

Parameters:

headers -

Returns:

True if the cursor is to be created on Server side

Throws:

IllegalStateException - if the headers are not consistent

isNewCursor

public static boolean isNewCursor(boolean xcursor,
                                  String xcursorId)

Helper for server side to check if this is a creation of cursor

Parameters:

xcursor -

xcursorId -

Returns:

True if the cursor is to be created on Server side

getCursorId

public static String getCursorId(javax.ws.rs.core.HttpHeaders headers)

Helper for server side to get the cursor Id

Parameters:

headers -

Returns:

the X-Cursor-ID content

setHeaders

public static javax.ws.rs.core.Response.ResponseBuilder setHeaders(javax.ws.rs.core.Response.ResponseBuilder builder,
                                                                   boolean active,
                                                                   String xcursorId)

Helper for server and client to set the needed headers

Parameters:

builder - the current ResponseBuilder

active - True for create or continue, False for inactive (X-Cursor)

xcursorId - may be null, else contains the current X-Cursor-Id

Returns:

the ResponseBuilder with the new required header