Class AdminManagementResource
java.lang.Object
fr.gouv.vitam.common.server.application.resources.ApplicationStatusResource
fr.gouv.vitam.functional.administration.rest.AdminManagementResource
@Path("/adminmanagement/v1")
@ApplicationPath("webresources")
public class AdminManagementResource
extends ApplicationStatusResource
-
Field Summary
Fields inherited from class fr.gouv.vitam.common.server.application.resources.ApplicationStatusResource
STATUS_URL, TENANTS_URL -
Constructor Summary
ConstructorsConstructorDescriptionAdminManagementResource(AdminManagementConfiguration configuration, OntologyLoader ontologyLoader, ElasticsearchFunctionalAdminIndexManager indexManager) -
Method Summary
Modifier and TypeMethodDescriptionjavax.ws.rs.core.ResponseaddExternalOperation(LogbookOperationParameters operation) Create a new logbook operation entry in Vitamjavax.ws.rs.core.ResponsecheckFormat(InputStream xmlPronom) check the file formatjavax.ws.rs.core.ResponsecheckRulesFile(InputStream rulesStream) check the rules filejavax.ws.rs.core.ResponsecreateAccessionRegister(AccessionRegisterDetailModel accessionRegister) create or update an accession registerjavax.ws.rs.core.ResponsecreateAccessionRegisterSymbolic(List<Integer> tenants) javax.ws.rs.core.ResponsefindDetailAccessionRegister(com.fasterxml.jackson.databind.JsonNode select) retrieve accession register detail based on a given dsl queryjavax.ws.rs.core.ResponsefindDetailAccessionRegister(String originatingAgency, com.fasterxml.jackson.databind.JsonNode select) retrieve accession register detail based on a given dsl queryjavax.ws.rs.core.ResponsefindDocumentFundsRegister(com.fasterxml.jackson.databind.JsonNode select) retrieve all accession summary from accession summary collectionjavax.ws.rs.core.ResponsefindDocumentRules(com.fasterxml.jackson.databind.JsonNode select) show all file rules inserted in the collection fileRulesjavax.ws.rs.core.ResponsefindFileFormatByID(String formatId, javax.ws.rs.core.Request request) Find the file format detail related to a specified Idjavax.ws.rs.core.ResponsefindFormats(com.fasterxml.jackson.databind.JsonNode select) retrieve all the file format inserted in the collection fileFormatjavax.ws.rs.core.ResponsefindRuleByID(String ruleId, javax.ws.rs.core.Request request) findRuleByID : find the rules details based on a given Idjavax.ws.rs.core.ResponseforcePause(ProcessPause info) Pause the processes specified by ProcessPause infojavax.ws.rs.core.ResponsegetAccessionRegisterSymbolic(com.fasterxml.jackson.databind.JsonNode queryDsl) javax.ws.rs.core.ResponseimportFormat(javax.ws.rs.core.HttpHeaders headers, InputStream xmlPronom) import the file formatjavax.ws.rs.core.ResponseimportRulesFile(javax.ws.rs.core.HttpHeaders headers, InputStream rulesStream) import the rules filejavax.ws.rs.core.ResponselaunchAudit(AuditOptions options, boolean checkAccessContract) Launch audit with optionsjavax.ws.rs.core.ResponselaunchReferentialAudit(AuditReferentialOptions referentialAuditOptions) Launch referential audit with optionsjavax.ws.rs.core.ResponselaunchRuleAudit(List<Integer> tenants) javax.ws.rs.core.ResponseremoveForcePause(ProcessPause info) Remove the pause for the processes specified by ProcessPause infovoidsetVitamCounterService(VitamCounterService vitamCounterService) Methods inherited from class fr.gouv.vitam.common.server.application.resources.ApplicationStatusResource
getServerTenants, status
-
Constructor Details
-
AdminManagementResource
public AdminManagementResource(AdminManagementConfiguration configuration, OntologyLoader ontologyLoader, ElasticsearchFunctionalAdminIndexManager indexManager)
-
-
Method Details
-
checkFormat
@Path("format/check") @POST @Consumes("application/octet-stream") @Produces("application/json") public javax.ws.rs.core.Response checkFormat(InputStream xmlPronom) check the file format- Parameters:
xmlPronom- as InputStream- Returns:
- Response
-
importFormat
@Path("format/import") @POST @Consumes("application/octet-stream") @Produces("application/json") public javax.ws.rs.core.Response importFormat(@Context javax.ws.rs.core.HttpHeaders headers, InputStream xmlPronom) import the file format- Parameters:
headers- http headersxmlPronom- as InputStream- Returns:
- response
-
findFileFormatByID
@GET @Path("format/{id_format:.+}") @Produces("application/json") public javax.ws.rs.core.Response findFileFormatByID(@PathParam("id_format") String formatId, @Context javax.ws.rs.core.Request request) Find the file format detail related to a specified Id- Parameters:
formatId- path param as Stringrequest-- Returns:
- Response
-
findFormats
@Path("format/document") @POST @Consumes("application/json") @Produces("application/json") public javax.ws.rs.core.Response findFormats(com.fasterxml.jackson.databind.JsonNode select) retrieve all the file format inserted in the collection fileFormat- Parameters:
select- as String the query to get format- Returns:
- Response
-
checkRulesFile
@Path("rules/check") @POST @Consumes("application/octet-stream") @Produces("application/octet-stream") public javax.ws.rs.core.Response checkRulesFile(InputStream rulesStream) check the rules file- Parameters:
rulesStream- as InputStream- Returns:
- Response
-
importRulesFile
@Path("rules/import") @POST @Consumes("application/octet-stream") @Produces("application/json") public javax.ws.rs.core.Response importRulesFile(@Context javax.ws.rs.core.HttpHeaders headers, InputStream rulesStream) import the rules file- Parameters:
headers- http headersrulesStream- as InputStream- Returns:
- Response
-
findRuleByID
@GET @Path("rules/{id_rule}") @Produces("application/json") public javax.ws.rs.core.Response findRuleByID(@PathParam("id_rule") String ruleId, @Context javax.ws.rs.core.Request request) findRuleByID : find the rules details based on a given Id- Parameters:
ruleId- path param as Stringrequest- the request- Returns:
- Response
-
findDocumentRules
@Path("rules/document") @POST @Consumes("application/json") @Produces("application/json") public javax.ws.rs.core.Response findDocumentRules(com.fasterxml.jackson.databind.JsonNode select) show all file rules inserted in the collection fileRules- Parameters:
select- as String- Returns:
- Response
-
createAccessionRegister
@Path("accession-register") @POST @Consumes("application/json") @Produces("application/json") public javax.ws.rs.core.Response createAccessionRegister(AccessionRegisterDetailModel accessionRegister) create or update an accession register- Parameters:
accessionRegister- AccessionRegisterDetail object- Returns:
- Response
-
findDocumentFundsRegister
@Path("accession-register/document") @POST @Consumes("application/json") @Produces("application/json") public javax.ws.rs.core.Response findDocumentFundsRegister(com.fasterxml.jackson.databind.JsonNode select) retrieve all accession summary from accession summary collection- Parameters:
select- as String the query to find accession register- Returns:
- Response
-
findDetailAccessionRegister
@Path("accession-register/detail/{id}") @POST @Consumes("application/json") @Produces("application/json") public javax.ws.rs.core.Response findDetailAccessionRegister(@PathParam("id") String originatingAgency, com.fasterxml.jackson.databind.JsonNode select) retrieve accession register detail based on a given dsl query- Parameters:
originatingAgency-select- as String the query to find the accession register- Returns:
- Response
-
findDetailAccessionRegister
@Path("accession-register/detail") @POST @Consumes("application/json") @Produces("application/json") public javax.ws.rs.core.Response findDetailAccessionRegister(com.fasterxml.jackson.databind.JsonNode select) retrieve accession register detail based on a given dsl query- Parameters:
select- as String the query to find the accession register- Returns:
- Response
-
launchReferentialAudit
@Path("/audit/referential") @POST @Consumes("application/json") @Produces("application/json") public javax.ws.rs.core.Response launchReferentialAudit(AuditReferentialOptions referentialAuditOptions) Launch referential audit with options- Returns:
- Response
-
launchRuleAudit
-
launchAudit
@Path("/audit") @POST @Consumes("application/json") @Produces("application/json") public javax.ws.rs.core.Response launchAudit(AuditOptions options, @HeaderParam("Check-Access-Contract") boolean checkAccessContract) Launch audit with options- Parameters:
options-- Returns:
- Response
-
createAccessionRegisterSymbolic
-
getAccessionRegisterSymbolic
@GET @Path("accession-register/symbolic") @Consumes("application/json") @Produces("application/json") public javax.ws.rs.core.Response getAccessionRegisterSymbolic(com.fasterxml.jackson.databind.JsonNode queryDsl) -
forcePause
@Path("/forcepause") @POST @Consumes("application/json") @Produces("application/json") public javax.ws.rs.core.Response forcePause(ProcessPause info) Pause the processes specified by ProcessPause info- Parameters:
info- a ProcessPause object indicating the tenant and/or the type of process to pause- Returns:
-
removeForcePause
@Path("/removeforcepause") @POST @Consumes("application/json") @Produces("application/json") public javax.ws.rs.core.Response removeForcePause(ProcessPause info) Remove the pause for the processes specified by ProcessPause info- Parameters:
info- a ProcessPause object indicating the tenant and/or the type of process to pause- Returns:
-
setVitamCounterService
- Parameters:
vitamCounterService-
-
addExternalOperation
@POST @Path("logbookoperations") @Consumes("application/json") @Produces("application/json") public javax.ws.rs.core.Response addExternalOperation(LogbookOperationParameters operation) Create a new logbook operation entry in Vitam- Parameters:
operation- the LogbookOperationParameters- Returns:
- Response contains the list of logbook operations
-