fr.gouv.vitam.access.external.client

Class AdminExternalClientRest

java.lang.Object

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

fr.gouv.vitam.access.external.client.AdminExternalClientRest

All Implemented Interfaces:

AdminExternalClient, OperationStatusClient, MockOrRestClient, BasicClient, VitamAutoCloseable, AutoCloseable

public class AdminExternalClientRest
extends DefaultClient
implements AdminExternalClient

Rest client implementation for Access External

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

Method Summary

Modifier and Type	Method and Description
RequestResponse<ItemStatus>	cancelOperationProcessExecution(VitamContext vitamContext, String id) Cancel the operation
javax.ws.rs.core.Response	checkAgencies(VitamContext vitamContext, InputStream agencies) checkAgencies The caller is responsible to close the Response after consuming the inputStream.
javax.ws.rs.core.Response	checkFormats(VitamContext vitamContext, InputStream formats) checkFormats The caller is responsible to close the Response after consuming the inputStream.
javax.ws.rs.core.Response	checkRules(VitamContext vitamContext, InputStream rules) checkRules The caller is responsible to close the Response after consuming the inputStream.
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	checkTraceabilityOperation(VitamContext vitamContext, com.fasterxml.jackson.databind.JsonNode query)
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
RequestResponse	createAccessContracts(VitamContext vitamContext, InputStream accessContracts) create a set of access contracts after passing the validation steps.
RequestResponse	createAgencies(VitamContext vitamContext, InputStream agencies, String filename) create a set of agencies
RequestResponse	createContexts(VitamContext vitamContext, InputStream contexts) create a set of contexts
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	createFormats(VitamContext vitamContext, InputStream formats, String filename) create a set of formats
RequestResponse	createIngestContracts(VitamContext vitamContext, InputStream ingestContracts) create a set of ingest contracts after passing the validation steps.
RequestResponse	createProfileFile(VitamContext vitamContext, String profileMetadataId, InputStream profile) Save profile file (xsd, rng, ...) corresponding to the profile metadata.
RequestResponse	createProfiles(VitamContext vitamContext, InputStream profiles) Create a profile metadata after passing the validation steps.
RequestResponse	createRules(VitamContext vitamContext, InputStream rules, String filename) create a set of rules
RequestResponse	createSecurityProfiles(VitamContext vitamContext, InputStream securityProfiles, String filename) create a set of security profiles
javax.ws.rs.core.Response	downloadProfileFile(VitamContext vitamContext, String profileMetadataId) Download the profile file according to profileMetadataId
javax.ws.rs.core.Response	downloadRulesReport(VitamContext vitamContext, String opId) Download rules report
javax.ws.rs.core.Response	downloadTraceabilityOperationFile(VitamContext vitamContext, String operationId) Download the traceability operation file according to operationId
RequestResponse<AccessContractModel>	findAccessContractById(VitamContext vitamContext, String contractId) Find an access contracts by its id.
RequestResponse<AccessContractModel>	findAccessContracts(VitamContext vitamContext, com.fasterxml.jackson.databind.JsonNode select) Find access contracts.
RequestResponse<AccessionRegisterSummaryModel>	findAccessionRegister(VitamContext vitamContext, com.fasterxml.jackson.databind.JsonNode select) Find accession registers.
RequestResponse<AccessionRegisterSummaryModel>	findAccessionRegisterById(VitamContext vitamContext, String accessionRegisterId) Find an accession register by its id.
RequestResponse<AgenciesModel>	findAgencies(VitamContext vitamContext, com.fasterxml.jackson.databind.JsonNode query) Find agencies
RequestResponse<AgenciesModel>	findAgencyByID(VitamContext vitamContext, String agencyId) Find an agency by its id.
RequestResponse<ContextModel>	findContextById(VitamContext vitamContext, String contextId) Find a context by its id
RequestResponse<ContextModel>	findContexts(VitamContext vitamContext, com.fasterxml.jackson.databind.JsonNode select) Find contexts.
RequestResponse<FileFormatModel>	findFormatById(VitamContext vitamContext, String formatId) Find a format by its id.
RequestResponse<FileFormatModel>	findFormats(VitamContext vitamContext, com.fasterxml.jackson.databind.JsonNode select) Find formats.
RequestResponse<IngestContractModel>	findIngestContractById(VitamContext vitamContext, String contractId) Find an entry contract by its id.
RequestResponse<IngestContractModel>	findIngestContracts(VitamContext vitamContext, com.fasterxml.jackson.databind.JsonNode select) Find entry contracts.
RequestResponse<ProfileModel>	findProfileById(VitamContext vitamContext, String profileId) Find a profile by its id.
RequestResponse<ProfileModel>	findProfiles(VitamContext vitamContext, com.fasterxml.jackson.databind.JsonNode select) Find profiles.
RequestResponse<FileRulesModel>	findRuleById(VitamContext vitamContext, String ruleId) Find a rule by its id.
RequestResponse<FileRulesModel>	findRules(VitamContext vitamContext, com.fasterxml.jackson.databind.JsonNode select) Find rules.
RequestResponse<SecurityProfileModel>	findSecurityProfileById(VitamContext vitamContext, String identifier) Find a security profile by its identifier.
RequestResponse<SecurityProfileModel>	findSecurityProfiles(VitamContext vitamContext, com.fasterxml.jackson.databind.JsonNode select) Find security profiles by query dsl.
RequestResponse	getAccessionRegisterDetail(VitamContext vitamContext, String id, com.fasterxml.jackson.databind.JsonNode query) Get the accession register details matching the given query
protected javax.ws.rs.client.Client	getClient(boolean chunked)
RequestResponse<ItemStatus>	getOperationProcessExecutionDetails(VitamContext vitamContext, String id)
RequestResponse<ItemStatus>	getOperationProcessStatus(VitamContext vitamContext, String id) Get vitam operation status
String	getResourcePath() Get the resource path of the server.
String	getServiceUrl() Get the service URL
VitamClientFactory<?>	getVitamClientFactory()
RequestResponse<WorkFlow>	getWorkflowDefinitions(VitamContext vitamContext)
RequestResponse	launchAudit(VitamContext vitamContext, com.fasterxml.jackson.databind.JsonNode auditOption) Check the existence of objects in the context of an audit
RequestResponse<ProcessDetail>	listOperationsDetails(VitamContext vitamContext, ProcessQuery query) Get the list of operations details
RequestResponse	objectGroupEvidenceAudit(VitamContext vitamContext, String objectGroupId) launch a traceability audit for the object group
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.MultivaluedHashMap<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.MultivaluedHashMap<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.MultivaluedHashMap<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()
RequestResponse	unitEvidenceAudit(VitamContext vitamContext, String unitId) launch a traceability audit for the unit
RequestResponse	updateAccessContract(VitamContext vitamContext, String id, com.fasterxml.jackson.databind.JsonNode queryDsl) Update the given access contract by query dsl
RequestResponse	updateContext(VitamContext vitamContext, String id, com.fasterxml.jackson.databind.JsonNode queryDsl) Update the context by query dsl
RequestResponse	updateIngestContract(VitamContext vitamContext, String id, com.fasterxml.jackson.databind.JsonNode queryDsl) Update the given ingest contract by query dsl
RequestResponse<ItemStatus>	updateOperationActionProcess(VitamContext vitamContext, String actionId, String operationId) Update the operation according to the requested action
RequestResponse	updateProfile(VitamContext vitamContext, String profileMetadataId, com.fasterxml.jackson.databind.JsonNode queryDsl) Update the detail of the profile
RequestResponse	updateSecurityProfile(VitamContext vitamContext, String identifier, com.fasterxml.jackson.databind.JsonNode queryDsl) Updates the given security profile by query dsl

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

Method Detail

findFormats

public RequestResponse<FileFormatModel> findFormats(VitamContext vitamContext,
                                                    com.fasterxml.jackson.databind.JsonNode select)
                                             throws VitamClientException

Description copied from interface: AdminExternalClient

Find formats.

Specified by:

findFormats in interface AdminExternalClient

Parameters:

vitamContext - the vitam context

select - select query

Returns:

list of formats

Throws:

VitamClientException

findRules

public RequestResponse<FileRulesModel> findRules(VitamContext vitamContext,
                                                 com.fasterxml.jackson.databind.JsonNode select)
                                          throws VitamClientException

Description copied from interface: AdminExternalClient

Find rules.

Specified by:

findRules in interface AdminExternalClient

Parameters:

vitamContext - the vitam context

select - select query

Returns:

list of rules

Throws:

VitamClientException

findIngestContracts

public RequestResponse<IngestContractModel> findIngestContracts(VitamContext vitamContext,
                                                                com.fasterxml.jackson.databind.JsonNode select)
                                                         throws VitamClientException

Description copied from interface: AdminExternalClient

Find entry contracts.

Specified by:

findIngestContracts in interface AdminExternalClient

Parameters:

vitamContext - the vitam context

select - select query

Returns:

list of ingest contrats

Throws:

VitamClientException

findAccessContracts

public RequestResponse<AccessContractModel> findAccessContracts(VitamContext vitamContext,
                                                                com.fasterxml.jackson.databind.JsonNode select)
                                                         throws VitamClientException

Description copied from interface: AdminExternalClient

Find access contracts.

Specified by:

findAccessContracts in interface AdminExternalClient

Parameters:

vitamContext - the vitam context

select - select query

Returns:

list of access contrats

Throws:

VitamClientException

findContexts

public RequestResponse<ContextModel> findContexts(VitamContext vitamContext,
                                                  com.fasterxml.jackson.databind.JsonNode select)
                                           throws VitamClientException

Description copied from interface: AdminExternalClient

Find contexts.

Specified by:

findContexts in interface AdminExternalClient

Parameters:

vitamContext - the vitam context

select - select query

Returns:

list of contexts

Throws:

VitamClientException

findProfiles

public RequestResponse<ProfileModel> findProfiles(VitamContext vitamContext,
                                                  com.fasterxml.jackson.databind.JsonNode select)
                                           throws VitamClientException

Description copied from interface: AdminExternalClient

Find profiles.

Specified by:

findProfiles in interface AdminExternalClient

Parameters:

vitamContext - the vitam context

select - select query

Returns:

list of profiles

Throws:

VitamClientException

findAccessionRegister

public RequestResponse<AccessionRegisterSummaryModel> findAccessionRegister(VitamContext vitamContext,
                                                                            com.fasterxml.jackson.databind.JsonNode select)
                                                                     throws VitamClientException

Description copied from interface: AdminExternalClient

Find accession registers.

Specified by:

findAccessionRegister in interface AdminExternalClient

Parameters:

vitamContext - the vitam context

select - select query

Returns:

list of accession registers

Throws:

VitamClientException

findSecurityProfiles

public RequestResponse<SecurityProfileModel> findSecurityProfiles(VitamContext vitamContext,
                                                                  com.fasterxml.jackson.databind.JsonNode select)
                                                           throws VitamClientException

Description copied from interface: AdminExternalClient

Find security profiles by query dsl.

Specified by:

findSecurityProfiles in interface AdminExternalClient

Parameters:

vitamContext - the vitam context

select - select query

Returns:

list of security profiles

Throws:

VitamClientException

getAccessionRegisterDetail

public RequestResponse getAccessionRegisterDetail(VitamContext vitamContext,
                                                  String id,
                                                  com.fasterxml.jackson.databind.JsonNode query)
                                           throws InvalidParseOperationException,
                                                  AccessExternalClientServerException,
                                                  AccessExternalClientNotFoundException

Description copied from interface: AdminExternalClient

Get the accession register details matching the given query

Specified by:

getAccessionRegisterDetail in interface AdminExternalClient

Parameters:

vitamContext - the vitam context

id - the id of accession register

query - The DSL Query as a JSON Node

Returns:

The AccessionregisterDetails list as a response jsonNode

Throws:

InvalidParseOperationException

AccessExternalClientServerException

AccessExternalClientNotFoundException

updateAccessContract

public RequestResponse updateAccessContract(VitamContext vitamContext,
                                            String id,
                                            com.fasterxml.jackson.databind.JsonNode queryDsl)
                                     throws AccessExternalClientException

Description copied from interface: AdminExternalClient

Update the given access contract by query dsl

Specified by:

updateAccessContract in interface AdminExternalClient

Parameters:

vitamContext - the vitam context

id - the given id of the access contract

queryDsl - the given dsl query

Returns:

Response status ok or vitam error

Throws:

AccessExternalClientException

updateIngestContract

public RequestResponse updateIngestContract(VitamContext vitamContext,
                                            String id,
                                            com.fasterxml.jackson.databind.JsonNode queryDsl)
                                     throws InvalidParseOperationException,
                                            AccessExternalClientException

Description copied from interface: AdminExternalClient

Update the given ingest contract by query dsl

Specified by:

updateIngestContract in interface AdminExternalClient

Parameters:

vitamContext - the vitam context

id - the given id of the ingest contract

queryDsl - the given dsl query

Returns:

Response status ok or vitam error

Throws:

InvalidParseOperationException

AccessExternalClientException

createProfiles

public RequestResponse createProfiles(VitamContext vitamContext,
                                      InputStream profiles)
                               throws InvalidParseOperationException,
                                      AccessExternalClientException

Description copied from interface: AdminExternalClient

Create a profile metadata after passing the validation steps. If profile are json and valid, they are stored in the collection and indexed.
The input is invalid in the following situations :

• The json of file is invalid
• One or more mandatory field is missing
• A field has an invalid format
• Profile already exist in the database

Specified by:

createProfiles in interface AdminExternalClient

Parameters:

vitamContext - the vitam context

profiles - as Json InputStream

Returns:

Vitam response

Throws:

InvalidParseOperationException

AccessExternalClientException

createProfileFile

public RequestResponse createProfileFile(VitamContext vitamContext,
                                         String profileMetadataId,
                                         InputStream profile)
                                  throws InvalidParseOperationException,
                                         AccessExternalClientException

Description copied from interface: AdminExternalClient

Save profile file (xsd, rng, ...) corresponding to the profile metadata. As the id of profile metadata is required, this method should be called after creation of profile metadata The profile file will be saved in storage with the name of id of profile metadata

Specified by:

createProfileFile in interface AdminExternalClient

Parameters:

vitamContext - the vitam context

profile - as InputStream

Returns:

Vitam response

Throws:

InvalidParseOperationException

AccessExternalClientException

downloadProfileFile

public javax.ws.rs.core.Response downloadProfileFile(VitamContext vitamContext,
                                                     String profileMetadataId)
                                              throws AccessExternalClientException,
                                                     AccessExternalNotFoundException

Description copied from interface: AdminExternalClient

Download the profile file according to profileMetadataId

Specified by:

downloadProfileFile in interface AdminExternalClient

Parameters:

vitamContext - the vitam context

Returns:

Response

Throws:

AccessExternalClientException

AccessExternalNotFoundException

createContexts

public RequestResponse createContexts(VitamContext vitamContext,
                                      InputStream contexts)
                               throws InvalidParseOperationException,
                                      AccessExternalClientServerException

Description copied from interface: AdminExternalClient

create a set of contexts

Specified by:

createContexts in interface AdminExternalClient

Parameters:

vitamContext - the vitam context

Returns:

Vitam response

Throws:

InvalidParseOperationException

AccessExternalClientServerException

updateContext

public RequestResponse updateContext(VitamContext vitamContext,
                                     String id,
                                     com.fasterxml.jackson.databind.JsonNode queryDsl)
                              throws AccessExternalClientException

Description copied from interface: AdminExternalClient

Update the context by query dsl

Specified by:

updateContext in interface AdminExternalClient

Parameters:

vitamContext - the vitam context

id - the context id

Returns:

Vitam response

Throws:

AccessExternalClientException

updateProfile

public RequestResponse updateProfile(VitamContext vitamContext,
                                     String profileMetadataId,
                                     com.fasterxml.jackson.databind.JsonNode queryDsl)
                              throws AccessExternalClientException

Description copied from interface: AdminExternalClient

Update the detail of the profile

Specified by:

updateProfile in interface AdminExternalClient

Returns:

a profile

Throws:

AccessExternalClientException

checkTraceabilityOperation

public RequestResponse checkTraceabilityOperation(VitamContext vitamContext,
                                                  com.fasterxml.jackson.databind.JsonNode query)
                                           throws AccessExternalClientServerException,
                                                  AccessUnauthorizedException

Specified by:

checkTraceabilityOperation in interface AdminExternalClient

Parameters:

vitamContext - the vitam context

Throws:

AccessExternalClientServerException

AccessUnauthorizedException

downloadTraceabilityOperationFile

public javax.ws.rs.core.Response downloadTraceabilityOperationFile(VitamContext vitamContext,
                                                                   String operationId)
                                                            throws AccessExternalClientServerException,
                                                                   AccessUnauthorizedException

Description copied from interface: AdminExternalClient

Download the traceability operation file according to operationId

Specified by:

downloadTraceabilityOperationFile in interface AdminExternalClient

Parameters:

vitamContext - the vitam context

Throws:

AccessExternalClientServerException

AccessUnauthorizedException

launchAudit

public RequestResponse launchAudit(VitamContext vitamContext,
                                   com.fasterxml.jackson.databind.JsonNode auditOption)
                            throws AccessExternalClientServerException

Description copied from interface: AdminExternalClient

Check the existence of objects in the context of an audit

Specified by:

launchAudit in interface AdminExternalClient

Parameters:

vitamContext - the vitam context

Returns:

Status

Throws:

AccessExternalClientServerException

findFormatById

public RequestResponse<FileFormatModel> findFormatById(VitamContext vitamContext,
                                                       String formatId)
                                                throws VitamClientException

Description copied from interface: AdminExternalClient

Find a format by its id.

Specified by:

findFormatById in interface AdminExternalClient

Parameters:

vitamContext - the vitam context

formatId - the formatId

Returns:

a format

Throws:

VitamClientException

findRuleById

public RequestResponse<FileRulesModel> findRuleById(VitamContext vitamContext,
                                                    String ruleId)
                                             throws VitamClientException

Description copied from interface: AdminExternalClient

Find a rule by its id.

Specified by:

findRuleById in interface AdminExternalClient

Parameters:

vitamContext - the vitam context

ruleId - the rule id

Returns:

a rule

Throws:

VitamClientException

findIngestContractById

public RequestResponse<IngestContractModel> findIngestContractById(VitamContext vitamContext,
                                                                   String contractId)
                                                            throws VitamClientException

Description copied from interface: AdminExternalClient

Find an entry contract by its id.

Specified by:

findIngestContractById in interface AdminExternalClient

Parameters:

vitamContext - the vitam context

contractId - the contract id

Returns:

an ingest contract

Throws:

VitamClientException

findAccessContractById

public RequestResponse<AccessContractModel> findAccessContractById(VitamContext vitamContext,
                                                                   String contractId)
                                                            throws VitamClientException

Description copied from interface: AdminExternalClient

Find an access contracts by its id.

Specified by:

findAccessContractById in interface AdminExternalClient

Parameters:

vitamContext - the vitam context

contractId - the contract id

Returns:

an access contract

Throws:

VitamClientException

findContextById

public RequestResponse<ContextModel> findContextById(VitamContext vitamContext,
                                                     String contextId)
                                              throws VitamClientException

Description copied from interface: AdminExternalClient

Find a context by its id

Specified by:

findContextById in interface AdminExternalClient

Parameters:

vitamContext - the vitam context

contextId - the context id

Returns:

a context

Throws:

VitamClientException

findProfileById

public RequestResponse<ProfileModel> findProfileById(VitamContext vitamContext,
                                                     String profileId)
                                              throws VitamClientException

Description copied from interface: AdminExternalClient

Find a profile by its id.

Specified by:

findProfileById in interface AdminExternalClient

Parameters:

vitamContext - the vitam context

profileId - the profile tId

Returns:

a profile

Throws:

VitamClientException

findAccessionRegisterById

public RequestResponse<AccessionRegisterSummaryModel> findAccessionRegisterById(VitamContext vitamContext,
                                                                                String accessionRegisterId)
                                                                         throws VitamClientException

Description copied from interface: AdminExternalClient

Find an accession register by its id.

Specified by:

findAccessionRegisterById in interface AdminExternalClient

Parameters:

vitamContext - the vitam context

accessionRegisterId - the accession register id

Returns:

an accession register

Throws:

VitamClientException

findAgencies

public RequestResponse<AgenciesModel> findAgencies(VitamContext vitamContext,
                                                   com.fasterxml.jackson.databind.JsonNode query)
                                            throws VitamClientException

Description copied from interface: AdminExternalClient

Find agencies

Specified by:

findAgencies in interface AdminExternalClient

Parameters:

vitamContext - the vitam context

query - select query

Returns:

list of agencies

Throws:

VitamClientException

findAgencyByID

public RequestResponse<AgenciesModel> findAgencyByID(VitamContext vitamContext,
                                                     String agencyId)
                                              throws VitamClientException

Description copied from interface: AdminExternalClient

Find an agency by its id.

Specified by:

findAgencyByID in interface AdminExternalClient

Parameters:

vitamContext - the vitam context

agencyId - the agency id

Returns:

an agency

Throws:

VitamClientException

findSecurityProfileById

public RequestResponse<SecurityProfileModel> findSecurityProfileById(VitamContext vitamContext,
                                                                     String identifier)
                                                              throws VitamClientException

Description copied from interface: AdminExternalClient

Find a security profile by its identifier.

Specified by:

findSecurityProfileById in interface AdminExternalClient

Parameters:

vitamContext - the vitam context

identifier - the identifier of the security profile

Returns:

a security profile

Throws:

VitamClientException

updateSecurityProfile

public RequestResponse updateSecurityProfile(VitamContext vitamContext,
                                             String identifier,
                                             com.fasterxml.jackson.databind.JsonNode queryDsl)
                                      throws VitamClientException

Description copied from interface: AdminExternalClient

Updates the given security profile by query dsl

Specified by:

updateSecurityProfile in interface AdminExternalClient

Parameters:

vitamContext - the vitam context

identifier - the identifier of the security profile to update

queryDsl - the given dsl query

Returns:

Response status ok or vitam error

Throws:

VitamClientException

listOperationsDetails

public RequestResponse<ProcessDetail> listOperationsDetails(VitamContext vitamContext,
                                                            ProcessQuery query)
                                                     throws VitamClientException

Description copied from interface: AdminExternalClient

Get the list of operations details

Specified by:

listOperationsDetails in interface AdminExternalClient

Parameters:

vitamContext - the vitam context

query - filter query

Returns:

list of operations details

Throws:

VitamClientException

updateOperationActionProcess

public RequestResponse<ItemStatus> updateOperationActionProcess(VitamContext vitamContext,
                                                                String actionId,
                                                                String operationId)
                                                         throws VitamClientException

Description copied from interface: AdminExternalClient

Update the operation according to the requested action

Specified by:

updateOperationActionProcess in interface AdminExternalClient

Parameters:

vitamContext - the vitam context

actionId - an action as a string among "RESUME" (resume workflow till the end), "NEXT" (launch next step), "REPLAY" (replay the step) and PAUSE" (pause the workflow)

Returns:

the status

Throws:

VitamClientException

getOperationProcessStatus

public RequestResponse<ItemStatus> getOperationProcessStatus(VitamContext vitamContext,
                                                             String id)
                                                      throws VitamClientException

Description copied from interface: OperationStatusClient

Get vitam operation status

Specified by:

getOperationProcessStatus in interface OperationStatusClient

Parameters:

vitamContext - the vitam context

Returns:

the status of the operation (HEAD only)

Throws:

VitamClientException

cancelOperationProcessExecution

public RequestResponse<ItemStatus> cancelOperationProcessExecution(VitamContext vitamContext,
                                                                   String id)
                                                            throws VitamClientException,
                                                                   IllegalArgumentException

Description copied from interface: AdminExternalClient

Cancel the operation

Specified by:

cancelOperationProcessExecution in interface AdminExternalClient

Parameters:

vitamContext - the vitam context

Returns:

the status

Throws:

VitamClientException

IllegalArgumentException

getOperationProcessExecutionDetails

public RequestResponse<ItemStatus> getOperationProcessExecutionDetails(VitamContext vitamContext,
                                                                       String id)
                                                                throws VitamClientException

Specified by:

getOperationProcessExecutionDetails in interface AdminExternalClient

Parameters:

vitamContext - the vitam context

Returns:

the details of the operation

Throws:

VitamClientException

getWorkflowDefinitions

public RequestResponse<WorkFlow> getWorkflowDefinitions(VitamContext vitamContext)
                                                 throws VitamClientException

Specified by:

getWorkflowDefinitions in interface AdminExternalClient

Parameters:

vitamContext - the vitam context@return the Workflow definitions

Returns:

the pool of workflows

Throws:

VitamClientException

createAgencies

public RequestResponse createAgencies(VitamContext vitamContext,
                                      InputStream agencies,
                                      String filename)
                               throws AccessExternalClientException

Description copied from interface: AdminExternalClient

create a set of agencies

Specified by:

createAgencies in interface AdminExternalClient

Parameters:

vitamContext - the vitam context

agencies - agencies to be created

Returns:

Vitam response

Throws:

AccessExternalClientException

createFormats

public RequestResponse createFormats(VitamContext vitamContext,
                                     InputStream formats,
                                     String filename)
                              throws AccessExternalClientException

Description copied from interface: AdminExternalClient

create a set of formats

Specified by:

createFormats in interface AdminExternalClient

Parameters:

vitamContext - the vitam context

formats - formats to be created

Returns:

Vitam response

Throws:

AccessExternalClientException

createRules

public RequestResponse createRules(VitamContext vitamContext,
                                   InputStream rules,
                                   String filename)
                            throws AccessExternalClientException

Description copied from interface: AdminExternalClient

create a set of rules

Specified by:

createRules in interface AdminExternalClient

Parameters:

vitamContext - the vitam context

rules - rules to be created

Returns:

Vitam response

Throws:

AccessExternalClientException

createSecurityProfiles

public RequestResponse createSecurityProfiles(VitamContext vitamContext,
                                              InputStream securityProfiles,
                                              String filename)
                                       throws AccessExternalClientException

Description copied from interface: AdminExternalClient

create a set of security profiles

Specified by:

createSecurityProfiles in interface AdminExternalClient

Parameters:

vitamContext - the vitam context

securityProfiles - security profiles to be created

Returns:

Vitam response

Throws:

AccessExternalClientException

checkRules

public javax.ws.rs.core.Response checkRules(VitamContext vitamContext,
                                            InputStream rules)
                                     throws VitamClientException

Description copied from interface: AdminExternalClient

checkRules

The caller is responsible to close the Response after consuming the inputStream.

Specified by:

checkRules in interface AdminExternalClient

Parameters:

vitamContext - the vitam context

rules - the input stream to be checked

Returns:

response including InputStream

Throws:

VitamClientException

checkFormats

public javax.ws.rs.core.Response checkFormats(VitamContext vitamContext,
                                              InputStream formats)
                                       throws VitamClientException

Description copied from interface: AdminExternalClient

checkFormats

The caller is responsible to close the Response after consuming the inputStream.

Specified by:

checkFormats in interface AdminExternalClient

Parameters:

vitamContext - the vitam context

formats - the input stream to be checked

Returns:

response including InputStream

Throws:

VitamClientException

checkAgencies

public javax.ws.rs.core.Response checkAgencies(VitamContext vitamContext,
                                               InputStream agencies)
                                        throws VitamClientException

Description copied from interface: AdminExternalClient

checkAgencies

The caller is responsible to close the Response after consuming the inputStream.

Specified by:

checkAgencies in interface AdminExternalClient

Parameters:

vitamContext - the vitam context

agencies - the input stream to be checked

Returns:

response including InputStream

Throws:

VitamClientException

createIngestContracts

public RequestResponse createIngestContracts(VitamContext vitamContext,
                                             InputStream ingestContracts)
                                      throws InvalidParseOperationException,
                                             AccessExternalClientException

Description copied from interface: AdminExternalClient

create a set of ingest contracts after passing the validation steps. If all the contracts are valid, they are stored in the collection and indexed.
The input is invalid in the following situations :

• The json is invalid
• The json contains 2 ore many contracts having the same name
• One or more mandatory field is missing
• A field has an invalid format
• One or many contracts elready exist in the database

Specified by:

createIngestContracts in interface AdminExternalClient

Parameters:

vitamContext - the vitam context

ingestContracts - as InputStream

Returns:

Vitam response

Throws:

InvalidParseOperationException

AccessExternalClientException

createAccessContracts

public RequestResponse createAccessContracts(VitamContext vitamContext,
                                             InputStream accessContracts)
                                      throws InvalidParseOperationException,
                                             AccessExternalClientException

Description copied from interface: AdminExternalClient

create a set of access contracts after passing the validation steps. If all the contracts are valid, they are stored in the collection and indexed.
The input is invalid in the following situations :

• The json is invalid
• The json contains 2 ore many contracts having the same name
• One or more mandatory field is missing
• A field has an invalid format
• One or many contracts already exist in the database

Specified by:

createAccessContracts in interface AdminExternalClient

Parameters:

vitamContext - the vitam context

accessContracts - as InputStream

Returns:

Vitam response

Throws:

InvalidParseOperationException

AccessExternalClientException

downloadRulesReport

public javax.ws.rs.core.Response downloadRulesReport(VitamContext vitamContext,
                                                     String opId)
                                              throws VitamClientException

Description copied from interface: AdminExternalClient

Download rules report

Specified by:

downloadRulesReport in interface AdminExternalClient

Parameters:

vitamContext - the vitam context

opId - the op (logbook) ID

Returns:

the rulesReport

Throws:

VitamClientException

unitEvidenceAudit

public RequestResponse unitEvidenceAudit(VitamContext vitamContext,
                                         String unitId)
                                  throws VitamClientException

Description copied from interface: AdminExternalClient

launch a traceability audit for the unit

Specified by:

unitEvidenceAudit in interface AdminExternalClient

Parameters:

vitamContext - the vitam context

unitId - the unit id

Returns:

Vitam response

Throws:

VitamClientException

objectGroupEvidenceAudit

public RequestResponse objectGroupEvidenceAudit(VitamContext vitamContext,
                                                String objectGroupId)
                                         throws VitamClientException

Description copied from interface: AdminExternalClient

launch a traceability audit for the object group

Specified by:

objectGroupEvidenceAudit in interface AdminExternalClient

Parameters:

vitamContext - the vitam context

objectGroupId - the object group id

Returns:

Vitam response

Throws:

VitamClientException

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.MultivaluedHashMap<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.MultivaluedHashMap<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.MultivaluedHashMap<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