Package fr.gouv.vitam.access.external.client

Interface AdminExternalClient

All Superinterfaces:

AutoCloseable, BasicClient, MockOrRestClient, OperationStatusClient, VitamAutoCloseable

All Known Implementing Classes:

AdminExternalClientMock, AdminExternalClientRest

public interface AdminExternalClient
extends BasicClient, OperationStatusClient

Admin External Client Interface

Field Summary

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

STATUS_URL

Method Summary

Modifier and Type	Method	Description
RequestResponse<ItemStatus>	cancelOperationProcessExecution(VitamContext vitamContext, String operationId)	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.
RequestResponse	checkTraceabilityOperation(VitamContext vitamContext, com.fasterxml.jackson.databind.JsonNode query)	Deprecated.
RequestResponse<com.fasterxml.jackson.databind.JsonNode>	checkTraceabilityOperations(VitamContext vitamContext, com.fasterxml.jackson.databind.JsonNode query)
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	createArchiveUnitProfile(VitamContext vitamContext, InputStream profiles)	Create a ArchiveUnitProfile after passing the validation steps.
RequestResponse	createContexts(VitamContext vitamContext, InputStream contexts)	create a set of contexts
RequestResponse	createExternalOperation(VitamContext vitamContext, LogbookOperationParameters logbookOperationparams)	Create external logbook operation entry
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	createManagementContracts(VitamContext vitamContext, InputStream accessContracts)	create a set of access 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
RequestResponse<Void>	deleteUnitExternalSchemas(VitamContext vitamContext, List<String> externalSchemaPaths)	Delete unit external schema
javax.ws.rs.core.Response	downloadAgenciesCsvAsStream(VitamContext vitamContext, String opId)	Download Csv referential Agencies
javax.ws.rs.core.Response	downloadBatchReport(VitamContext vitamContext, String opId)	Download batch reports
javax.ws.rs.core.Response	downloadDistributionReport(VitamContext vitamContext, String opId)	Download distribution reports
javax.ws.rs.core.Response	downloadProfileFile(VitamContext vitamContext, String profileMetadataId)	Download the profile file according to profileMetadataId
javax.ws.rs.core.Response	downloadRulesCsvAsStream(VitamContext vitamContext, String opId)	Download Csv referential Rules
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<com.fasterxml.jackson.databind.JsonNode>	evidenceAudit(VitamContext vitamContext, com.fasterxml.jackson.databind.JsonNode queryDsl)	launch a traceability audit for the request
RequestResponse	exportProbativeValue(VitamContext vitamContext, ProbativeValueRequest probativeValueRequest)	launch probative value process
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<AccessionRegisterDetailModel>	findAccessionRegisterDetails(VitamContext vitamContext, com.fasterxml.jackson.databind.JsonNode select)	Find accession register details.
RequestResponse<AccessionRegisterSymbolicModel>	findAccessionRegisterSymbolic(VitamContext vitamContext, com.fasterxml.jackson.databind.JsonNode select)	Find accession registers symbolic.
RequestResponse<AgenciesModel>	findAgencies(VitamContext vitamContext, com.fasterxml.jackson.databind.JsonNode query)	Find agencies
RequestResponse<AgenciesModel>	findAgencyByID(VitamContext vitamContext, String agencyById)	Find an agency by its id.
RequestResponse<ArchiveUnitProfileModel>	findArchiveUnitProfileById(VitamContext vitamContext, String id)	Find an archive unit profile by its id.
RequestResponse<ArchiveUnitProfileModel>	findArchiveUnitProfiles(VitamContext vitamContext, com.fasterxml.jackson.databind.JsonNode query)	Find archive unit profiles
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<GriffinModel>	findGriffin(VitamContext vitamContext, com.fasterxml.jackson.databind.JsonNode select)
RequestResponse<GriffinModel>	findGriffinById(VitamContext vitamContext, String id)
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<ManagementContractModel>	findManagementContractById(VitamContext vitamContext, String contractId)	Find an management contracts by its id.
RequestResponse<ManagementContractModel>	findManagementContracts(VitamContext vitamContext, com.fasterxml.jackson.databind.JsonNode select)	Find management contracts.
RequestResponse<OntologyModel>	findOntologies(VitamContext vitamContext, com.fasterxml.jackson.databind.JsonNode query)	Find ontologies
RequestResponse<OntologyModel>	findOntologyById(VitamContext vitamContext, String id)	Find an ontology by its id.
RequestResponse<PreservationScenarioModel>	findPreservationScenario(VitamContext vitamContext, com.fasterxml.jackson.databind.JsonNode select)
RequestResponse<PreservationScenarioModel>	findPreservationScenarioById(VitamContext vitamContext, String id)
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 securityProfileId)	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
RequestResponse<CombinedSchemaModel>	getArchiveUnitProfileSchema(VitamContext vitamContext, String id)	get archive unit profile schema
RequestResponse<SchemaResponse>	getObjectGroupSchema(VitamContext vitamContext)	get Object group schema
RequestResponse<ItemStatus>	getOperationProcessExecutionDetails(VitamContext vitamContext, String operationId)
RequestResponse<PublicConfiguration>	getPublicConfiguration(VitamContext vitamContext)	Get vitam public configuration
RequestResponse<SchemaResponse>	getUnitSchema(VitamContext vitamContext)	get unit schema
RequestResponse<WorkFlow>	getWorkflowDefinitions(VitamContext vitamContext)
RequestResponse	importGriffin(VitamContext vitamContext, InputStream griffinStream, String filName)
RequestResponse	importOntologies(boolean forceUpdate, VitamContext vitamContext, InputStream ontologies)	Import a set of ontologies metadata.
RequestResponse	importPreservationScenario(VitamContext vitamContext, InputStream scenarioStream, String filName)
RequestResponse<Void>	importUnitExternalSchema(VitamContext vitamContext, InputStream externalSchema)	Import unit external schema
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	rectificationAudit(VitamContext vitamContext, String operationId)	launch a rectification audit for the operation id
RequestResponse	updateAccessContract(VitamContext vitamContext, String accessContractId, com.fasterxml.jackson.databind.JsonNode queryDsl)	Update the given access contract by query dsl
RequestResponse	updateArchiveUnitProfile(VitamContext vitamContext, String archiveUnitprofileId, com.fasterxml.jackson.databind.JsonNode queryDSL)	Update the given archive unit profile by query DSL
RequestResponse	updateContext(VitamContext vitamContext, String contextId, com.fasterxml.jackson.databind.JsonNode queryDsl)	Update the context by query dsl
RequestResponse	updateIngestContract(VitamContext vitamContext, String ingestContractId, com.fasterxml.jackson.databind.JsonNode queryDsl)	Update the given ingest contract by query dsl
RequestResponse	updateManagementContract(VitamContext vitamContext, String managementContractId, com.fasterxml.jackson.databind.JsonNode queryDsl)	Update the given management contract by query dsl
RequestResponse<ItemStatus>	updateOperationActionProcess(VitamContext vitamContext, String action, 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 securityProfileId, com.fasterxml.jackson.databind.JsonNode queryDsl)	Updates the given security profile by query dsl

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

checkStatus, checkStatus, close, consumeAnyEntityAndClose, getResourcePath, getServiceUrl

Methods inherited from interface fr.gouv.vitam.access.external.client.OperationStatusClient

getOperationProcessStatus

Method Details

checkRules

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

checkRules

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

Parameters:

vitamContext - the vitam context

rules - the input stream to be checked

Returns:

response including InputStream

Throws:

VitamClientException

checkFormats

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

checkFormats

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

Parameters:

vitamContext - the vitam context

formats - the input stream to be checked

Returns:

response including InputStream

Throws:

VitamClientException

findFormats

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

Find formats.

Parameters:

vitamContext - the vitam context

select - select query

Returns:

list of formats

Throws:

VitamClientException

findRules

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

Find rules.

Parameters:

vitamContext - the vitam context

select - select query

Returns:

list of rules

Throws:

VitamClientException

findIngestContracts

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

Find entry contracts.

Parameters:

vitamContext - the vitam context

select - select query

Returns:

list of ingest contrats

Throws:

VitamClientException

findAccessContracts

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

Find access contracts.

Parameters:

vitamContext - the vitam context

select - select query

Returns:

list of access contrats

Throws:

VitamClientException

findManagementContracts

RequestResponse<ManagementContractModel> findManagementContracts(VitamContext vitamContext,
 com.fasterxml.jackson.databind.JsonNode select)
                                                          throws VitamClientException

Find management contracts.

Parameters:

vitamContext - the vitam context

select - select query

Returns:

list of management contrats

Throws:

VitamClientException

findContexts

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

Find contexts.

Parameters:

vitamContext - the vitam context

select - select query

Returns:

list of contexts

Throws:

VitamClientException

findProfiles

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

Find profiles.

Parameters:

vitamContext - the vitam context

select - select query

Returns:

list of profiles

Throws:

VitamClientException

findAccessionRegister

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

Find accession registers.

Parameters:

vitamContext - the vitam context

select - select query

Returns:

list of accession registers

Throws:

VitamClientException

findAccessionRegisterDetails

RequestResponse<AccessionRegisterDetailModel> findAccessionRegisterDetails(VitamContext vitamContext,
 com.fasterxml.jackson.databind.JsonNode select)
                                                                    throws VitamClientException

Find accession register details.

Parameters:

vitamContext - the vitam context

select - select query

Returns:

list of accession register details

Throws:

VitamClientException

findAccessionRegisterSymbolic

RequestResponse<AccessionRegisterSymbolicModel> findAccessionRegisterSymbolic(VitamContext vitamContext,
 com.fasterxml.jackson.databind.JsonNode select)
                                                                       throws VitamClientException

Find accession registers symbolic.

Parameters:

vitamContext - the vitam context

select - select query

Returns:

list of accession registers

Throws:

VitamClientException

findArchiveUnitProfiles

RequestResponse<ArchiveUnitProfileModel> findArchiveUnitProfiles(VitamContext vitamContext,
 com.fasterxml.jackson.databind.JsonNode query)
                                                          throws VitamClientException

Find archive unit profiles

Parameters:

vitamContext - the vitam context

query - select query

Returns:

list of archive unit profiles

Throws:

VitamClientException

getAccessionRegisterDetail

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

Get the accession register details matching the given query

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

AccessUnauthorizedException

createIngestContracts

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

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 or 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

Parameters:

vitamContext - the vitam context

ingestContracts - as InputStream

Returns:

Vitam response

Throws:

InvalidParseOperationException

AccessExternalClientException

createAccessContracts

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

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 or 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

Parameters:

vitamContext - the vitam context

accessContracts - as InputStream

Returns:

Vitam response

Throws:

InvalidParseOperationException

AccessExternalClientException

createManagementContracts

RequestResponse createManagementContracts(VitamContext vitamContext,
 InputStream accessContracts)
                                   throws InvalidParseOperationException,
AccessExternalClientException

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 or 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
• One or many strategies are invalid

Parameters:

vitamContext - the vitam context

accessContracts - as InputStream

Returns:

Vitam response

Throws:

InvalidParseOperationException

AccessExternalClientException

updateAccessContract

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

Update the given access contract by query dsl

Parameters:

vitamContext - the vitam context

accessContractId - the given id of the access contract

queryDsl - the given dsl query

Returns:

Response status ok or vitam error

Throws:

InvalidParseOperationException

AccessExternalClientException

updateIngestContract

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

Update the given ingest contract by query dsl

Parameters:

vitamContext - the vitam context

ingestContractId - the given id of the ingest contract

queryDsl - the given dsl query

Returns:

Response status ok or vitam error

Throws:

InvalidParseOperationException

AccessExternalClientException

updateManagementContract

RequestResponse updateManagementContract(VitamContext vitamContext,
 String managementContractId,
 com.fasterxml.jackson.databind.JsonNode queryDsl)
                                  throws InvalidParseOperationException,
AccessExternalClientException

Update the given management contract by query dsl

Parameters:

vitamContext - the vitam context

managementContractId - the given id of the management contract

queryDsl - the given dsl query

Returns:

Response status ok or vitam error

Throws:

InvalidParseOperationException

AccessExternalClientException

updateArchiveUnitProfile

RequestResponse updateArchiveUnitProfile(VitamContext vitamContext,
 String archiveUnitprofileId,
 com.fasterxml.jackson.databind.JsonNode queryDSL)
                                  throws InvalidParseOperationException,
AccessExternalClientException

Update the given archive unit profile by query DSL

Parameters:

vitamContext - the vitam context

archiveUnitprofileId - the id of the archive unit profile update target

queryDSL - the given DSL query

Returns:

Response status OK or a VitamError

Throws:

InvalidParseOperationException

AccessExternalClientException

createProfiles

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

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

Parameters:

vitamContext - the vitam context

profiles - as Json InputStream

Returns:

Vitam response

Throws:

InvalidParseOperationException

AccessExternalClientException

createProfileFile

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

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

Parameters:

vitamContext - the vitam context

profileMetadataId -

profile - as InputStream

Returns:

Vitam response

Throws:

InvalidParseOperationException

AccessExternalClientException

downloadProfileFile

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

Download the profile file according to profileMetadataId

Parameters:

vitamContext - the vitam context

profileMetadataId -

Returns:

Response

Throws:

AccessExternalClientException

AccessExternalNotFoundException

createContexts

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

create a set of contexts

Parameters:

vitamContext - the vitam context

contexts -

Returns:

Vitam response

Throws:

InvalidParseOperationException

AccessExternalClientServerException

updateContext

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

Update the context by query dsl

Parameters:

vitamContext - the vitam context

contextId - the context id

queryDsl -

Returns:

Vitam response

Throws:

AccessExternalClientException

InvalidParseOperationException

checkTraceabilityOperation

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

Deprecated.

Parameters:

vitamContext - the vitam context

query -

Throws:

AccessExternalClientServerException

InvalidParseOperationException

AccessUnauthorizedException

checkTraceabilityOperations

RequestResponse<com.fasterxml.jackson.databind.JsonNode> checkTraceabilityOperations(VitamContext vitamContext,
 com.fasterxml.jackson.databind.JsonNode query)
                                                                              throws AccessExternalClientServerException,
InvalidParseOperationException

Parameters:

vitamContext - the vitam context

query - DSL query to select traceability operations to verify

Throws:

AccessExternalClientServerException

InvalidParseOperationException

downloadTraceabilityOperationFile

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

Download the traceability operation file according to operationId

Parameters:

vitamContext - the vitam context

operationId -

Throws:

AccessExternalClientServerException

AccessUnauthorizedException

launchAudit

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

Check the existence of objects in the context of an audit

Parameters:

vitamContext - the vitam context

auditOption -

Returns:

Status

Throws:

AccessExternalClientServerException

findFormatById

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

Find a format by its id.

Parameters:

vitamContext - the vitam context

formatId - the formatId

Returns:

a format

Throws:

VitamClientException

findRuleById

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

Find a rule by its id.

Parameters:

vitamContext - the vitam context

ruleId - the rule id

Returns:

a rule

Throws:

VitamClientException

findIngestContractById

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

Find an entry contract by its id.

Parameters:

vitamContext - the vitam context

contractId - the contract id

Returns:

an ingest contract

Throws:

VitamClientException

findAccessContractById

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

Find an access contracts by its id.

Parameters:

vitamContext - the vitam context

contractId - the contract id

Returns:

an access contract

Throws:

VitamClientException

findManagementContractById

RequestResponse<ManagementContractModel> findManagementContractById(VitamContext vitamContext,
 String contractId)
                                                             throws VitamClientException

Find an management contracts by its id.

Parameters:

vitamContext - the vitam context

contractId - the contract id

Returns:

an access contract

Throws:

VitamClientException

findContextById

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

Find a context by its id

Parameters:

vitamContext - the vitam context

contextId - the context id

Returns:

a context

Throws:

VitamClientException

findProfileById

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

Find a profile by its id.

Parameters:

vitamContext - the vitam context

profileId - the profile tId

Returns:

a profile

Throws:

VitamClientException

findAccessionRegisterById

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

Find an accession register by its id.

Parameters:

vitamContext - the vitam context

accessionRegisterId - the accession register id

Returns:

an accession register

Throws:

VitamClientException

findAgencies

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

Find agencies

Parameters:

vitamContext - the vitam context

query - select query

Returns:

list of agencies

Throws:

VitamClientException

findAgencyByID

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

Find an agency by its id.

Parameters:

vitamContext - the vitam context

agencyById - the agency id

Returns:

an agency

Throws:

VitamClientException

findArchiveUnitProfileById

RequestResponse<ArchiveUnitProfileModel> findArchiveUnitProfileById(VitamContext vitamContext,
 String id)
                                                             throws VitamClientException

Find an archive unit profile by its id.

Parameters:

vitamContext - the vitam context

id - the archive unit profile Id

Returns:

an archive unit profile

Throws:

VitamClientException

updateSecurityProfile

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

Updates the given security profile by query dsl

Parameters:

vitamContext - the vitam context

securityProfileId - the identifier of the security profile to update

queryDsl - the given dsl query

Returns:

Response status ok or vitam error

Throws:

VitamClientException

findSecurityProfiles

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

Find security profiles by query dsl.

Parameters:

vitamContext - the vitam context

select - select query

Returns:

list of security profiles

Throws:

VitamClientException

findSecurityProfileById

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

Find a security profile by its identifier.

Parameters:

vitamContext - the vitam context

securityProfileId - the identifier of the security profile

Returns:

a security profile

Throws:

VitamClientException

updateProfile

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

Update the detail of the profile

Parameters:

vitamContext -

profileMetadataId -

queryDsl -

Returns:

a profile

Throws:

AccessExternalClientException

listOperationsDetails

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

Get the list of operations details

Parameters:

vitamContext - the vitam context

query - filter query

Returns:

list of operations details

Throws:

VitamClientException

updateOperationActionProcess

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

Update the operation according to the requested action

Parameters:

vitamContext - the vitam context

action - 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)

operationId -

Returns:

the status

Throws:

VitamClientException

getOperationProcessExecutionDetails

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

Parameters:

vitamContext - the vitam context

operationId -

Returns:

the details of the operation

Throws:

VitamClientException

cancelOperationProcessExecution

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

Cancel the operation

Parameters:

vitamContext - the vitam context

operationId -

Returns:

the status

Throws:

VitamClientException

IllegalArgumentException

getWorkflowDefinitions

RequestResponse<WorkFlow> getWorkflowDefinitions(VitamContext vitamContext)
                                          throws VitamClientException

Parameters:

vitamContext - the vitam context@return the Workflow definitions

Returns:

the pool of workflows

Throws:

VitamClientException

createAgencies

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

create a set of agencies

Parameters:

vitamContext - the vitam context

agencies - agencies to be created

filename -

Returns:

Vitam response

Throws:

InvalidParseOperationException

AccessExternalClientException

createFormats

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

create a set of formats

Parameters:

vitamContext - the vitam context

formats - formats to be created

filename -

Returns:

Vitam response

Throws:

InvalidParseOperationException

AccessExternalClientException

createRules

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

create a set of rules

Parameters:

vitamContext - the vitam context

rules - rules to be created

filename -

Returns:

Vitam response

Throws:

InvalidParseOperationException

AccessExternalClientException

createSecurityProfiles

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

create a set of security profiles

Parameters:

vitamContext - the vitam context

securityProfiles - security profiles to be created

filename -

Returns:

Vitam response

Throws:

AccessExternalClientException

InvalidParseOperationException

VitamClientException

downloadDistributionReport

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

Download distribution reports

Parameters:

vitamContext - the vitam context

opId - the op (logbook) ID

Returns:

the rulesReport

Throws:

VitamClientException

downloadBatchReport

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

Download batch reports

Parameters:

vitamContext - the vitam context

opId - the op (logbook) ID

Returns:

batch report file

Throws:

VitamClientException

downloadRulesReport

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

Download rules report

Parameters:

vitamContext - the vitam context

opId - the op (logbook) ID

Returns:

the rulesReport

Throws:

VitamClientException

downloadAgenciesCsvAsStream

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

Download Csv referential Agencies

Parameters:

vitamContext - the vitam context

opId - the op (logbook) ID

Returns:

Agecsv referential

Throws:

VitamClientException - vitamClientException

downloadRulesCsvAsStream

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

Download Csv referential Rules

Parameters:

vitamContext - the vitam context

opId - the op (logbook) ID

Returns:

Rules csv referential

Throws:

VitamClientException - vitamClientException

checkAgencies

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

checkAgencies

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

Parameters:

vitamContext - the vitam context

agencies - the input stream to be checked

Returns:

response including InputStream

Throws:

VitamClientException

evidenceAudit

RequestResponse<com.fasterxml.jackson.databind.JsonNode> evidenceAudit(VitamContext vitamContext,
 com.fasterxml.jackson.databind.JsonNode queryDsl)
                                                                throws VitamClientException

launch a traceability audit for the request

Parameters:

vitamContext - the vitamContext

queryDsl - the queryDsl

Returns:

RequestResponse

Throws:

VitamClientException - The Exception

rectificationAudit

RequestResponse rectificationAudit(VitamContext vitamContext,
 String operationId)
                            throws VitamClientException

launch a rectification audit for the operation id

Parameters:

vitamContext - the operation Id

operationId - the operation Id

Returns:

RequestResponse

Throws:

VitamClientException - The Exception

exportProbativeValue

RequestResponse exportProbativeValue(VitamContext vitamContext,
 ProbativeValueRequest probativeValueRequest)
                              throws VitamClientException

launch probative value process

Parameters:

vitamContext - the vitam context

probativeValueRequest - the request

Returns:

RequestResponse

Throws:

VitamClientException - VitamClientException

createArchiveUnitProfile

RequestResponse createArchiveUnitProfile(VitamContext vitamContext,
 InputStream profiles)
                                  throws InvalidParseOperationException,
AccessExternalClientException

Create a ArchiveUnitProfile after passing the validation steps. If profiles 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 unparsable or invalid
• One or more mandatory field is missing
• A field has an invalid format
• profiles already exist in the database

Parameters:

vitamContext - the vitam context

profiles - archive unit profiles as Json InputStream

Returns:

Vitam response

Throws:

InvalidParseOperationException

AccessExternalClientException

findOntologies

RequestResponse<OntologyModel> findOntologies(VitamContext vitamContext,
 com.fasterxml.jackson.databind.JsonNode query)
                                       throws VitamClientException

Find ontologies

Parameters:

vitamContext - the vitam context

query - select query

Returns:

list of ontologies

Throws:

VitamClientException

findOntologyById

RequestResponse<OntologyModel> findOntologyById(VitamContext vitamContext,
 String id)
                                         throws VitamClientException

Find an ontology by its id.

Parameters:

vitamContext - the vitam context

id - the ontology Id

Returns:

an ontology

Throws:

VitamClientException

importOntologies

RequestResponse importOntologies(boolean forceUpdate,
 VitamContext vitamContext,
 InputStream ontologies)
                          throws InvalidParseOperationException,
AccessExternalClientException

Import a set of ontologies metadata.
If all the ontologies are valid, they will be stored in the ontology collection and indexed. The input is invalid in the following situations :

• The json is invalid
• The json contains an already used identifier
• One or more mandatory field is missing
• A field has an invalid format

Parameters:

forceUpdate -

vitamContext - the vitam context

ontologies - as Json InputStream

Returns:

Vitam response

Throws:

InvalidParseOperationException

AccessExternalClientException

importGriffin

RequestResponse importGriffin(VitamContext vitamContext,
 InputStream griffinStream,
 String filName)
                       throws VitamClientException,
AccessExternalClientException

Throws:

VitamClientException

AccessExternalClientException

importPreservationScenario

RequestResponse importPreservationScenario(VitamContext vitamContext,
 InputStream scenarioStream,
 String filName)
                                    throws VitamClientException,
AccessExternalClientException

Throws:

VitamClientException

AccessExternalClientException

findGriffinById

RequestResponse<GriffinModel> findGriffinById(VitamContext vitamContext,
 String id)
                                       throws VitamClientException

Throws:

VitamClientException

findPreservationScenarioById

RequestResponse<PreservationScenarioModel> findPreservationScenarioById(VitamContext vitamContext,
 String id)
                                                                 throws VitamClientException

Throws:

VitamClientException

findPreservationScenario

RequestResponse<PreservationScenarioModel> findPreservationScenario(VitamContext vitamContext,
 com.fasterxml.jackson.databind.JsonNode select)
                                                             throws VitamClientException

Throws:

VitamClientException

findGriffin

RequestResponse<GriffinModel> findGriffin(VitamContext vitamContext,
 com.fasterxml.jackson.databind.JsonNode select)
                                   throws VitamClientException

Throws:

VitamClientException

createExternalOperation

RequestResponse createExternalOperation(VitamContext vitamContext,
 LogbookOperationParameters logbookOperationparams)
                                 throws LogbookExternalClientException

Create external logbook operation entry

Parameters:

logbookOperationparams - the logbook parameters to be created

vitamContext - the vitam context

Returns:

RequestResponse status of the insertion

Throws:

LogbookExternalClientException

getUnitSchema

RequestResponse<SchemaResponse> getUnitSchema(VitamContext vitamContext)
                                       throws VitamClientException

get unit schema

Parameters:

vitamContext -

Returns:

Throws:

VitamClientException

getArchiveUnitProfileSchema

RequestResponse<CombinedSchemaModel> getArchiveUnitProfileSchema(VitamContext vitamContext,
 String id)
                                                          throws VitamClientException

get archive unit profile schema

Parameters:

vitamContext -

Returns:

Throws:

VitamClientException

importUnitExternalSchema

RequestResponse<Void> importUnitExternalSchema(VitamContext vitamContext,
 InputStream externalSchema)
                                        throws InvalidParseOperationException,
AccessExternalClientException

Import unit external schema

Parameters:

vitamContext -

externalSchema -

Returns:

Throws:

InvalidParseOperationException

AccessExternalClientException

deleteUnitExternalSchemas

RequestResponse<Void> deleteUnitExternalSchemas(VitamContext vitamContext,
 List<String> externalSchemaPaths)
                                         throws InvalidParseOperationException,
AccessExternalClientException

Delete unit external schema

Parameters:

vitamContext -

externalSchemaPaths -

Returns:

Throws:

InvalidParseOperationException

AccessExternalClientException

getObjectGroupSchema

RequestResponse<SchemaResponse> getObjectGroupSchema(VitamContext vitamContext)
                                              throws VitamClientException

get Object group schema

Parameters:

vitamContext -

Returns:

Throws:

VitamClientException

getPublicConfiguration

RequestResponse<PublicConfiguration> getPublicConfiguration(VitamContext vitamContext)
                                                     throws VitamClientException

Get vitam public configuration

Throws:

VitamClientException