fr.gouv.vitam.batch.report.client

Class BatchReportClientRest

java.lang.Object

fr.gouv.vitam.common.external.client.DefaultClient

fr.gouv.vitam.batch.report.client.BatchReportClientRest

All Implemented Interfaces:

BatchReportClient, MockOrRestClient, BasicClient, VitamAutoCloseable, AutoCloseable

public class BatchReportClientRest
extends DefaultClient
implements BatchReportClient

BatchReportClientRest

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	INTERNAL_SERVER_ERROR

Fields inherited from interface fr.gouv.vitam.common.external.client.BasicClient

STATUS_URL

Constructor Summary

Constructors

Constructor and Description
BatchReportClientRest(VitamClientFactoryInterface<?> factory) Constructor using given scheme (http)

Method Summary

Modifier and Type	Method and Description
RequestResponse<com.fasterxml.jackson.databind.JsonNode>	appendReportEntries(ReportBody reportBody) Append report entries
void	checkStatus() Check the status from the service
void	checkStatus(javax.ws.rs.core.MultivaluedHashMap<String,Object> headers) Check the status from the service used to passe "X-SSL-CLIENT-CERT" header that contain a pem certificate
RequestResponse<com.fasterxml.jackson.databind.JsonNode>	cleanupReport(String processId, ReportType reportType) Clean all entries with the given process Id tenant and reportType
void	close() Close the underneath http client
void	consumeAnyEntityAndClose(javax.ws.rs.core.Response response) Helper when an error occurs on client usage side to consume response however
protected VitamClientException	createExceptionFromResponse(javax.ws.rs.core.Response response) Handle all errors and throw a VitamClientException in case the response does not contains a vitamError type result.
RequestResponse<com.fasterxml.jackson.databind.JsonNode>	generateEliminationActionAccessionRegisterReport(String processId, ReportExportRequest reportExportRequest) Generate elimination action accession register for deleted units by status and process Id.
RequestResponse<com.fasterxml.jackson.databind.JsonNode>	generateEliminationActionDistinctObjectGroupInUnitReport(String processId, ReportExportRequest reportExportRequest) Generate elimination action district object groups for units by status and process Id.
RequestResponse<com.fasterxml.jackson.databind.JsonNode>	generateEliminationActionObjectGroupReport(String processId, ReportExportRequest reportExportRequest) Generate elimination action object group report for the specified process Id Report is stored in JSONL format in workspace.
RequestResponse<com.fasterxml.jackson.databind.JsonNode>	generateEliminationActionUnitReport(String processId, ReportExportRequest reportExportRequest) Generate elimination action unit report for the specified process Id Report is stored in JSONL format in workspace.
protected javax.ws.rs.client.Client	getClient(boolean chunked)
String	getResourcePath() Get the resource path of the server.
String	getServiceUrl() Get the service URL
VitamClientFactory<?>	getVitamClientFactory()
protected Future<javax.ws.rs.core.Response>	performAsyncRequest(String httpMethod, String path, javax.ws.rs.core.MultivaluedHashMap<String,Object> headers, Object body, javax.ws.rs.core.MediaType contentType, javax.ws.rs.core.MediaType accept) Perform an Async HTTP request to the server with full control of action on caller
protected <T> Future<T>	performAsyncRequest(String httpMethod, String path, javax.ws.rs.core.MultivaluedHashMap<String,Object> headers, Object body, javax.ws.rs.core.MediaType contentType, javax.ws.rs.core.MediaType accept, javax.ws.rs.client.InvocationCallback<T> callback) Perform an Async HTTP request to the server with callback
protected javax.ws.rs.core.Response	performRequest(String httpMethod, String path, javax.ws.rs.core.MultivaluedMap<String,Object> headers, javax.ws.rs.core.MediaType accept) Perform a HTTP request to the server for synchronous call
protected javax.ws.rs.core.Response	performRequest(String httpMethod, String path, javax.ws.rs.core.MultivaluedMap<String,Object> headers, Object body, javax.ws.rs.core.MediaType contentType, javax.ws.rs.core.MediaType accept) Perform a HTTP request to the server for synchronous call
protected javax.ws.rs.core.Response	performRequest(String httpMethod, String path, javax.ws.rs.core.MultivaluedMap<String,Object> headers, Object body, javax.ws.rs.core.MediaType contentType, javax.ws.rs.core.MediaType accept, boolean chunkedMode) Perform a HTTP request to the server for synchronous call
static void	staticConsumeAnyEntityAndClose(javax.ws.rs.core.Response response) This method consume everything (in particular InpuStream) and close the response.
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface fr.gouv.vitam.common.client.MockOrRestClient

checkStatus, checkStatus, close, consumeAnyEntityAndClose, getResourcePath, getServiceUrl

Field Detail

INTERNAL_SERVER_ERROR

protected static final String INTERNAL_SERVER_ERROR

See Also:

Constant Field Values

Constructor Detail

BatchReportClientRest

public BatchReportClientRest(VitamClientFactoryInterface<?> factory)

Constructor using given scheme (http)

Parameters:

factory - The client factory

Method Detail

generateEliminationActionUnitReport

public RequestResponse<com.fasterxml.jackson.databind.JsonNode> generateEliminationActionUnitReport(String processId,
                                                                                                    ReportExportRequest reportExportRequest)
                                                                                             throws VitamClientInternalException

Description copied from interface: BatchReportClient

Generate elimination action unit report for the specified process Id Report is stored in JSONL format in workspace.

Specified by:

generateEliminationActionUnitReport in interface BatchReportClient

Parameters:

processId - the given process Id to aggregate

reportExportRequest - report export request

Returns:

RequestResponse

Throws:

VitamClientInternalException - VitamClientInternalException

generateEliminationActionObjectGroupReport

public RequestResponse<com.fasterxml.jackson.databind.JsonNode> generateEliminationActionObjectGroupReport(String processId,
                                                                                                           ReportExportRequest reportExportRequest)
                                                                                                    throws VitamClientInternalException

Description copied from interface: BatchReportClient

Generate elimination action object group report for the specified process Id Report is stored in JSONL format in workspace.

Specified by:

generateEliminationActionObjectGroupReport in interface BatchReportClient

Parameters:

processId - processId

reportExportRequest - report export request

Returns:

RequestResponse

Throws:

VitamClientInternalException - VitamClientInternalException

generateEliminationActionDistinctObjectGroupInUnitReport

public RequestResponse<com.fasterxml.jackson.databind.JsonNode> generateEliminationActionDistinctObjectGroupInUnitReport(String processId,
                                                                                                                         ReportExportRequest reportExportRequest)
                                                                                                                  throws VitamClientInternalException

Description copied from interface: BatchReportClient

Generate elimination action district object groups for units by status and process Id. Report is stored in JSONL format in workspace.

Specified by:

generateEliminationActionDistinctObjectGroupInUnitReport in interface BatchReportClient

reportExportRequest - report export request

Returns:

Throws:

VitamClientInternalException

appendReportEntries

public RequestResponse<com.fasterxml.jackson.databind.JsonNode> appendReportEntries(ReportBody reportBody)
                                                                             throws VitamClientInternalException

Description copied from interface: BatchReportClient

Append report entries

Specified by:

appendReportEntries in interface BatchReportClient

Parameters:

reportBody - the given entry document.

Returns:

RequestResponse

Throws:

VitamClientInternalException

generateEliminationActionAccessionRegisterReport

public RequestResponse<com.fasterxml.jackson.databind.JsonNode> generateEliminationActionAccessionRegisterReport(String processId,
                                                                                                                 ReportExportRequest reportExportRequest)
                                                                                                          throws VitamClientInternalException

Description copied from interface: BatchReportClient

Generate elimination action accession register for deleted units by status and process Id. Report is stored in JSONL format in workspace ORDERED BY opi.

Specified by:

generateEliminationActionAccessionRegisterReport in interface BatchReportClient

reportExportRequest - report export request

Returns:

Throws:

VitamClientInternalException

cleanupReport

public RequestResponse<com.fasterxml.jackson.databind.JsonNode> cleanupReport(String processId,
                                                                              ReportType reportType)
                                                                       throws VitamClientInternalException

Description copied from interface: BatchReportClient

Clean all entries with the given process Id tenant and reportType

Specified by:

cleanupReport in interface BatchReportClient

Parameters:

processId - the given process Id

reportType - report type

Returns:

RequestResponse

Throws:

VitamClientInternalException

getClient

protected javax.ws.rs.client.Client getClient(boolean chunked)
                                       throws IllegalStateException

Throws:

IllegalStateException

consumeAnyEntityAndClose

public final void consumeAnyEntityAndClose(javax.ws.rs.core.Response response)

Description copied from interface: MockOrRestClient

Helper when an error occurs on client usage side to consume response however

Specified by:

consumeAnyEntityAndClose in interface MockOrRestClient

staticConsumeAnyEntityAndClose

public static final void staticConsumeAnyEntityAndClose(javax.ws.rs.core.Response response)

This method consume everything (in particular InpuStream) and close the response.

Parameters:

response -

checkStatus

public void checkStatus()
                 throws VitamApplicationServerException

Description copied from interface: MockOrRestClient

Check the status from the service

Specified by:

checkStatus in interface MockOrRestClient

Throws:

VitamApplicationServerException - if the Server is unavailable

checkStatus

public void checkStatus(javax.ws.rs.core.MultivaluedHashMap<String,Object> headers)
                 throws VitamApplicationServerException

Description copied from interface: MockOrRestClient

Check the status from the service used to passe "X-SSL-CLIENT-CERT" header that contain a pem certificate

Specified by:

checkStatus in interface MockOrRestClient

Throws:

VitamApplicationServerException - if the Server is unavailable

performRequest

protected javax.ws.rs.core.Response performRequest(String httpMethod,
                                                   String path,
                                                   javax.ws.rs.core.MultivaluedMap<String,Object> headers,
                                                   javax.ws.rs.core.MediaType accept)
                                            throws VitamClientInternalException

Perform a HTTP request to the server for synchronous call

Parameters:

httpMethod - HTTP method to use for request

path - URL to request

headers - headers HTTP to add to request, may be null

accept - asked type of response

Returns:

the response from the server

Throws:

VitamClientInternalException

performRequest

protected javax.ws.rs.core.Response performRequest(String httpMethod,
                                                   String path,
                                                   javax.ws.rs.core.MultivaluedMap<String,Object> headers,
                                                   Object body,
                                                   javax.ws.rs.core.MediaType contentType,
                                                   javax.ws.rs.core.MediaType accept)
                                            throws VitamClientInternalException

Perform a HTTP request to the server for synchronous call

Parameters:

httpMethod - HTTP method to use for request

path - URL to request

headers - headers HTTP to add to request, may be null

body - body content of type contentType, may be null

contentType - the media type of the body to send, null if body is null

accept - asked type of response

Returns:

the response from the server

Throws:

VitamClientInternalException

performRequest

protected javax.ws.rs.core.Response performRequest(String httpMethod,
                                                   String path,
                                                   javax.ws.rs.core.MultivaluedMap<String,Object> headers,
                                                   Object body,
                                                   javax.ws.rs.core.MediaType contentType,
                                                   javax.ws.rs.core.MediaType accept,
                                                   boolean chunkedMode)
                                            throws VitamClientInternalException

Perform a HTTP request to the server for synchronous call

Parameters:

httpMethod - HTTP method to use for request

path - URL to request

headers - headers HTTP to add to request, may be null

body - body content of type contentType, may be null

contentType - the media type of the body to send, null if body is null

accept - asked type of response

chunkedMode - True use default client, else False use non Chunked mode client

Returns:

the response from the server

Throws:

VitamClientInternalException

performAsyncRequest

protected <T> Future<T> performAsyncRequest(String httpMethod,
                                            String path,
                                            javax.ws.rs.core.MultivaluedHashMap<String,Object> headers,
                                            Object body,
                                            javax.ws.rs.core.MediaType contentType,
                                            javax.ws.rs.core.MediaType accept,
                                            javax.ws.rs.client.InvocationCallback<T> callback)
                                     throws VitamClientInternalException

Perform an Async HTTP request to the server with callback

Type Parameters:

T - the type of the Future result (generally Response)

Parameters:

httpMethod - HTTP method to use for request

path - URL to request

headers - headers HTTP to add to request, may be null

body - body content of type contentType, may be null

contentType - the media type of the body to send, null if body is null

accept - asked type of response

callback -

Returns:

the response from the server as Future

Throws:

VitamClientInternalException

performAsyncRequest

protected Future<javax.ws.rs.core.Response> performAsyncRequest(String httpMethod,
                                                                String path,
                                                                javax.ws.rs.core.MultivaluedHashMap<String,Object> headers,
                                                                Object body,
                                                                javax.ws.rs.core.MediaType contentType,
                                                                javax.ws.rs.core.MediaType accept)
                                                         throws VitamClientInternalException

Perform an Async HTTP request to the server with full control of action on caller

Parameters:

httpMethod - HTTP method to use for request

path - URL to request

headers - headers HTTP to add to request, may be null

body - body content of type contentType, may be null

contentType - the media type of the body to send, null if body is null

accept - asked type of response

Returns:

the response from the server as a Future

Throws:

VitamClientInternalException

createExceptionFromResponse

protected VitamClientException createExceptionFromResponse(javax.ws.rs.core.Response response)

Handle all errors and throw a VitamClientException in case the response does not contains a vitamError type result.

Parameters:

response - response

Returns:

VitamClientException exception thrown for the response

getResourcePath

public String getResourcePath()

Description copied from interface: MockOrRestClient

Get the resource path of the server.

Specified by:

getResourcePath in interface MockOrRestClient

Returns:

the resource path as string

getServiceUrl

public String getServiceUrl()

Description copied from interface: MockOrRestClient

Get the service URL

Specified by:

getServiceUrl in interface MockOrRestClient

Returns:

the service URL

close

public void close()

Description copied from interface: MockOrRestClient

Close the underneath http client

Specified by:

close in interface MockOrRestClient

Specified by:

close in interface VitamAutoCloseable

Specified by:

close in interface AutoCloseable

toString

public String toString()

Overrides:

toString in class Object

getVitamClientFactory

public VitamClientFactory<?> getVitamClientFactory()

Returns:

the VitamClientFactory