fr.gouv.vitam.logbook.rest

Class LogbookResource

java.lang.Object

fr.gouv.vitam.common.server.application.resources.ApplicationStatusResource

fr.gouv.vitam.logbook.rest.LogbookResource

All Implemented Interfaces:

VitamResource

@Path(value="/logbook/v1")
 @ApplicationPath(value="webresources")
public class LogbookResource
extends ApplicationStatusResource

Logbook Resource implementation

Field Summary

Fields

Modifier and Type	Field and Description
static String	CODE_VITAM
static String	CONSISTENCY_ERROR_AN_INTERNAL_DATA_CONSISTENCY_ERROR_HAS_BEEN_DETECTED

Fields inherited from class fr.gouv.vitam.common.server.application.resources.ApplicationStatusResource

STATUS_URL, TENANTS_URL

Constructor Summary

Constructors

Constructor and Description
LogbookResource(LogbookConfiguration configuration) Constructor

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	bulkCreateObjectGroup(String idOp, String array) Lifecycle ObjectGroup Bulk Create
javax.ws.rs.core.Response	bulkCreateOperation(com.fasterxml.jackson.databind.JsonNode query) Bulk Create Operation
javax.ws.rs.core.Response	bulkCreateUnit(String idOp, String array) Lifecycle Unit Bulk Create
javax.ws.rs.core.Response	changeIndexes(SwitchIndexParameters switchIndexParameters) Switch indexes
javax.ws.rs.core.Response	commitObjectGroupLifeCyclesByOperation(String operationId, String objGrpId) Deprecated.
javax.ws.rs.core.Response	commitUnitLifeCyclesByOperation(String operationId, String unitLcId) Deprecated.
javax.ws.rs.core.Response	createLifeCycleObjectGroupBulk(String idOp, List<LogbookLifeCycleObjectGroupModel> logbookLifeCycleModels) Lifecycle Unit Bulk Create
javax.ws.rs.core.Response	createLifeCycleUnitBulk(String idOp, List<LogbookLifeCycleUnitModel> logbookLifeCycleModels) Lifecycle Unit Bulk Create
javax.ws.rs.core.Response	createObjectGroupLifeCyclesByOperation(String operationId, String objGrpId, LogbookLifeCycleObjectGroupParameters parameters) Create object Group Life Cycle
javax.ws.rs.core.Response	createOperation(String operationId, LogbookOperationParameters operation) Create or Select a new operation
javax.ws.rs.core.Response	createUnitLifeCyclesByOperation(String operationId, String unitLcId, LogbookLifeCycleUnitParameters parameters) Create Unit Life Cycle
javax.ws.rs.core.Response	deleteObjectGroupLifeCyclesByOperation(String operationId, String objGrpId) Delete object Group Life Cycle
javax.ws.rs.core.Response	deleteUnitLifeCyclesByOperation(String operationId, String unitLcId) Delete Unit Life Cycle
javax.ws.rs.core.Response	getObjectGroupLifeCycle(String evtStatus, com.fasterxml.jackson.databind.JsonNode queryDsl) Gets the object group life cycles based on the passed DSL query
javax.ws.rs.core.Response	getObjectGroupLifeCycleById(String objectGroupLifeCycleId, String evtStatus, com.fasterxml.jackson.databind.JsonNode queryDsl) Gets the object group life cycle based on its id and using the passed DSL query
javax.ws.rs.core.Response	getObjectGroupLifeCyclesByOperation(String operationId, String evtStatus, com.fasterxml.jackson.databind.JsonNode query) GET multiple Unit Life Cycles through VitamRequestIterator
javax.ws.rs.core.Response	getObjectGroupLifeCycleStatus(String objectGroupLifeCycleId) Gets the objectGroup life cycle status based on its id
javax.ws.rs.core.Response	getOperation(String id, com.fasterxml.jackson.databind.JsonNode queryDsl) Selects an operation
javax.ws.rs.core.Response	getOperationOnlyById(String id) Selects an operation only by Id
javax.ws.rs.core.Response	getUnitLifeCycle(com.fasterxml.jackson.databind.JsonNode queryDsl, String evtStatus) Gets a list of unit lifeCycles using a queryDsl
javax.ws.rs.core.Response	getUnitLifeCycleById(String unitLifeCycleId, String evtStatus, com.fasterxml.jackson.databind.JsonNode queryDsl) gets the unit life cycle based on its id
javax.ws.rs.core.Response	getUnitLifeCyclesByOperation(String operationId, String evtStatus, com.fasterxml.jackson.databind.JsonNode query) GET multiple Unit Life Cycles through VitamRequestIterator
javax.ws.rs.core.Response	getUnitLifeCyclesRaw(com.fasterxml.jackson.databind.JsonNode queryDsl, String evtStatus) Gets a list of raw unit lifeCycles using a queryDsl
javax.ws.rs.core.Response	getUnitLifeCycleStatus(String unitLifeCycleId) Gets the unit life cycle status based on its id
javax.ws.rs.core.Response	launchTraceabilityAudit(AuditLogbookOptions options)
javax.ws.rs.core.Response	reindex(IndexParameters indexParameters) Reindex a collection
javax.ws.rs.core.Response	rollBackObjectGroupLifeCyclesByOperation(String operationId) Deletes all temporary ObjectGroup lifeCycles created during a given operation
javax.ws.rs.core.Response	rollBackUnitLifeCyclesByOperation(String operationId) Deletes all temporary Unit lifeCycles created during a given operation
javax.ws.rs.core.Response	selectOperation(com.fasterxml.jackson.databind.JsonNode query) Select a list of operations
javax.ws.rs.core.Response	traceability(String xTenantId) Run traceability secure operation for logbook
javax.ws.rs.core.Response	traceabilityLFC(String xTenantId) Run traceability secure lifecycles for logbook
javax.ws.rs.core.Response	updateBulkObjectGroup(String idOp, String arrayNodeLifecycle) Update Lifecycle ObjectGroup With Bulk Mode
javax.ws.rs.core.Response	updateBulkUnit(String idOp, String arrayNodeLifecycle) Update Lifecycle With Bulk Mode
javax.ws.rs.core.Response	updateObjectGroupLifeCyclesByOperation(String operationId, String objGrpId, String evtStatus, LogbookLifeCycleObjectGroupParameters parameters) Update object Group Life Cycle
javax.ws.rs.core.Response	updateOperation(String operationId, LogbookOperationParameters operation) Append a new item on the given operation
javax.ws.rs.core.Response	updateOperationBulk(String arrayNodeOperations) Update Operation With Bulk Mode
javax.ws.rs.core.Response	updateUnitLifeCyclesByOperation(String operationId, String unitLcId, String evtStatus, LogbookLifeCycleUnitParameters parameters) Update Unit Life Cycle

Methods inherited from class fr.gouv.vitam.common.server.application.resources.ApplicationStatusResource

getServerTenants, status

Methods inherited from class java.lang.Object

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

Field Detail

CONSISTENCY_ERROR_AN_INTERNAL_DATA_CONSISTENCY_ERROR_HAS_BEEN_DETECTED

public static final String CONSISTENCY_ERROR_AN_INTERNAL_DATA_CONSISTENCY_ERROR_HAS_BEEN_DETECTED

See Also:

Constant Field Values

CODE_VITAM

public static final String CODE_VITAM

See Also:

Constant Field Values

Constructor Detail

LogbookResource

public LogbookResource(LogbookConfiguration configuration)

Constructor

Parameters:

configuration - of type LogbookConfiguration

Method Detail

getOperationOnlyById

@GET
 @Path(value="/operations/{id_op}")
 @Produces(value="application/json")
public javax.ws.rs.core.Response getOperationOnlyById(@PathParam(value="id_op")
                                                                                                                                    String id)

Selects an operation only by Id

Parameters:

id - operation ID

Returns:

the response with a specific HTTP status

getOperation

@GET
 @Path(value="/operations/{id_op}")
 @Consumes(value="application/json")
 @Produces(value="application/json")
public javax.ws.rs.core.Response getOperation(@PathParam(value="id_op")
                                                                                                                                                                 String id,
                                                                                                                                                                 com.fasterxml.jackson.databind.JsonNode queryDsl)
                                                                                                                                                          throws VitamException

Selects an operation

Parameters:

id - operation ID

queryDsl - the query containing the ID

Returns:

the response with a specific HTTP status

Throws:

VitamException

createOperation

@POST
 @Path(value="/operations/{id_op}")
 @Consumes(value="application/json")
 @Produces(value="application/json")
public javax.ws.rs.core.Response createOperation(@PathParam(value="id_op")
                                                                                                                                                                     String operationId,
                                                                                                                                                                     LogbookOperationParameters operation)

Create or Select a new operation

Parameters:

operationId - path param, the operation id

operation - the json serialized as a LogbookOperationParameters.

Returns:

the response with a specific HTTP status

updateOperation

@PUT
 @Path(value="/operations/{id_op}")
 @Consumes(value="application/json")
 @Produces(value="application/json")
public javax.ws.rs.core.Response updateOperation(@PathParam(value="id_op")
                                                                                                                                                                    String operationId,
                                                                                                                                                                    LogbookOperationParameters operation)

Append a new item on the given operation

Parameters:

operationId - the operation id

operation - the json serialized as a LogbookOperationParameters.

Returns:

the response with a specific HTTP status

traceability

@POST
 @Path(value="/operations/traceability")
 @Produces(value="application/json")
public javax.ws.rs.core.Response traceability(@HeaderParam(value="X-Tenant-Id")
                                                                                                                                  String xTenantId)

Run traceability secure operation for logbook

Parameters:

xTenantId - the tenant id

Returns:

the response with a specific HTTP status

bulkCreateOperation

@POST
 @Path(value="/operations")
 @Consumes(value="application/json")
 @Produces(value="application/json")
public javax.ws.rs.core.Response bulkCreateOperation(com.fasterxml.jackson.databind.JsonNode query)

Bulk Create Operation

Parameters:

query - as JsonNode or Operations Logbooks as ArrayNode

Returns:

Response of SELECT query with POST method or CREATED

selectOperation

@GET
 @Path(value="/operations")
 @Consumes(value="application/json")
 @Produces(value="application/json")
public javax.ws.rs.core.Response selectOperation(com.fasterxml.jackson.databind.JsonNode query)

Select a list of operations

Parameters:

query - DSL as JsonNode

Returns:

Response containt the list of loglook operation

updateOperationBulk

@PUT
 @Path(value="/operations")
 @Consumes(value="application/json")
 @Produces(value="application/json")
public javax.ws.rs.core.Response updateOperationBulk(String arrayNodeOperations)

Update Operation With Bulk Mode

Parameters:

arrayNodeOperations - as ArrayNode of operations to add to existing Operation Logbook entry

Returns:

Response with a status of OK if updated

getUnitLifeCyclesByOperation

@GET
 @Path(value="/operations/{id_op}/unitlifecycles")
 @Consumes(value="application/json")
 @Produces(value="application/json")
public javax.ws.rs.core.Response getUnitLifeCyclesByOperation(@PathParam(value="id_op")
                                                                                                                                                                                                String operationId,
                                                                                                                                                                                                @HeaderParam(value="X-Event-Status")
                                                                                                                                                                                                String evtStatus,
                                                                                                                                                                                                com.fasterxml.jackson.databind.JsonNode query)

GET multiple Unit Life Cycles through VitamRequestIterator

Parameters:

operationId - the operation id

evtStatus - the evenement status (commited / not_commited)

query - as JsonNode

Returns:

the response with a specific HTTP status

createUnitLifeCyclesByOperation

@POST
 @Path(value="/operations/{id_op}/unitlifecycles/{id_lc}")
 @Consumes(value="application/json")
 @Produces(value="application/json")
public javax.ws.rs.core.Response createUnitLifeCyclesByOperation(@PathParam(value="id_op")
                                                                                                                                                                                                            String operationId,
                                                                                                                                                                                                            @PathParam(value="id_lc")
                                                                                                                                                                                                            String unitLcId,
                                                                                                                                                                                                            LogbookLifeCycleUnitParameters parameters)

Create Unit Life Cycle

Parameters:

operationId - the operation id

unitLcId - the life cycle id

parameters - the json serialized as a LogbookLifeCycleUnitParameters.

Returns:

the response with a specific HTTP status

updateUnitLifeCyclesByOperation

@PUT
 @Path(value="/operations/{id_op}/unitlifecycles/{id_lc}")
 @Consumes(value="application/json")
 @Produces(value="application/json")
public javax.ws.rs.core.Response updateUnitLifeCyclesByOperation(@PathParam(value="id_op")
                                                                                                                                                                                                           String operationId,
                                                                                                                                                                                                           @PathParam(value="id_lc")
                                                                                                                                                                                                           String unitLcId,
                                                                                                                                                                                                           @HeaderParam(value="X-Event-Status")
                                                                                                                                                                                                           String evtStatus,
                                                                                                                                                                                                           LogbookLifeCycleUnitParameters parameters)

Update Unit Life Cycle

Parameters:

operationId - the operation id

unitLcId - the life cycle id

evtStatus - the operation type : Update or Commit the lifeCycle

parameters - the json serialized as a LogbookLifeCycleUnitParameters.

Returns:

the response with a specific HTTP status

deleteUnitLifeCyclesByOperation

@DELETE
 @Path(value="/operations/{id_op}/unitlifecycles/{id_lc}")
 @Consumes(value="application/json")
 @Produces(value="application/json")
public javax.ws.rs.core.Response deleteUnitLifeCyclesByOperation(@PathParam(value="id_op")
                                                                                                                                                                                                              String operationId,
                                                                                                                                                                                                              @PathParam(value="id_lc")
                                                                                                                                                                                                              String unitLcId)

Delete Unit Life Cycle

Parameters:

operationId - the operation id

unitLcId - the life cycle id

Returns:

the response with a specific HTTP status

commitUnitLifeCyclesByOperation

@Deprecated
 @PUT
 @Path(value="/operations/{id_op}/unitlifecycles/{id_lc}/commit")
 @Consumes(value="application/json")
 @Produces(value="application/json")
public javax.ws.rs.core.Response commitUnitLifeCyclesByOperation(@PathParam(value="id_op")
                                                                                                                                                                                                                               String operationId,
                                                                                                                                                                                                                               @PathParam(value="id_lc")
                                                                                                                                                                                                                               String unitLcId)

Deprecated.

Commit Unit Life Cycle

Parameters:

operationId - the operation id

unitLcId - the life cycle id

Returns:

the response with a specific HTTP status

bulkCreateUnit

@POST
 @Path(value="/operations/{id_op}/unitlifecycles")
 @Consumes(value="application/json")
 @Produces(value="application/json")
public javax.ws.rs.core.Response bulkCreateUnit(@PathParam(value="id_op")
                                                                                                                                                                                   String idOp,
                                                                                                                                                                                   String array)

Lifecycle Unit Bulk Create

Parameters:

idOp - the operation id

array - Lifecycle Unit Logbooks as ArrayNode

Returns:

Response of CREATED

createLifeCycleObjectGroupBulk

@PUT
 @Path(value="/operations/{id_op}/lifecycles/objectgroup/bulk")
 @Consumes(value="application/json")
public javax.ws.rs.core.Response createLifeCycleObjectGroupBulk(@PathParam(value="id_op")
                                                                                                                                                                          String idOp,
                                                                                                                                                                          List<LogbookLifeCycleObjectGroupModel> logbookLifeCycleModels)

Lifecycle Unit Bulk Create

Parameters:

idOp - the operation id

logbookLifeCycleModels - Lifecycle Unit Logbooks as ArrayNode

Returns:

Response of CREATED

createLifeCycleUnitBulk

@PUT
 @Path(value="/operations/{id_op}/lifecycles/unit/bulk")
 @Consumes(value="application/json")
public javax.ws.rs.core.Response createLifeCycleUnitBulk(@PathParam(value="id_op")
                                                                                                                                                            String idOp,
                                                                                                                                                            List<LogbookLifeCycleUnitModel> logbookLifeCycleModels)

Lifecycle Unit Bulk Create

Parameters:

idOp - the operation id

logbookLifeCycleModels - Lifecycle Unit Logbooks as ArrayNode

Returns:

Response of CREATED

updateBulkUnit

@PUT
 @Path(value="/operations/{id_op}/unitlifecycles")
 @Consumes(value="application/json")
 @Produces(value="application/json")
public javax.ws.rs.core.Response updateBulkUnit(@PathParam(value="id_op")
                                                                                                                                                                                  String idOp,
                                                                                                                                                                                  String arrayNodeLifecycle)

Update Lifecycle With Bulk Mode

Parameters:

idOp - the operation id

arrayNodeLifecycle - as ArrayNode of operations to add to existing Lifecycle Logbook entry

Returns:

Response with a status of OK if updated aeaqaaaaaagbcaacaang6ak4ts6paliaaaaq

getUnitLifeCycleById

@GET
 @Path(value="/unitlifecycles/{id_lc}")
 @Produces(value="application/json")
public javax.ws.rs.core.Response getUnitLifeCycleById(@PathParam(value="id_lc")
                                                                                                                                        String unitLifeCycleId,
                                                                                                                                        @HeaderParam(value="X-Event-Status")
                                                                                                                                        String evtStatus,
                                                                                                                                        com.fasterxml.jackson.databind.JsonNode queryDsl)

gets the unit life cycle based on its id

Parameters:

unitLifeCycleId - the unit life cycle id

evtStatus - the lifeCycle Status that we are looking for : COMMITTED or IN_PROCESS

queryDsl - the query to get unit lfc

Returns:

the unit life cycle

getUnitLifeCycleStatus

@HEAD
 @Path(value="/unitlifecycles/{id_lc}")
public javax.ws.rs.core.Response getUnitLifeCycleStatus(@PathParam(value="id_lc")
                                                                                                      String unitLifeCycleId)

Gets the unit life cycle status based on its id

Parameters:

unitLifeCycleId - the unit life cycle id

Returns:

the unit life cycle status : Committed or In process

getUnitLifeCycle

@GET
 @Path(value="/unitlifecycles")
 @Produces(value="application/json")
 @Consumes(value="application/json")
public javax.ws.rs.core.Response getUnitLifeCycle(com.fasterxml.jackson.databind.JsonNode queryDsl,
                                                                                                                                                                 @HeaderParam(value="X-Event-Status")
                                                                                                                                                                 String evtStatus)
                                                                                                                                                          throws VitamDBException

Gets a list of unit lifeCycles using a queryDsl

Parameters:

queryDsl - a DSL query

evtStatus - the lifeCycle Status that we are looking for : COMMITTED or IN_PROCESS

Returns:

a list of unit lifeCycles

Throws:

VitamDBException

getUnitLifeCyclesRaw

@GET
 @Path(value="/unitlifecyclesraw")
 @Produces(value="application/json")
 @Consumes(value="application/json")
public javax.ws.rs.core.Response getUnitLifeCyclesRaw(com.fasterxml.jackson.databind.JsonNode queryDsl,
                                                                                                                                                                        @HeaderParam(value="X-Event-Status")
                                                                                                                                                                        String evtStatus)
                                                                                                                                                                 throws VitamDBException

Gets a list of raw unit lifeCycles using a queryDsl

Parameters:

queryDsl - a DSL query

evtStatus - the lifeCycle Status that we are looking for : COMMITTED or IN_PROCESS

Returns:

a list of unit lifeCycles

Throws:

VitamDBException

getObjectGroupLifeCyclesByOperation

@GET
 @Path(value="/operations/{id_op}/objectgrouplifecycles")
 @Consumes(value="application/json")
 @Produces(value="application/json")
public javax.ws.rs.core.Response getObjectGroupLifeCyclesByOperation(@PathParam(value="id_op")
                                                                                                                                                                                                              String operationId,
                                                                                                                                                                                                              @HeaderParam(value="X-Event-Status")
                                                                                                                                                                                                              String evtStatus,
                                                                                                                                                                                                              com.fasterxml.jackson.databind.JsonNode query)

GET multiple Unit Life Cycles through VitamRequestIterator

Parameters:

operationId - the operation id

evtStatus - the evenement status (commited / not_commited)

query - as JsonNode

Returns:

the response with a specific HTTP status

createObjectGroupLifeCyclesByOperation

@POST
 @Path(value="/operations/{id_op}/objectgrouplifecycles/{id_lc}")
 @Consumes(value="application/json")
 @Produces(value="application/json")
public javax.ws.rs.core.Response createObjectGroupLifeCyclesByOperation(@PathParam(value="id_op")
                                                                                                                                                                                                                          String operationId,
                                                                                                                                                                                                                          @PathParam(value="id_lc")
                                                                                                                                                                                                                          String objGrpId,
                                                                                                                                                                                                                          LogbookLifeCycleObjectGroupParameters parameters)

Create object Group Life Cycle

Parameters:

operationId - the operation id

objGrpId - the life cycle id

parameters - the json serialized as a LogbookLifeCycleObjectGroupParameters.

Returns:

the response with a specific HTTP status

updateObjectGroupLifeCyclesByOperation

@PUT
 @Path(value="/operations/{id_op}/objectgrouplifecycles/{id_lc}")
 @Consumes(value="application/json")
 @Produces(value="application/json")
public javax.ws.rs.core.Response updateObjectGroupLifeCyclesByOperation(@PathParam(value="id_op")
                                                                                                                                                                                                                         String operationId,
                                                                                                                                                                                                                         @PathParam(value="id_lc")
                                                                                                                                                                                                                         String objGrpId,
                                                                                                                                                                                                                         @HeaderParam(value="X-Event-Status")
                                                                                                                                                                                                                         String evtStatus,
                                                                                                                                                                                                                         LogbookLifeCycleObjectGroupParameters parameters)

Update object Group Life Cycle

Parameters:

operationId - the operation id

objGrpId - the life cycle id

evtStatus - the operation type : Update or Commit the lifeCycle

parameters - the json serialized as a LogbookLifeCycleObjectGroupParameters.

Returns:

the response with a specific HTTP status

deleteObjectGroupLifeCyclesByOperation

@DELETE
 @Path(value="/operations/{id_op}/objectgrouplifecycles/{id_lc}")
 @Consumes(value="application/json")
 @Produces(value="application/json")
public javax.ws.rs.core.Response deleteObjectGroupLifeCyclesByOperation(@PathParam(value="id_op")
                                                                                                                                                                                                                            String operationId,
                                                                                                                                                                                                                            @PathParam(value="id_lc")
                                                                                                                                                                                                                            String objGrpId)

Delete object Group Life Cycle

Parameters:

operationId - the operation id

objGrpId - the life cycle id

Returns:

the response with a specific HTTP status

commitObjectGroupLifeCyclesByOperation

@Deprecated
 @PUT
 @Path(value="/operations/{id_op}/objectgrouplifecycles/{id_lc}/commit")
 @Consumes(value="application/json")
 @Produces(value="application/json")
public javax.ws.rs.core.Response commitObjectGroupLifeCyclesByOperation(@PathParam(value="id_op")
                                                                                                                                                                                                                                             String operationId,
                                                                                                                                                                                                                                             @PathParam(value="id_lc")
                                                                                                                                                                                                                                             String objGrpId)

Deprecated.

Commit object Group Life Cycle

Parameters:

operationId - the operation id

objGrpId - the life cycle id

Returns:

the response with a specific HTTP status

bulkCreateObjectGroup

@POST
 @Path(value="/operations/{id_op}/objectgrouplifecycles")
 @Consumes(value="application/json")
 @Produces(value="application/json")
public javax.ws.rs.core.Response bulkCreateObjectGroup(@PathParam(value="id_op")
                                                                                                                                                                                                 String idOp,
                                                                                                                                                                                                 String array)

Lifecycle ObjectGroup Bulk Create

Parameters:

idOp - the operation id

array - Lifecycle ObjectGroup Logbooks as ArrayNode

Returns:

Response of CREATED

updateBulkObjectGroup

@PUT
 @Path(value="/operations/{id_op}/objectgrouplifecycles")
 @Consumes(value="application/json")
 @Produces(value="application/json")
public javax.ws.rs.core.Response updateBulkObjectGroup(@PathParam(value="id_op")
                                                                                                                                                                                                String idOp,
                                                                                                                                                                                                String arrayNodeLifecycle)

Update Lifecycle ObjectGroup With Bulk Mode

Parameters:

idOp - the operation id

arrayNodeLifecycle - as ArrayNode of operations to add to existing Lifecycle Logbook entry

Returns:

Response with a status of OK if updated

getObjectGroupLifeCycleById

@GET
 @Path(value="/objectgrouplifecycles/{id_lc}")
 @Produces(value="application/json")
public javax.ws.rs.core.Response getObjectGroupLifeCycleById(@PathParam(value="id_lc")
                                                                                                                                                      String objectGroupLifeCycleId,
                                                                                                                                                      @HeaderParam(value="X-Event-Status")
                                                                                                                                                      String evtStatus,
                                                                                                                                                      com.fasterxml.jackson.databind.JsonNode queryDsl)
                                                                                                                                               throws VitamDBException

Gets the object group life cycle based on its id and using the passed DSL query

Parameters:

objectGroupLifeCycleId - the object group life cycle id

evtStatus - the lifeCycle Status that we are looking for : COMMITTED or IN_PROCESS

queryDsl - the DSL query

Returns:

a Response that contains the object group life cycle

Throws:

VitamDBException

getObjectGroupLifeCycle

@GET
 @Path(value="/objectgrouplifecycles")
 @Produces(value="application/json")
public javax.ws.rs.core.Response getObjectGroupLifeCycle(@HeaderParam(value="X-Event-Status")
                                                                                                                                          String evtStatus,
                                                                                                                                          com.fasterxml.jackson.databind.JsonNode queryDsl)
                                                                                                                                   throws VitamDBException

Gets the object group life cycles based on the passed DSL query

Parameters:

evtStatus - the lifeCycle Status that we are looking for : COMMITTED or IN_PROCESS

queryDsl - the DSL query

Returns:

a Response that contains the object group life cycle

Throws:

VitamDBException

getObjectGroupLifeCycleStatus

@HEAD
 @Path(value="/objectgrouplifecycles/{id_lc}")
public javax.ws.rs.core.Response getObjectGroupLifeCycleStatus(@PathParam(value="id_lc")
                                                                                                                    String objectGroupLifeCycleId)

Gets the objectGroup life cycle status based on its id

Parameters:

objectGroupLifeCycleId - the object group cycle id

Returns:

the object group cycle status : Committed or In process

rollBackUnitLifeCyclesByOperation

@DELETE
 @Path(value="/operations/{id_op}/unitlifecycles")
public javax.ws.rs.core.Response rollBackUnitLifeCyclesByOperation(@PathParam(value="id_op")
                                                                                                                              String operationId)

Deletes all temporary Unit lifeCycles created during a given operation

Parameters:

operationId - the operation id

Returns:

a Response that contains the result of deletion operation

rollBackObjectGroupLifeCyclesByOperation

@DELETE
 @Path(value="/operations/{id_op}/objectgrouplifecycles")
public javax.ws.rs.core.Response rollBackObjectGroupLifeCyclesByOperation(@PathParam(value="id_op")
                                                                                                                                            String operationId)

Deletes all temporary ObjectGroup lifeCycles created during a given operation

Parameters:

operationId - the operation id

Returns:

a Response that contains the result of deletion operation

traceabilityLFC

@POST
 @Path(value="/lifecycles/traceability")
 @Produces(value="application/json")
public javax.ws.rs.core.Response traceabilityLFC(@HeaderParam(value="X-Tenant-Id")
                                                                                                                                     String xTenantId)

Run traceability secure lifecycles for logbook

Parameters:

xTenantId - the tenant id

Returns:

the response with a specific HTTP status

reindex

@Path(value="/reindex")
 @POST
 @Consumes(value="application/json")
 @Produces(value="application/json")
public javax.ws.rs.core.Response reindex(IndexParameters indexParameters)

Reindex a collection

Parameters:

indexParameters - parameters specifying what to reindex

Returns:

Response response

changeIndexes

@Path(value="/alias")
 @POST
 @Consumes(value="application/json")
 @Produces(value="application/json")
public javax.ws.rs.core.Response changeIndexes(SwitchIndexParameters switchIndexParameters)

Switch indexes

Parameters:

switchIndexParameters -

Returns:

Response response

launchTraceabilityAudit

@Path(value="/auditTraceability")
 @POST
 @Consumes(value="application/json")
 @Produces(value="application/json")
public javax.ws.rs.core.Response launchTraceabilityAudit(AuditLogbookOptions options)