Class AdminManagementClientMock
java.lang.Object
fr.gouv.vitam.common.client.AbstractMockClient
fr.gouv.vitam.functional.administration.client.AdminManagementClientMock
- All Implemented Interfaces:
MockOrRestClient,VitamAutoCloseable,AdminManagementClient,AutoCloseable
Mock client implementation for AdminManagement
-
Nested Class Summary
Nested classes/interfaces inherited from class fr.gouv.vitam.common.client.AbstractMockClient
AbstractMockClient.FakeInboundResponse -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionjavax.ws.rs.core.ResponsecheckAgenciesFile(InputStream stream) Check if agencies file is well formatedjavax.ws.rs.core.ResponsecheckFormat(InputStream stream) javax.ws.rs.core.ResponsecheckRulesFile(InputStream stream) Check if rule file is well formatedcreateAccessionRegisterSymbolic(List<Integer> tenants) Creates and return the accession register symbolic.createArchiveUnitProfiles(List<ArchiveUnitProfileModel> archiveUnitProfileModelList) Import a set of archive unit profile metadata.javax.ws.rs.core.Response.StatuscreateExternalOperation(LogbookOperationParameters logbookOperationparams) Create external logbook operation entry
createProfiles(List<ProfileModel> profileModelList) Import a set of profile If all the profiles are valid, they will be stored in the collection and indexed The input is invalid in the following situations : The json is invalid The json contains 2 ore many profile having the same name One or more mandatory field is missing A field has an invalid format One or many profiles already exist in the databasejavax.ws.rs.core.Response.StatusdeleteUnitExternalSchemas(List<String> paths) Delete one or more external schemas by path(s)javax.ws.rs.core.ResponsedownloadProfileFile(String profileMetadataId) Download the profile file according to profileMetadataIdRequestResponse<com.fasterxml.jackson.databind.JsonNode>evidenceAudit(com.fasterxml.jackson.databind.JsonNode query) launch a traceability audit for the unitRequestResponse<com.fasterxml.jackson.databind.JsonNode>exportProbativeValue(ProbativeValueRequest queryDsl) Launch an probative value export for the queryfindAccessContracts(com.fasterxml.jackson.databind.JsonNode queryDsl) Find access contracts By id mongo By the name By comlexe criteriafindAccessContractsByID(String documentId) findArchiveUnitProfiles(com.fasterxml.jackson.databind.JsonNode query) Find profiles according to the given json query (we can also use this method to find profile by identifier)findArchiveUnitProfilesByID(String requestedId) Find archive unit profile by technical id (id generated by the database)Find context by idfindContexts(com.fasterxml.jackson.databind.JsonNode queryDsl) Find contextsfindGriffin(com.fasterxml.jackson.databind.JsonNode dslQuery) findIngestContracts(com.fasterxml.jackson.databind.JsonNode query) RequestResponse<com.fasterxml.jackson.databind.JsonNode>findJobs()findManagementContracts(com.fasterxml.jackson.databind.JsonNode queryDsl) Find management contracts By id mongo By the name By comlexe criteriafindManagementContractsByID(String documentId) findOntologies(com.fasterxml.jackson.databind.JsonNode query) Find ontologies according to the given json query (we can also use this method to find ontology by identifier)findOntologyByID(String requestedId) Find the ontology by technical id (id generated by the database)findPreservation(com.fasterxml.jackson.databind.JsonNode dslQuery) findProfiles(com.fasterxml.jackson.databind.JsonNode query) Find profiles according to the given query string (we can also use this method to find profile by identifier)Find profile by id (id generated by the database)findSecurityProfileByIdentifier(String identifier) Find a security profile by identifierfindSecurityProfiles(com.fasterxml.jackson.databind.JsonNode queryDsl) Find security profiles by DSL query By internal id By identifier By name By comlexe criteriaforcePause(ProcessPause info) Pause the processes specified by ProcessPause infogetAccessionRegister(com.fasterxml.jackson.databind.JsonNode query) Get the accession register summary matching the given querygetAccessionRegisterDetail(com.fasterxml.jackson.databind.JsonNode query) Get the accession register details matching the given querygetAccessionRegisterDetail(String originatingAgency, com.fasterxml.jackson.databind.JsonNode query) Get the accession register details matching the given query for the specified contractgetAccessionRegisterSymbolic(Integer tenant, com.fasterxml.jackson.databind.JsonNode queryDsl) Retrieve the accession register symbolic regarding the tenant and a date range.com.fasterxml.jackson.databind.JsonNodegetAgencies(com.fasterxml.jackson.databind.JsonNode query) List the agencies that match the querygetAgencyById(String id) com.fasterxml.jackson.databind.JsonNodegetFormatByID(String id) getFormats(com.fasterxml.jackson.databind.JsonNode query) Get Vitam public configurationcom.fasterxml.jackson.databind.JsonNodegetRuleByID(String id) com.fasterxml.jackson.databind.JsonNodegetRules(com.fasterxml.jackson.databind.JsonNode query) List the rules that match the queryjavax.ws.rs.core.Response.StatusimportAccessContracts(List<AccessContractModel> accessContractModelList) Import 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 have an id already set 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 databasejavax.ws.rs.core.Response.StatusimportAgenciesFile(InputStream stream, String filename) Import agencies for a given tenantjavax.ws.rs.core.Response.StatusimportContexts(List<ContextModel> contextModelList) Import a set of contextjavax.ws.rs.core.Response.StatusimportFormat(InputStream stream, String filename) importGriffins(List<GriffinModel> griffinModelList) javax.ws.rs.core.Response.StatusimportIngestContracts(List<IngestContractModel> ingestContractModelList) Import 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 databasejavax.ws.rs.core.Response.StatusimportManagementContracts(List<ManagementContractModel> accessContractModelList) Import a set of management 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 have an id already set 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 One or many storage strategies are invalidimportOntologies(boolean forceUpdate, List<OntologyModel> ontologyModelList) Import a set of ontologies metadata.importPreservationScenarios(List<PreservationScenarioModel> preservationScenarioModelList) importProfileFile(String profileMetadataId, InputStream stream) javax.ws.rs.core.Response.StatusimportRulesFile(InputStream stream, String filename) Import a the set of rules for a given tenantjavax.ws.rs.core.Response.StatusimportSecurityProfiles(List<SecurityProfileModel> securityProfileModelList) Import a set of security profiles after passing the validation steps.javax.ws.rs.core.Response.StatusimportUnitExternalSchema(List<SchemaInputModel> externalSchemaInputList) Import a set of external unit schema.RequestResponse<com.fasterxml.jackson.databind.JsonNode>launchAuditWorkflow(AuditOptions options, boolean checkAccessContract) launch audit with optionsRequestResponse<com.fasterxml.jackson.databind.JsonNode>launchReferentialAudit(AuditReferentialOptions auditReferentialOptions) launchReindexation(com.fasterxml.jackson.databind.JsonNode options) launch a reindexation process with optionsRequestResponse<com.fasterxml.jackson.databind.JsonNode>launchRuleAudit(List<Integer> tenants) launch audit for rule managementvoidreconstructAccessionRegister(List<ReconstructionRequestItem> reconstructionItems) voidreconstructCollection(String collection) RequestResponse<com.fasterxml.jackson.databind.JsonNode>rectificationAudit(String operationId) Launch rectification AuditremoveForcePause(ProcessPause info) Remove the pause for the processes specified by ProcessPause infosecurityProfileIsUsedInContexts(String securityProfileId) Find if security profile is used in contextsswitchIndexes(com.fasterxml.jackson.databind.JsonNode options) launch an index switch.updateAccessContract(String id, com.fasterxml.jackson.databind.JsonNode queryDsl) Update AccessContract to mongoupdateArchiveUnitProfile(String id, com.fasterxml.jackson.databind.JsonNode queryDsl) Update a profileupdateContext(String id, com.fasterxml.jackson.databind.JsonNode queryDsl) Update context to mongoupdateIngestContract(String id, com.fasterxml.jackson.databind.JsonNode queryDsl) Update IngestContract to mongoupdateManagementContract(String id, com.fasterxml.jackson.databind.JsonNode queryDsl) Update ManagementContract to mongoupdateProfile(String id, com.fasterxml.jackson.databind.JsonNode queryDsl) Update a profileupdateSecurityProfile(String identifier, com.fasterxml.jackson.databind.JsonNode queryDsl) Updates a security contextMethods inherited from class fr.gouv.vitam.common.client.AbstractMockClient
checkStatus, checkStatus, close, consumeAnyEntityAndClose, getResourcePath, getServiceUrlMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface fr.gouv.vitam.common.client.MockOrRestClient
checkStatus, checkStatus, close, consumeAnyEntityAndClose, getResourcePath, getServiceUrl
-
Constructor Details
-
AdminManagementClientMock
public AdminManagementClientMock()
-
-
Method Details
-
checkFormat
- Specified by:
checkFormatin interfaceAdminManagementClient- Parameters:
stream- as InputStream;- Returns:
- Response
- Throws:
FileFormatException
-
importFormat
public javax.ws.rs.core.Response.Status importFormat(InputStream stream, String filename) throws FileFormatException - Specified by:
importFormatin interfaceAdminManagementClient- Parameters:
stream- as InputStreamfilename- name of the imported file- Returns:
- the response to the request
- Throws:
FileFormatException
-
getFormatByID
public com.fasterxml.jackson.databind.JsonNode getFormatByID(String id) throws InvalidParseOperationException - Specified by:
getFormatByIDin interfaceAdminManagementClient- Parameters:
id- as String- Returns:
- JsonNode
- Throws:
InvalidParseOperationException- when json exception occurs
-
getFormats
public RequestResponse<FileFormatModel> getFormats(com.fasterxml.jackson.databind.JsonNode query) throws FileFormatException, InvalidParseOperationException, IOException - Specified by:
getFormatsin interfaceAdminManagementClient- Parameters:
query- as JsonNode- Returns:
- JsonNode
- Throws:
InvalidParseOperationException- when json exception occursIOException- when io data exception occursFileFormatException
-
checkRulesFile
Description copied from interface:AdminManagementClientCheck if rule file is well formated- Specified by:
checkRulesFilein interfaceAdminManagementClient- Parameters:
stream- rule file inputstream to check- Returns:
- Response
- Throws:
FileRulesException
-
checkAgenciesFile
Description copied from interface:AdminManagementClientCheck if agencies file is well formated- Specified by:
checkAgenciesFilein interfaceAdminManagementClient- Parameters:
stream- agencies file inputstream to check- Returns:
- Response
-
importRulesFile
public javax.ws.rs.core.Response.Status importRulesFile(InputStream stream, String filename) throws ReferentialException, DatabaseConflictException Description copied from interface:AdminManagementClientImport a the set of rules for a given tenant- Specified by:
importRulesFilein interfaceAdminManagementClient- Parameters:
stream- rule file inputstream to importfilename- name of the imported file- Returns:
- the response to the request
- Throws:
ReferentialException- when file rules exception occursAdminManagementClientServerExceptionDatabaseConflictException- when Database conflict exception occurs
-
importAgenciesFile
public javax.ws.rs.core.Response.Status importAgenciesFile(InputStream stream, String filename) throws ReferentialException Description copied from interface:AdminManagementClientImport agencies for a given tenant- Specified by:
importAgenciesFilein interfaceAdminManagementClient- Parameters:
stream- agency file inputstream to importfilename- name of the imported file- Returns:
- the response to the request
- Throws:
ReferentialException- when file rules exception occursAdminManagementClientServerException
-
getAgencies
public com.fasterxml.jackson.databind.JsonNode getAgencies(com.fasterxml.jackson.databind.JsonNode query) throws InvalidParseOperationException Description copied from interface:AdminManagementClientList the agencies that match the query- Specified by:
getAgenciesin interfaceAdminManagementClient- Parameters:
query- to get agencies- Returns:
- The server response as vitam RequestResponse
- Throws:
InvalidParseOperationException- when a parse problem occurs
-
getRuleByID
public com.fasterxml.jackson.databind.JsonNode getRuleByID(String id) throws FileRulesException, InvalidParseOperationException - Specified by:
getRuleByIDin interfaceAdminManagementClient- Parameters:
id- The rule identifier- Returns:
- Rule in JsonNode format
- Throws:
FileRulesException- when file rules exception occursInvalidParseOperationException- when a parse problem occurs
-
getAgencyById
public RequestResponse<AgenciesModel> getAgencyById(String id) throws InvalidParseOperationException - Specified by:
getAgencyByIdin interfaceAdminManagementClient- Parameters:
id- The agency identifier- Returns:
- agency in JsonNode agency
- Throws:
InvalidParseOperationException- when a parse problem occurs
-
getRules
public com.fasterxml.jackson.databind.JsonNode getRules(com.fasterxml.jackson.databind.JsonNode query) throws FileRulesException, InvalidParseOperationException, IOException Description copied from interface:AdminManagementClientList the rules that match the query- Specified by:
getRulesin interfaceAdminManagementClient- Parameters:
query- to get rule- Returns:
- Rules in JsonNode format
- Throws:
FileRulesException- when file rules exception occursInvalidParseOperationException- when a parse problem occursIOException- when IO Exception occurs
-
createOrUpdateAccessionRegister
- Specified by:
createOrUpdateAccessionRegisterin interfaceAdminManagementClient- Parameters:
register- AccessionRegisterDetail
-
getAccessionRegister
public RequestResponse getAccessionRegister(com.fasterxml.jackson.databind.JsonNode query) throws InvalidParseOperationException Description copied from interface:AdminManagementClientGet the accession register summary matching the given query- Specified by:
getAccessionRegisterin interfaceAdminManagementClient- Parameters:
query- The DSL Query as JsonNode- Returns:
- instance of RequestResponse of type AccessionRegisterSummaryModel
- Throws:
InvalidParseOperationException
-
getAccessionRegisterDetail
public RequestResponse getAccessionRegisterDetail(String originatingAgency, com.fasterxml.jackson.databind.JsonNode query) throws InvalidParseOperationException Description copied from interface:AdminManagementClientGet the accession register details matching the given query for the specified contract- Specified by:
getAccessionRegisterDetailin interfaceAdminManagementClientquery- The DSL Query as a JSON Node- Returns:
- The AccessionregisterDetails list as a response jsonNode
- Throws:
InvalidParseOperationException
-
getAccessionRegisterDetail
public RequestResponse<AccessionRegisterDetailModel> getAccessionRegisterDetail(com.fasterxml.jackson.databind.JsonNode query) Description copied from interface:AdminManagementClientGet the accession register details matching the given query- Specified by:
getAccessionRegisterDetailin interfaceAdminManagementClient- Parameters:
query- The DSL Query as a JSON Node- Returns:
- The AccessionregisterDetails list as a response jsonNode
-
importIngestContracts
public javax.ws.rs.core.Response.Status importIngestContracts(List<IngestContractModel> ingestContractModelList) Description copied from interface:AdminManagementClientImport 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:
importIngestContractsin interfaceAdminManagementClient- Parameters:
ingestContractModelList- the contract to import- Returns:
- The server response as vitam RequestResponse
-
importAccessContracts
public javax.ws.rs.core.Response.Status importAccessContracts(List<AccessContractModel> accessContractModelList) throws InvalidParseOperationException, AdminManagementClientServerException Description copied from interface:AdminManagementClientImport 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 have an id already set
- 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:
importAccessContractsin interfaceAdminManagementClient- Parameters:
accessContractModelList- the list contract to import- Returns:
- The server response as vitam RequestResponse
- Throws:
InvalidParseOperationExceptionAdminManagementClientServerException
-
importManagementContracts
public javax.ws.rs.core.Response.Status importManagementContracts(List<ManagementContractModel> accessContractModelList) throws InvalidParseOperationException, AdminManagementClientServerException Description copied from interface:AdminManagementClientImport a set of management 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 have an id already set
- 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
- One or many storage strategies are invalid
- Specified by:
importManagementContractsin interfaceAdminManagementClient- Parameters:
accessContractModelList- the list contract to import- Returns:
- The server response as vitam RequestResponse
- Throws:
InvalidParseOperationExceptionAdminManagementClientServerException
-
findAccessContracts
public RequestResponse findAccessContracts(com.fasterxml.jackson.databind.JsonNode queryDsl) throws InvalidParseOperationException, AdminManagementClientServerException Description copied from interface:AdminManagementClientFind access contracts- By id mongo
- By the name
- By comlexe criteria
- Specified by:
findAccessContractsin interfaceAdminManagementClient- Returns:
- The server response as vitam RequestResponse
- Throws:
InvalidParseOperationExceptionAdminManagementClientServerException
-
findAccessContractsByID
public RequestResponse findAccessContractsByID(String documentId) throws InvalidParseOperationException - Specified by:
findAccessContractsByIDin interfaceAdminManagementClient- Returns:
- The server response as vitam RequestResponse
- Throws:
InvalidParseOperationException
-
findIngestContracts
public RequestResponse<IngestContractModel> findIngestContracts(com.fasterxml.jackson.databind.JsonNode query) throws InvalidParseOperationException, AdminManagementClientServerException - Specified by:
findIngestContractsin interfaceAdminManagementClient- Returns:
- The server response as vitam RequestResponse
- Throws:
InvalidParseOperationExceptionAdminManagementClientServerException
-
findIngestContractsByID
public RequestResponse<IngestContractModel> findIngestContractsByID(String id) throws InvalidParseOperationException, AdminManagementClientServerException, ReferentialNotFoundException - Specified by:
findIngestContractsByIDin interfaceAdminManagementClient- Returns:
- The server response as vitam RequestResponse
- Throws:
InvalidParseOperationExceptionAdminManagementClientServerExceptionReferentialNotFoundException
-
findManagementContracts
public RequestResponse findManagementContracts(com.fasterxml.jackson.databind.JsonNode queryDsl) throws InvalidParseOperationException, AdminManagementClientServerException Description copied from interface:AdminManagementClientFind management contracts- By id mongo
- By the name
- By comlexe criteria
- Specified by:
findManagementContractsin interfaceAdminManagementClient- Returns:
- The server response as vitam RequestResponse
- Throws:
InvalidParseOperationExceptionAdminManagementClientServerException
-
findManagementContractsByID
public RequestResponse findManagementContractsByID(String documentId) throws InvalidParseOperationException, AdminManagementClientServerException - Specified by:
findManagementContractsByIDin interfaceAdminManagementClient- Returns:
- The server response as vitam RequestResponse
- Throws:
InvalidParseOperationExceptionAdminManagementClientServerException
-
createProfiles
public RequestResponse createProfiles(List<ProfileModel> profileModelList) throws InvalidParseOperationException, AdminManagementClientServerException Description copied from interface:AdminManagementClientImport a set of profile If all the profiles are valid, they will be stored in the collection and indexed The input is invalid in the following situations :- The json is invalid
- The json contains 2 ore many profile having the same name
- One or more mandatory field is missing
- A field has an invalid format
- One or many profiles already exist in the database
- Specified by:
createProfilesin interfaceAdminManagementClient- Parameters:
profileModelList- the list profile to import- Returns:
- The server response as vitam RequestResponse
- Throws:
InvalidParseOperationExceptionAdminManagementClientServerException
-
importProfileFile
public RequestResponse importProfileFile(String profileMetadataId, InputStream stream) throws ReferentialException, DatabaseConflictException - Specified by:
importProfileFilein interfaceAdminManagementClient- Parameters:
profileMetadataId- the id of the profile metadata corresponding to the filestream- as InputStream- Returns:
- the response to the request
- Throws:
ReferentialException- when import exception occursDatabaseConflictException- conflict exception occurs
-
downloadProfileFile
public javax.ws.rs.core.Response downloadProfileFile(String profileMetadataId) throws AdminManagementClientServerException, ProfileNotFoundException Description copied from interface:AdminManagementClientDownload the profile file according to profileMetadataId- Specified by:
downloadProfileFilein interfaceAdminManagementClient- Returns:
- Response
- Throws:
AdminManagementClientServerExceptionProfileNotFoundException
-
findProfiles
public RequestResponse<ProfileModel> findProfiles(com.fasterxml.jackson.databind.JsonNode query) throws InvalidParseOperationException, AdminManagementClientServerException Description copied from interface:AdminManagementClientFind profiles according to the given query string (we can also use this method to find profile by identifier)- Specified by:
findProfilesin interfaceAdminManagementClient- Returns:
- The server response as vitam RequestResponse
- Throws:
InvalidParseOperationExceptionAdminManagementClientServerException
-
findProfilesByID
public RequestResponse<ProfileModel> findProfilesByID(String id) throws InvalidParseOperationException, AdminManagementClientServerException, ReferentialNotFoundException Description copied from interface:AdminManagementClientFind profile by id (id generated by the database)- Specified by:
findProfilesByIDin interfaceAdminManagementClient- Returns:
- The server response as vitam RequestResponse
- Throws:
InvalidParseOperationExceptionAdminManagementClientServerExceptionReferentialNotFoundException
-
createArchiveUnitProfiles
public RequestResponse createArchiveUnitProfiles(List<ArchiveUnitProfileModel> archiveUnitProfileModelList) throws InvalidParseOperationException, AdminManagementClientServerException Description copied from interface:AdminManagementClientImport a set of archive unit profile metadata. If all the archive unit profiles are valid, they will be stored in the collection and indexed The input is invalid in the following situations :- The json is invalid
- The json contains 2 ore many profile having the same name
- One or more mandatory field is missing
- A field has an invalid format
- One or many profiles already exist in the database
- Specified by:
createArchiveUnitProfilesin interfaceAdminManagementClient- Parameters:
archiveUnitProfileModelList- the list profile to import- Returns:
- The server response as vitam RequestResponse
- Throws:
InvalidParseOperationExceptionAdminManagementClientServerException
-
findArchiveUnitProfiles
public RequestResponse<ArchiveUnitProfileModel> findArchiveUnitProfiles(com.fasterxml.jackson.databind.JsonNode query) throws InvalidParseOperationException, AdminManagementClientServerException Description copied from interface:AdminManagementClientFind profiles according to the given json query (we can also use this method to find profile by identifier)- Specified by:
findArchiveUnitProfilesin interfaceAdminManagementClient- Returns:
- The server response as vitam RequestResponse
- Throws:
InvalidParseOperationExceptionAdminManagementClientServerException
-
findArchiveUnitProfilesByID
public RequestResponse<ArchiveUnitProfileModel> findArchiveUnitProfilesByID(String requestedId) throws InvalidParseOperationException, AdminManagementClientServerException, ReferentialNotFoundException Description copied from interface:AdminManagementClientFind archive unit profile by technical id (id generated by the database)- Specified by:
findArchiveUnitProfilesByIDin interfaceAdminManagementClient- Returns:
- The server response as vitam RequestResponse
- Throws:
InvalidParseOperationExceptionAdminManagementClientServerExceptionReferentialNotFoundException
-
updateArchiveUnitProfile
public RequestResponse<ArchiveUnitProfileModel> updateArchiveUnitProfile(String id, com.fasterxml.jackson.databind.JsonNode queryDsl) throws InvalidParseOperationException, AdminManagementClientServerException, ReferentialNotFoundException Description copied from interface:AdminManagementClientUpdate a profile- Specified by:
updateArchiveUnitProfilein interfaceAdminManagementClient- Returns:
- the updated ProfileModel for success
- Throws:
InvalidParseOperationExceptionAdminManagementClientServerExceptionReferentialNotFoundException
-
updateAccessContract
public RequestResponse<AccessContractModel> updateAccessContract(String id, com.fasterxml.jackson.databind.JsonNode queryDsl) throws InvalidParseOperationException, AdminManagementClientServerException Description copied from interface:AdminManagementClientUpdate AccessContract to mongo- Specified by:
updateAccessContractin interfaceAdminManagementClient- Parameters:
id- the given access contract id to updatequeryDsl- query to execute- Returns:
- The server response as vitam RequestResponse
- Throws:
InvalidParseOperationExceptionAdminManagementClientServerException
-
updateIngestContract
public RequestResponse<IngestContractModel> updateIngestContract(String id, com.fasterxml.jackson.databind.JsonNode queryDsl) throws InvalidParseOperationException, AdminManagementClientServerException Description copied from interface:AdminManagementClientUpdate IngestContract to mongo- Specified by:
updateIngestContractin interfaceAdminManagementClient- Parameters:
id- the given Ingest contract id to updatequeryDsl- query to execute- Returns:
- The server response as vitam RequestResponse
- Throws:
InvalidParseOperationExceptionAdminManagementClientServerException
-
updateManagementContract
public RequestResponse<ManagementContractModel> updateManagementContract(String id, com.fasterxml.jackson.databind.JsonNode queryDsl) throws InvalidParseOperationException, AdminManagementClientServerException Description copied from interface:AdminManagementClientUpdate ManagementContract to mongo- Specified by:
updateManagementContractin interfaceAdminManagementClient- Parameters:
id- the given access contract id to updatequeryDsl- query to execute- Returns:
- The server response as vitam RequestResponse
- Throws:
InvalidParseOperationExceptionAdminManagementClientServerException
-
importContexts
public javax.ws.rs.core.Response.Status importContexts(List<ContextModel> contextModelList) throws ReferentialException Description copied from interface:AdminManagementClientImport a set of context- Specified by:
importContextsin interfaceAdminManagementClient- Returns:
- Status
- Throws:
ReferentialException
-
updateContext
public RequestResponse<ContextModel> updateContext(String id, com.fasterxml.jackson.databind.JsonNode queryDsl) throws InvalidParseOperationException Description copied from interface:AdminManagementClientUpdate context to mongo- Specified by:
updateContextin interfaceAdminManagementClient- Returns:
- The server response as vitam RequestResponse
- Throws:
InvalidParseOperationException
-
findContexts
public RequestResponse<ContextModel> findContexts(com.fasterxml.jackson.databind.JsonNode queryDsl) throws InvalidParseOperationException Description copied from interface:AdminManagementClientFind contexts- Specified by:
findContextsin interfaceAdminManagementClient- Returns:
- The server response as vitam RequestResponse
- Throws:
InvalidParseOperationException
-
findContextById
public RequestResponse<ContextModel> findContextById(String id) throws InvalidParseOperationException Description copied from interface:AdminManagementClientFind context by id- Specified by:
findContextByIdin interfaceAdminManagementClient- Returns:
- The server response as vitam RequestResponse
- Throws:
InvalidParseOperationException
-
securityProfileIsUsedInContexts
public RequestResponse<Boolean> securityProfileIsUsedInContexts(String securityProfileId) throws InvalidParseOperationException, ReferentialNotFoundException, AdminManagementClientServerException Description copied from interface:AdminManagementClientFind if security profile is used in contexts- Specified by:
securityProfileIsUsedInContextsin interfaceAdminManagementClient- Returns:
- The server response as vitam RequestResponse
- Throws:
InvalidParseOperationExceptionReferentialNotFoundExceptionAdminManagementClientServerException
-
launchAuditWorkflow
public RequestResponse<com.fasterxml.jackson.databind.JsonNode> launchAuditWorkflow(AuditOptions options, boolean checkAccessContract) throws AdminManagementClientServerException Description copied from interface:AdminManagementClientlaunch audit with options- Specified by:
launchAuditWorkflowin interfaceAdminManagementClient- Returns:
- Throws:
AdminManagementClientServerException
-
launchRuleAudit
public RequestResponse<com.fasterxml.jackson.databind.JsonNode> launchRuleAudit(List<Integer> tenants) Description copied from interface:AdminManagementClientlaunch audit for rule management- Specified by:
launchRuleAuditin interfaceAdminManagementClient- Returns:
- The server response as vitam RequestResponse
-
launchReferentialAudit
public RequestResponse<com.fasterxml.jackson.databind.JsonNode> launchReferentialAudit(AuditReferentialOptions auditReferentialOptions) - Specified by:
launchReferentialAuditin interfaceAdminManagementClient
-
importSecurityProfiles
public javax.ws.rs.core.Response.Status importSecurityProfiles(List<SecurityProfileModel> securityProfileModelList) throws InvalidParseOperationException, AdminManagementClientServerException Description copied from interface:AdminManagementClientImport a set of security profiles after passing the validation steps. If all the security profiles are valid, they are stored in the database. The input is invalid in the following situations :- The json is invalid
- The json contains 2 ore many contracts having the same name or identifier
- One or more mandatory field is missing
- A field has an invalid format
- One or many security profiles already exist in the database
- Specified by:
importSecurityProfilesin interfaceAdminManagementClient- Parameters:
securityProfileModelList- the security profiles to import- Returns:
- The server response as vitam RequestResponse
- Throws:
InvalidParseOperationExceptionAdminManagementClientServerException
-
findSecurityProfiles
public RequestResponse findSecurityProfiles(com.fasterxml.jackson.databind.JsonNode queryDsl) throws InvalidParseOperationException Description copied from interface:AdminManagementClientFind security profiles by DSL query- By internal id
- By identifier
- By name
- By comlexe criteria
- Specified by:
findSecurityProfilesin interfaceAdminManagementClient- Parameters:
queryDsl- the DSL query- Returns:
- The server response as vitam RequestResponse
- Throws:
InvalidParseOperationException
-
findSecurityProfileByIdentifier
public RequestResponse findSecurityProfileByIdentifier(String identifier) throws InvalidParseOperationException Description copied from interface:AdminManagementClientFind a security profile by identifier- Specified by:
findSecurityProfileByIdentifierin interfaceAdminManagementClient- Parameters:
identifier- the identifier of the security profile- Returns:
- The server response as vitam RequestResponse
- Throws:
InvalidParseOperationException
-
updateSecurityProfile
public RequestResponse<SecurityProfileModel> updateSecurityProfile(String identifier, com.fasterxml.jackson.databind.JsonNode queryDsl) throws InvalidParseOperationException, AdminManagementClientServerException Description copied from interface:AdminManagementClientUpdates a security context- Specified by:
updateSecurityProfilein interfaceAdminManagementClient- Parameters:
identifier- the identifier of the security profile to updatequeryDsl- query to execute- Returns:
- The server response as vitam RequestResponse
- Throws:
InvalidParseOperationExceptionAdminManagementClientServerException
-
updateProfile
public RequestResponse<ProfileModel> updateProfile(String id, com.fasterxml.jackson.databind.JsonNode queryDsl) throws InvalidParseOperationException, AdminManagementClientServerException Description copied from interface:AdminManagementClientUpdate a profile- Specified by:
updateProfilein interfaceAdminManagementClient- Returns:
- Throws:
InvalidParseOperationExceptionAdminManagementClientServerException
-
launchReindexation
public RequestResponse<ReindexationResult> launchReindexation(com.fasterxml.jackson.databind.JsonNode options) throws AdminManagementClientServerException Description copied from interface:AdminManagementClientlaunch a reindexation process with options- Specified by:
launchReindexationin interfaceAdminManagementClient- Parameters:
options- specifying what to reindex- Returns:
- the server response including information about the newsly created index
- Throws:
AdminManagementClientServerException
-
switchIndexes
public RequestResponse<ReindexationResult> switchIndexes(com.fasterxml.jackson.databind.JsonNode options) throws AdminManagementClientServerException Description copied from interface:AdminManagementClientlaunch an index switch. By specifying the name of the index and the collection, the index will be mapped to the correct alias- Specified by:
switchIndexesin interfaceAdminManagementClient- Returns:
- the server response
- Throws:
AdminManagementClientServerException
-
evidenceAudit
public RequestResponse<com.fasterxml.jackson.databind.JsonNode> evidenceAudit(com.fasterxml.jackson.databind.JsonNode query) throws AdminManagementClientServerException Description copied from interface:AdminManagementClientlaunch a traceability audit for the unit- Specified by:
evidenceAuditin interfaceAdminManagementClient- Parameters:
query- the id- Returns:
- the server response
- Throws:
AdminManagementClientServerException
-
rectificationAudit
public RequestResponse<com.fasterxml.jackson.databind.JsonNode> rectificationAudit(String operationId) Description copied from interface:AdminManagementClientLaunch rectification Audit- Specified by:
rectificationAuditin interfaceAdminManagementClient- Parameters:
operationId- operation Id- Returns:
- RequestResponse
-
exportProbativeValue
public RequestResponse<com.fasterxml.jackson.databind.JsonNode> exportProbativeValue(ProbativeValueRequest queryDsl) Description copied from interface:AdminManagementClientLaunch an probative value export for the query- Specified by:
exportProbativeValuein interfaceAdminManagementClient- Parameters:
queryDsl- the id- Returns:
- the server response
-
importOntologies
public RequestResponse importOntologies(boolean forceUpdate, List<OntologyModel> ontologyModelList) throws InvalidParseOperationException, AdminManagementClientServerException Description copied from interface:AdminManagementClientImport 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
- Specified by:
importOntologiesin interfaceAdminManagementClientontologyModelList- the list of ontologies to import- Returns:
- The server response as vitam RequestResponse
- Throws:
InvalidParseOperationExceptionAdminManagementClientServerException
-
findOntologies
public RequestResponse<OntologyModel> findOntologies(com.fasterxml.jackson.databind.JsonNode query) throws InvalidParseOperationException Description copied from interface:AdminManagementClientFind ontologies according to the given json query (we can also use this method to find ontology by identifier)- Specified by:
findOntologiesin interfaceAdminManagementClient- Returns:
- The server response as vitam RequestResponse
- Throws:
InvalidParseOperationException
-
findOntologyByID
public RequestResponse<OntologyModel> findOntologyByID(String requestedId) throws InvalidParseOperationException, AdminManagementClientServerException, ReferentialNotFoundException Description copied from interface:AdminManagementClientFind the ontology by technical id (id generated by the database)- Specified by:
findOntologyByIDin interfaceAdminManagementClient- Returns:
- The server response as vitam RequestResponse
- Throws:
InvalidParseOperationExceptionAdminManagementClientServerExceptionReferentialNotFoundException
-
forcePause
Description copied from interface:AdminManagementClientPause the processes specified by ProcessPause info- Specified by:
forcePausein interfaceAdminManagementClient- Parameters:
info- a ProcessPause object indicating the tenant and/or the type of process to pause- Returns:
- The server response as vitam RequestResponse
-
removeForcePause
Description copied from interface:AdminManagementClientRemove the pause for the processes specified by ProcessPause info- Specified by:
removeForcePausein interfaceAdminManagementClient- Parameters:
info- a ProcessPause object indicating the tenant and/or the type of process to pause- Returns:
- The server response as vitam RequestResponse
-
createAccessionRegisterSymbolic
public RequestResponse<AccessionRegisterSymbolic> createAccessionRegisterSymbolic(List<Integer> tenants) Description copied from interface:AdminManagementClientCreates and return the accession register symbolic.- Specified by:
createAccessionRegisterSymbolicin interfaceAdminManagementClient- Parameters:
tenants- tenants list- Returns:
- the accession register created
-
getAccessionRegisterSymbolic
public RequestResponse<AccessionRegisterSymbolicModel> getAccessionRegisterSymbolic(Integer tenant, com.fasterxml.jackson.databind.JsonNode queryDsl) throws AdminManagementClientServerException Description copied from interface:AdminManagementClientRetrieve the accession register symbolic regarding the tenant and a date range.- Specified by:
getAccessionRegisterSymbolicin interfaceAdminManagementClient- Parameters:
tenant- related to the accession registerqueryDsl- search by dsl- Returns:
- a lis of accession register symbolic or a empty list if nothing is found
- Throws:
AdminManagementClientServerException
-
importGriffins
public RequestResponse importGriffins(List<GriffinModel> griffinModelList) throws AdminManagementClientServerException - Specified by:
importGriffinsin interfaceAdminManagementClient- Throws:
AdminManagementClientServerException
-
importPreservationScenarios
public RequestResponse importPreservationScenarios(List<PreservationScenarioModel> preservationScenarioModelList) throws AdminManagementClientServerException - Specified by:
importPreservationScenariosin interfaceAdminManagementClient- Throws:
AdminManagementClientServerException
-
findGriffinByID
public RequestResponse<GriffinModel> findGriffinByID(String id) throws InvalidParseOperationException, AdminManagementClientServerException, ReferentialNotFoundException - Specified by:
findGriffinByIDin interfaceAdminManagementClient- Throws:
InvalidParseOperationExceptionAdminManagementClientServerExceptionReferentialNotFoundException
-
findPreservationByID
public RequestResponse<PreservationScenarioModel> findPreservationByID(String id) throws InvalidParseOperationException, AdminManagementClientServerException, ReferentialNotFoundException - Specified by:
findPreservationByIDin interfaceAdminManagementClient- Throws:
InvalidParseOperationExceptionAdminManagementClientServerExceptionReferentialNotFoundException
-
findPreservation
public RequestResponse<PreservationScenarioModel> findPreservation(com.fasterxml.jackson.databind.JsonNode dslQuery) throws AdminManagementClientServerException, InvalidParseOperationException, ReferentialNotFoundException - Specified by:
findPreservationin interfaceAdminManagementClient- Throws:
AdminManagementClientServerExceptionInvalidParseOperationExceptionReferentialNotFoundException
-
findGriffin
- Specified by:
findGriffinin interfaceAdminManagementClient
-
createExternalOperation
public javax.ws.rs.core.Response.Status createExternalOperation(LogbookOperationParameters logbookOperationparams) throws AdminManagementClientServerException, BadRequestException, LogbookClientAlreadyExistsException Description copied from interface:AdminManagementClientCreate external logbook operation entry
- Specified by:
createExternalOperationin interfaceAdminManagementClient- Parameters:
logbookOperationparams- the logbook parameters to be created- Returns:
- RequestResponse status of the insertion
- Throws:
AdminManagementClientServerExceptionBadRequestExceptionLogbookClientAlreadyExistsException
-
findJobs
- Specified by:
findJobsin interfaceAdminManagementClient
-
reconstructCollection
- Specified by:
reconstructCollectionin interfaceAdminManagementClient- Throws:
AdminManagementClientServerException
-
reconstructAccessionRegister
public void reconstructAccessionRegister(List<ReconstructionRequestItem> reconstructionItems) throws AdminManagementClientServerException - Specified by:
reconstructAccessionRegisterin interfaceAdminManagementClient- Throws:
AdminManagementClientServerException
-
getUnitSchema
- Specified by:
getUnitSchemain interfaceAdminManagementClient- Throws:
AdminManagementClientServerException
-
getArchiveUnitProfileSchema
public RequestResponse<CombinedSchemaModel> getArchiveUnitProfileSchema(String id) throws AdminManagementClientServerException - Specified by:
getArchiveUnitProfileSchemain interfaceAdminManagementClient- Throws:
AdminManagementClientServerException
-
getObjectGroupSchema
- Specified by:
getObjectGroupSchemain interfaceAdminManagementClient
-
importUnitExternalSchema
public javax.ws.rs.core.Response.Status importUnitExternalSchema(List<SchemaInputModel> externalSchemaInputList) Description copied from interface:AdminManagementClientImport a set of external unit schema.- The json is invalid
- The json contains an already used identifier
- One or more mandatory field is missing
- A field has an invalid format
- Specified by:
importUnitExternalSchemain interfaceAdminManagementClient- Parameters:
externalSchemaInputList- the list of external unit schema to import- Returns:
- The server response as vitam RequestResponse
-
deleteUnitExternalSchemas
Description copied from interface:AdminManagementClientDelete one or more external schemas by path(s)- Specified by:
deleteUnitExternalSchemasin interfaceAdminManagementClient- Parameters:
paths- schemas paths- Returns:
- status
-
getPublicConfiguration
Description copied from interface:AdminManagementClientGet Vitam public configuration- Specified by:
getPublicConfigurationin interfaceAdminManagementClient
-