StorageResource (Vitam API Reference (2.15.1-1))

java.lang.Object
- fr.gouv.vitam.common.server.application.resources.ApplicationStatusResource
- - fr.gouv.vitam.storage.engine.server.rest.StorageResource

All Implemented Interfaces:: VitamAutoCloseable, AutoCloseable

@Path(value="/storage/v1")
public class StorageResource
extends ApplicationStatusResource
implements VitamAutoCloseable

Storage Resource implementation

Field Summary
- Fields inherited from class fr.gouv.vitam.common.server.application.resources.ApplicationStatusResource
  STATUS_URL, TENANTS_URL

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`javax.ws.rs.core.Response`	`backupStorageAccessLog(javax.ws.rs.core.HttpHeaders headers)` Backup access log
`javax.ws.rs.core.Response`	`backupStorageLog(javax.ws.rs.core.HttpHeaders headers)` Backup storage log
`javax.ws.rs.core.Response`	`bulkCreateFromWorkspace(javax.servlet.http.HttpServletRequest httpServletRequest, javax.ws.rs.core.HttpHeaders headers, String folder, BulkObjectStoreRequest bulkObjectStoreRequest)`
`javax.ws.rs.core.Response`	`checkObject(javax.ws.rs.core.HttpHeaders headers, DataCategory type, String objectId)` Check the existence of an object
`void`	`close()`
`javax.ws.rs.core.Response`	`copy(javax.servlet.http.HttpServletRequest httpServletRequest, javax.ws.rs.core.HttpHeaders headers, String objectId)`
`javax.ws.rs.core.Response`	`creatAgencyfileFile(javax.servlet.http.HttpServletRequest httpServletRequest, javax.ws.rs.core.HttpHeaders headers, String agencyfile, ObjectDescription createObjectDescription)` Post a new object
`javax.ws.rs.core.Response`	`create(javax.servlet.http.HttpServletRequest httpServletRequest, javax.ws.rs.core.HttpHeaders headers, String operationId, InputStream inputStream)` Post a new backup operation
`javax.ws.rs.core.Response`	`createAccessionRegisterDetail(javax.servlet.http.HttpServletRequest httpServletRequest, javax.ws.rs.core.HttpHeaders headers, String fileName, ObjectDescription createObjectDescription)` Post a new unit metadata
`javax.ws.rs.core.Response`	`createAccessionRegisterSymbolic(javax.servlet.http.HttpServletRequest httpServletRequest, javax.ws.rs.core.HttpHeaders headers, String fileName, ObjectDescription createObjectDescription)` Post a new unit metadata
`javax.ws.rs.core.Response`	`createBackupFile(javax.servlet.http.HttpServletRequest httpServletRequest, javax.ws.rs.core.HttpHeaders headers, String backupfile, ObjectDescription createObjectDescription)` Post a new object
`javax.ws.rs.core.Response`	`createDistributionReportFile(javax.servlet.http.HttpServletRequest httpServletRequest, javax.ws.rs.core.HttpHeaders headers, String distributionreportfile, ObjectDescription createObjectDescription)` Post a new distribution report file
`javax.ws.rs.core.Response`	`createLogbook(javax.servlet.http.HttpServletRequest httpServletRequest, javax.ws.rs.core.HttpHeaders headers, String logbookId, ObjectDescription createObjectDescription)` Post a new object
`javax.ws.rs.core.Response`	`createManifestOrGetInformation(javax.servlet.http.HttpServletRequest httpServletRequest, javax.ws.rs.core.HttpHeaders headers, String manifestId, ObjectDescription createObjectDescription)` Post a new object manifest
`javax.ws.rs.core.Response`	`createObjectGroup(javax.servlet.http.HttpServletRequest httpServletRequest, javax.ws.rs.core.HttpHeaders headers, String metadataId, ObjectDescription createObjectDescription)` Post a new Object Group metadata
`javax.ws.rs.core.Response`	`createObjectGroupGraphFile(javax.servlet.http.HttpServletRequest httpServletRequest, javax.ws.rs.core.HttpHeaders headers, String graph_file_name, ObjectDescription createObjectDescription)` Create a new graph zip file
`javax.ws.rs.core.Response`	`createObjectOrGetInformation(javax.servlet.http.HttpServletRequest httpServletRequest, javax.ws.rs.core.HttpHeaders headers, String objectId, ObjectDescription createObjectDescription)` Post a new object
`javax.ws.rs.core.Response`	`createOrUpdateBackupOperation(javax.servlet.http.HttpServletRequest httpServletRequest, javax.ws.rs.core.HttpHeaders headers, String operationId, ObjectDescription createObjectDescription)` Post a new backup operation
`javax.ws.rs.core.Response`	`createProfileOrGetInformation(javax.servlet.http.HttpServletRequest httpServletRequest, javax.ws.rs.core.HttpHeaders headers, String profileFileName, ObjectDescription createObjectDescription)` Post a new object
`javax.ws.rs.core.Response`	`createReportOrGetInformation(javax.servlet.http.HttpServletRequest httpServletRequest, javax.ws.rs.core.HttpHeaders headers, String reportId, ObjectDescription createObjectDescription)` Post a new object
`javax.ws.rs.core.Response`	`createRuleFile(javax.servlet.http.HttpServletRequest httpServletRequest, javax.ws.rs.core.HttpHeaders headers, String ruleFile, ObjectDescription createObjectDescription)` Post a new object
`javax.ws.rs.core.Response`	`createStorageAccessLog(javax.servlet.http.HttpServletRequest httpServletRequest, javax.ws.rs.core.HttpHeaders headers, String storageAccessLogName, ObjectDescription createObjectDescription)` Post a new accesslog object
`javax.ws.rs.core.Response`	`createStorageLog(javax.servlet.http.HttpServletRequest httpServletRequest, javax.ws.rs.core.HttpHeaders headers, String storageLogname, ObjectDescription createObjectDescription)` Post a new object
`javax.ws.rs.core.Response`	`createStorageTraceability(javax.servlet.http.HttpServletRequest httpServletRequest, javax.ws.rs.core.HttpHeaders headers, String storagetraceabilityname, ObjectDescription createObjectDescription)` Post a new object
`javax.ws.rs.core.Response`	`createUnitGraphFile(javax.servlet.http.HttpServletRequest httpServletRequest, javax.ws.rs.core.HttpHeaders headers, String graph_file_name, ObjectDescription createObjectDescription)` Create a new graph zip file
`javax.ws.rs.core.Response`	`createUnitMetadata(javax.servlet.http.HttpServletRequest httpServletRequest, javax.ws.rs.core.HttpHeaders headers, String metadataId, ObjectDescription createObjectDescription)` Post a new unit metadata
`javax.ws.rs.core.Response`	`deleteObject(javax.servlet.http.HttpServletRequest httpServletRequest, javax.ws.rs.core.HttpHeaders headers, String objectId)` Delete an object
`javax.ws.rs.core.Response`	`downloadProfile(javax.ws.rs.core.HttpHeaders headers, String profileFileName)` Get a profile
`javax.ws.rs.core.Response`	`downloadStorageTraceability(javax.ws.rs.core.HttpHeaders headers, String filename)` Get a storage traceability file
`javax.ws.rs.core.Response`	`getAccessionRegisterDetail(javax.ws.rs.core.HttpHeaders headers, String fileName)` Get an accessionregistersdetail
`javax.ws.rs.core.Response`	`getAccessionRegisterSymbolic(javax.ws.rs.core.HttpHeaders headers, String fileName)` Get an accessionregisterssymbolic
`javax.ws.rs.core.Response`	`getAccessLogFile(javax.ws.rs.core.HttpHeaders headers, String storageAccessLogFile)` Get access log data.
`javax.ws.rs.core.Response`	`getBackupFile(javax.ws.rs.core.HttpHeaders headers, String backupfile)` Get colection data.
`javax.ws.rs.core.Response`	`getBackupOperation(javax.ws.rs.core.HttpHeaders headers, String operationId)` Get a backup operation
`javax.ws.rs.core.Response`	`getBatchObjectInformation(javax.ws.rs.core.HttpHeaders headers, String typeStr, List<String> objectIds)` Get object metadata as json Note : this is NOT to be handled in item #72.
`javax.ws.rs.core.Response`	`getDistributionReport(javax.ws.rs.core.HttpHeaders headers, String objectId)` Get a report
`javax.ws.rs.core.Response`	`getInformation(javax.ws.rs.core.HttpHeaders headers, String typeStr, String objectId)` Get object metadata as json Note : this is NOT to be handled in item #72.
`javax.ws.rs.core.Response`	`getLogbookStream(javax.ws.rs.core.HttpHeaders headers, String objectId)`
`javax.ws.rs.core.Response`	`getManifest(javax.ws.rs.core.HttpHeaders headers, String objectId)` getManifest stored by ingest operation
`javax.ws.rs.core.Response`	`getObject(javax.ws.rs.core.HttpHeaders headers, String objectId, AccessLogInfoModel logInfo)` Get an object data
`javax.ws.rs.core.Response`	`getObjectGroup(javax.ws.rs.core.HttpHeaders headers, String metadataId)` Get a Object Group
`javax.ws.rs.core.Response`	`getObjectGroupGraphFile(javax.ws.rs.core.HttpHeaders headers, String graph_file_name)` Get graph zip file
`javax.ws.rs.core.Response`	`getOfferLogs(javax.ws.rs.core.HttpHeaders headers, DataCategory type, OfferLogRequest offerLogRequest)` Get offer log from referent offer
`javax.ws.rs.core.Response`	`getOffers(String strategyId)`
`javax.ws.rs.core.Response`	`getReport(javax.ws.rs.core.HttpHeaders headers, String objectId)` Get a report
`javax.ws.rs.core.Response`	`getRuleFile(javax.ws.rs.core.HttpHeaders headers, String objectId)`
`javax.ws.rs.core.Response`	`getStorageInformation(javax.ws.rs.core.HttpHeaders headers)` Get storage information for a specific tenant/strategy For example the usable space
`javax.ws.rs.core.Response`	`getStrategies()` Get the strategies available in the module
`javax.ws.rs.core.Response`	`getUnit(javax.ws.rs.core.HttpHeaders headers, String unitId)` Get a unit
`javax.ws.rs.core.Response`	`getUnitGraphFile(javax.ws.rs.core.HttpHeaders headers, String graph_file_name)` Get graph zip file
`javax.ws.rs.core.Response`	`listObjects(javax.ws.rs.core.HttpHeaders headers, DataCategory type)` Get list of object type
`javax.ws.rs.core.Response`	`storeArchivalTransferReply(javax.servlet.http.HttpServletRequest httpServletRequest, javax.ws.rs.core.HttpHeaders headers, String id, ObjectDescription description)`
`javax.ws.rs.core.Response`	`traceabilityStorageLogbook(javax.ws.rs.core.HttpHeaders headers)` Run storage logbook secure operation

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

Method Detail

copy

@Path(value="/copy/{id_object}")
 @POST
 @Consumes(value="application/json")
 @Produces(value="application/json")
public javax.ws.rs.core.Response copy(@Context
                                                                                                                                                        javax.servlet.http.HttpServletRequest httpServletRequest,
                                                                                                                                                        @Context
                                                                                                                                                        javax.ws.rs.core.HttpHeaders headers,
                                                                                                                                                        @PathParam(value="id_object")
                                                                                                                                                        String objectId)

create

@Path(value="/create/{id_operation}")
 @POST
 @Consumes(value="application/octet-stream")
 @Produces(value="application/json")
public javax.ws.rs.core.Response create(@Context
                                                                                                                                                                       javax.servlet.http.HttpServletRequest httpServletRequest,
                                                                                                                                                                       @Context
                                                                                                                                                                       javax.ws.rs.core.HttpHeaders headers,
                                                                                                                                                                       @PathParam(value="id_operation")
                                                                                                                                                                       String operationId,
                                                                                                                                                                       InputStream inputStream)

Post a new backup operation

Parameters:: httpServletRequest - http servlet request to get requester; headers - http header; operationId - the id of the operation; inputStream - inputStream
Returns:: Response

getStorageInformation

@GET
 @Consumes(value="application/json")
 @Produces(value="application/json")
public javax.ws.rs.core.Response getStorageInformation(@Context
                                                                                                                                      javax.ws.rs.core.HttpHeaders headers)

Get storage information for a specific tenant/strategy For example the usable space

Parameters:: headers - http headers
Returns:: Response containing the storage information as json, or an error (404, 500)

listObjects

@Path(value="/{type:UNIT|OBJECT|OBJECTGROUP|LOGBOOK|REPORT|MANIFEST|PROFILE|STORAGELOG|STORAGEACCESSLOG|STORAGETRACEABILITY|RULES|DIP|AGENCIES|BACKUP|BACKUP_OPERATION|CHECKLOGBOOKREPORTS|OBJECTGROUP_GRAPH|UNIT_GRAPH|DISTRIBUTIONREPORTS|ACCESSION_REGISTER_DETAIL|ACCESSION_REGISTER_SYMBOLIC}")
 @GET
 @Produces(value="application/json")
 @Consumes(value="application/json")
public javax.ws.rs.core.Response listObjects(@Context
                                                                                                                                                                                                                                                                                                                                                                                                                                  javax.ws.rs.core.HttpHeaders headers,
                                                                                                                                                                                                                                                                                                                                                                                                                                  @PathParam(value="type")
                                                                                                                                                                                                                                                                                                                                                                                                                                  DataCategory type)

Get list of object type

Parameters:: xcursor - the X-Cursor; xcursorId - the X-Cursor-Id if exists; strategyId - the strategy to get offers; type - the object type to list
Returns:: a response with listing elements

getOfferLogs

@Path(value="/{type:UNIT|OBJECT|OBJECTGROUP|LOGBOOK|REPORT|MANIFEST|PROFILE|STORAGELOG|STORAGETRACEABILITY|RULES|DIP|AGENCIES|BACKUP|BACKUP_OPERATION|CHECKLOGBOOKREPORTS|OBJECTGROUP_GRAPH|UNIT_GRAPH|DISTRIBUTIONREPORTS|ACCESSION_REGISTER_DETAIL|ACCESSION_REGISTER_SYMBOLIC}/logs")
 @GET
 @Produces(value="application/json")
 @Consumes(value="application/json")
public javax.ws.rs.core.Response getOfferLogs(@Context
                                                                                                                                                                                                                                                                                                                                                                                                                       javax.ws.rs.core.HttpHeaders headers,
                                                                                                                                                                                                                                                                                                                                                                                                                       @PathParam(value="type")
                                                                                                                                                                                                                                                                                                                                                                                                                       DataCategory type,
                                                                                                                                                                                                                                                                                                                                                                                                                       OfferLogRequest offerLogRequest)

Get offer log from referent offer

Parameters:: strategyId - the strategy to get offers; type - the object type to list; offerLogRequest - offer log request params
Returns:: list of offer log

getInformation

@Path(value="/info/{type}/{id_object}")
 @GET
 @Produces(value="application/json")
 @Consumes(value="application/json")
public javax.ws.rs.core.Response getInformation(@Context
                                                                                                                                                                        javax.ws.rs.core.HttpHeaders headers,
                                                                                                                                                                        @PathParam(value="type")
                                                                                                                                                                        String typeStr,
                                                                                                                                                                        @PathParam(value="id_object")
                                                                                                                                                                        String objectId)

Get object metadata as json Note : this is NOT to be handled in item #72.

Parameters:: headers - http header; objectId - the id of the object
Returns:: Response NOT_IMPLEMENTED

getBatchObjectInformation

@Path(value="/batch_info/{type}")
 @GET
 @Produces(value="application/json")
 @Consumes(value="application/json")
public javax.ws.rs.core.Response getBatchObjectInformation(@Context
                                                                                                                                                                             javax.ws.rs.core.HttpHeaders headers,
                                                                                                                                                                             @PathParam(value="type")
                                                                                                                                                                             String typeStr,
                                                                                                                                                                             List<String> objectIds)

Get object metadata as json Note : this is NOT to be handled in item #72.

Parameters:: headers - http header; objectIds - the id of the object

getObject

@Path(value="/objects/{id_object}")
 @GET
 @Produces(value={"application/octet-stream","application/zip"})
public javax.ws.rs.core.Response getObject(@Context
                                                                                                                                                      javax.ws.rs.core.HttpHeaders headers,
                                                                                                                                                      @PathParam(value="id_object")
                                                                                                                                                      String objectId,
                                                                                                                                                      AccessLogInfoModel logInfo)
                                                                                                                                               throws IOException

Get an object data

Parameters:: headers - http header; objectId - the id of the object
Returns:: the stream
Throws:: IOException - throws an IO Exception

getBackupFile

@Path(value="/backup/{backupfile}")
 @GET
 @Produces(value="application/octet-stream")
public javax.ws.rs.core.Response getBackupFile(@Context
                                                                                                                                      javax.ws.rs.core.HttpHeaders headers,
                                                                                                                                      @PathParam(value="backupfile")
                                                                                                                                      String backupfile)
                                                                                                                               throws IOException

Get colection data.

Parameters:: headers - headers; backupfile - backupfile
Returns:
Throws:: IOException

createObjectOrGetInformation

@Path(value="/objects/{id_object}")
 @POST
 @Produces(value="application/json")
 @Consumes(value="application/json")
public javax.ws.rs.core.Response createObjectOrGetInformation(@Context
                                                                                                                                                                                   javax.servlet.http.HttpServletRequest httpServletRequest,
                                                                                                                                                                                   @Context
                                                                                                                                                                                   javax.ws.rs.core.HttpHeaders headers,
                                                                                                                                                                                   @PathParam(value="id_object")
                                                                                                                                                                                   String objectId,
                                                                                                                                                                                   ObjectDescription createObjectDescription)

Post a new object

Parameters:: httpServletRequest - http servlet request to get requester; headers - http header; objectId - the id of the object; createObjectDescription - the object description
Returns:: Response

createOrUpdateBackupOperation

@Path(value="/backupoperations/{id_operation}")
 @POST
 @Consumes(value="application/json")
 @Produces(value="application/json")
public javax.ws.rs.core.Response createOrUpdateBackupOperation(@Context
                                                                                                                                                                                                javax.servlet.http.HttpServletRequest httpServletRequest,
                                                                                                                                                                                                @Context
                                                                                                                                                                                                javax.ws.rs.core.HttpHeaders headers,
                                                                                                                                                                                                @PathParam(value="id_operation")
                                                                                                                                                                                                String operationId,
                                                                                                                                                                                                ObjectDescription createObjectDescription)

Post a new backup operation

Parameters:: httpServletRequest - http servlet request to get requester; headers - http header; operationId - the id of the operation; createObjectDescription - the object description for storage
Returns:

getAccessLogFile

@Path(value="/storageaccesslog/{storageaccesslogfile}")
 @GET
 @Produces(value="application/octet-stream")
public javax.ws.rs.core.Response getAccessLogFile(@Context
                                                                                                                                                             javax.ws.rs.core.HttpHeaders headers,
                                                                                                                                                             @PathParam(value="storageaccesslogfile")
                                                                                                                                                             String storageAccessLogFile)

Get access log data.

Parameters:: headers - headers; storageAccessLogFile - backupfile
Returns:: the file as stream
Throws:: IOException

getOffers

@Path(value="/offers")
 @GET
 @Consumes(value="application/json")
 @Produces(value="application/json")
public javax.ws.rs.core.Response getOffers(@HeaderParam(value="X-Strategy-Id")
                                                                                                                                                  String strategyId)

Parameters:: strategyId - the strategy to get offers
Returns:

getBackupOperation

@Path(value="/backupoperations/{id_operation}")
 @GET
 @Produces(value={"application/octet-stream","application/zip"})
public javax.ws.rs.core.Response getBackupOperation(@Context
                                                                                                                                                                           javax.ws.rs.core.HttpHeaders headers,
                                                                                                                                                                           @PathParam(value="id_operation")
                                                                                                                                                                           String operationId)

Get a backup operation

Parameters:: headers - http header; operationId - the id of the operation
Returns:: the stream

deleteObject

@Path(value="/delete/{id_object}")
 @DELETE
 @Produces(value="application/json")
 @Consumes(value="application/json")
public javax.ws.rs.core.Response deleteObject(@Context
                                                                                                                                                                    javax.servlet.http.HttpServletRequest httpServletRequest,
                                                                                                                                                                    @Context
                                                                                                                                                                    javax.ws.rs.core.HttpHeaders headers,
                                                                                                                                                                    @PathParam(value="id_object")
                                                                                                                                                                    String objectId)

Delete an object

Parameters:: headers - http header; objectId - the id of the object
Returns:: Response

checkObject

@Path(value="/{type:UNIT|OBJECT|OBJECTGROUP|LOGBOOK|REPORT|MANIFEST|PROFILE|STORAGELOG|STORAGETRACEABILITY|RULES|DIP|AGENCIES|BACKUP|BACKUP_OPERATION|CHECKLOGBOOKREPORTS|OBJECTGROUP_GRAPH|UNIT_GRAPH|DISTRIBUTIONREPORTS|ACCESSION_REGISTER_DETAIL|ACCESSION_REGISTER_SYMBOLIC}/{id_object}")
 @HEAD
 @Produces(value="application/json")
 @Consumes(value="application/json")
public javax.ws.rs.core.Response checkObject(@Context
                                                                                                                                                                                                                                                                                                                                                                                                                              javax.ws.rs.core.HttpHeaders headers,
                                                                                                                                                                                                                                                                                                                                                                                                                              @PathParam(value="type")
                                                                                                                                                                                                                                                                                                                                                                                                                              DataCategory type,
                                                                                                                                                                                                                                                                                                                                                                                                                              @PathParam(value="id_object")
                                                                                                                                                                                                                                                                                                                                                                                                                              String objectId)

Check the existence of an object

Parameters:: headers - http header; objectId - the id of the object
Returns:: Response NOT_IMPLEMENTED

getLogbookStream

@Path(value="/logbooks/{id_logbook}")
 @GET
 @Produces(value="application/octet-stream")
public javax.ws.rs.core.Response getLogbookStream(@Context
                                                                                                                                           javax.ws.rs.core.HttpHeaders headers,
                                                                                                                                           @PathParam(value="id_logbook")
                                                                                                                                           String objectId)
                                                                                                                                    throws IOException

Parameters:: headers - http header; objectId - the id of the object
Returns:: the stream
Throws:: IOException - exception

createLogbook

@Path(value="/logbooks/{id_logbook}")
 @POST
 @Produces(value="application/json")
 @Consumes(value="application/json")
public javax.ws.rs.core.Response createLogbook(@Context
                                                                                                                                                                      javax.servlet.http.HttpServletRequest httpServletRequest,
                                                                                                                                                                      @Context
                                                                                                                                                                      javax.ws.rs.core.HttpHeaders headers,
                                                                                                                                                                      @PathParam(value="id_logbook")
                                                                                                                                                                      String logbookId,
                                                                                                                                                                      ObjectDescription createObjectDescription)

Post a new object

Parameters:: httpServletRequest - http servlet request to get requester; headers - http header; logbookId - the id of the logbookId; createObjectDescription - the workspace information about logbook to be created
Returns:: the stream

getUnit

@Path(value="/units/{id_md}")
 @GET
 @Produces(value={"application/octet-stream","application/zip"})
public javax.ws.rs.core.Response getUnit(@Context
                                                                                                                                              javax.ws.rs.core.HttpHeaders headers,
                                                                                                                                              @PathParam(value="id_md")
                                                                                                                                              String unitId)

Get a unit

Parameters:: headers - http header; unitId - the id of the unit
Returns:: the stream

createUnitMetadata

@Path(value="/units/{id_md}")
 @POST
 @Produces(value="application/json")
 @Consumes(value="application/json")
public javax.ws.rs.core.Response createUnitMetadata(@Context
                                                                                                                                                                   javax.servlet.http.HttpServletRequest httpServletRequest,
                                                                                                                                                                   @Context
                                                                                                                                                                   javax.ws.rs.core.HttpHeaders headers,
                                                                                                                                                                   @PathParam(value="id_md")
                                                                                                                                                                   String metadataId,
                                                                                                                                                                   ObjectDescription createObjectDescription)

Post a new unit metadata

Parameters:: httpServletRequest - http servlet request to get requester; headers - http header; metadataId - the id of the unit metadata; createObjectDescription - the workspace description of the unit to be created
Returns:: Response containing result infos

getObjectGroup

@Path(value="/objectgroups/{id_md}")
 @GET
 @Produces(value={"application/octet-stream","application/zip"})
public javax.ws.rs.core.Response getObjectGroup(@Context
                                                                                                                                                            javax.ws.rs.core.HttpHeaders headers,
                                                                                                                                                            @PathParam(value="id_md")
                                                                                                                                                            String metadataId)

Get a Object Group

Note : this is NOT to be handled in item #72.

Parameters:: headers - http header; metadataId - the id of the Object Group metadata
Returns:: Response NOT_IMPLEMENTED

createObjectGroup

@Path(value="/objectgroups/{id_md}")
 @POST
 @Produces(value="application/json")
 @Consumes(value="application/json")
public javax.ws.rs.core.Response createObjectGroup(@Context
                                                                                                                                                                         javax.servlet.http.HttpServletRequest httpServletRequest,
                                                                                                                                                                         @Context
                                                                                                                                                                         javax.ws.rs.core.HttpHeaders headers,
                                                                                                                                                                         @PathParam(value="id_md")
                                                                                                                                                                         String metadataId,
                                                                                                                                                                         ObjectDescription createObjectDescription)

Post a new Object Group metadata

Parameters:: httpServletRequest - http servlet request to get requester; headers - http header; metadataId - the id of the Object Group metadata; createObjectDescription - the workspace description of the unit to be created
Returns:: Response Created with informations

storeArchivalTransferReply

@POST
 @Path(value="/archivaltransferreply/{id}")
 @Produces(value="application/json")
 @Consumes(value="application/json")
public javax.ws.rs.core.Response storeArchivalTransferReply(@Context
                                                                                                                                                                                        javax.servlet.http.HttpServletRequest httpServletRequest,
                                                                                                                                                                                        @Context
                                                                                                                                                                                        javax.ws.rs.core.HttpHeaders headers,
                                                                                                                                                                                        @PathParam(value="id")
                                                                                                                                                                                        String id,
                                                                                                                                                                                        ObjectDescription description)

createReportOrGetInformation

@Path(value="/reports/{id_report}")
 @POST
 @Produces(value="application/json")
 @Consumes(value="application/json")
public javax.ws.rs.core.Response createReportOrGetInformation(@Context
                                                                                                                                                                                   javax.servlet.http.HttpServletRequest httpServletRequest,
                                                                                                                                                                                   @Context
                                                                                                                                                                                   javax.ws.rs.core.HttpHeaders headers,
                                                                                                                                                                                   @PathParam(value="id_report")
                                                                                                                                                                                   String reportId,
                                                                                                                                                                                   ObjectDescription createObjectDescription)

Post a new object

Parameters:: httpServletRequest - http servlet request to get requester; headers - http header; reportId - the id of the object; createObjectDescription - the object description
Returns:: Response

getReport

@Path(value="/reports/{id_report}")
 @GET
 @Produces(value={"application/octet-stream","application/zip"})
public javax.ws.rs.core.Response getReport(@Context
                                                                                                                                                      javax.ws.rs.core.HttpHeaders headers,
                                                                                                                                                      @PathParam(value="id_report")
                                                                                                                                                      String objectId)
                                                                                                                                               throws IOException

Get a report

Parameters:: headers - http header; objectId - the id of the object
Returns:: the stream
Throws:: IOException - throws an IO Exception

getDistributionReport

@Path(value="/distributionreports/{id_report}")
 @GET
 @Produces(value={"application/octet-stream","application/zip"})
public javax.ws.rs.core.Response getDistributionReport(@Context
                                                                                                                                                                              javax.ws.rs.core.HttpHeaders headers,
                                                                                                                                                                              @PathParam(value="id_report")
                                                                                                                                                                              String objectId)
                                                                                                                                                                       throws IOException

Get a report

Parameters:: headers - http header; objectId - the id of the object
Returns:: the stream
Throws:: IOException - throws an IO Exception

createManifestOrGetInformation

@Path(value="/manifests/{id_manifest}")
 @POST
 @Produces(value="application/json")
 @Consumes(value="application/json")
public javax.ws.rs.core.Response createManifestOrGetInformation(@Context
                                                                                                                                                                                         javax.servlet.http.HttpServletRequest httpServletRequest,
                                                                                                                                                                                         @Context
                                                                                                                                                                                         javax.ws.rs.core.HttpHeaders headers,
                                                                                                                                                                                         @PathParam(value="id_manifest")
                                                                                                                                                                                         String manifestId,
                                                                                                                                                                                         ObjectDescription createObjectDescription)

Post a new object manifest

Parameters:: httpServletRequest - http servlet request to get requester; headers - http header; manifestId - the id of the object; createObjectDescription - the object description
Returns:: Response

getManifest

@Path(value="/manifests/{id_manifest}")
 @GET
 @Produces(value="application/octet-stream")
public javax.ws.rs.core.Response getManifest(@Context
                                                                                                                                        javax.ws.rs.core.HttpHeaders headers,
                                                                                                                                        @PathParam(value="id_manifest")
                                                                                                                                        String objectId)
                                                                                                                                 throws IOException

getManifest stored by ingest operation

Parameters:: headers -; objectId -
Returns:: the stream
Throws:: IOException

backupStorageAccessLog

@POST
 @Path(value="/storage/backup/accesslog")
 @Produces(value="application/json")
public javax.ws.rs.core.Response backupStorageAccessLog(@Context
                                                                                                                                             javax.ws.rs.core.HttpHeaders headers)

Backup access log

Parameters:: headers - http header
Returns:: the response with a specific HTTP status

backupStorageLog

@POST
 @Path(value="/storage/backup")
 @Produces(value="application/json")
public javax.ws.rs.core.Response backupStorageLog(@Context
                                                                                                                             javax.ws.rs.core.HttpHeaders headers)

Backup storage log

Parameters:: headers - http header
Returns:: the response with a specific HTTP status

traceabilityStorageLogbook

@POST
 @Path(value="/storage/traceability")
 @Produces(value="application/json")
public javax.ws.rs.core.Response traceabilityStorageLogbook(@Context
                                                                                                                                             javax.ws.rs.core.HttpHeaders headers)

Run storage logbook secure operation

Parameters:: headers - http header
Returns:: the response with a specific HTTP status

createStorageLog

@Path(value="/storagelog/{storagelogname}")
 @POST
 @Produces(value="application/json")
 @Consumes(value="application/json")
public javax.ws.rs.core.Response createStorageLog(@Context
                                                                                                                                                                               javax.servlet.http.HttpServletRequest httpServletRequest,
                                                                                                                                                                               @Context
                                                                                                                                                                               javax.ws.rs.core.HttpHeaders headers,
                                                                                                                                                                               @PathParam(value="storagelogname")
                                                                                                                                                                               String storageLogname,
                                                                                                                                                                               ObjectDescription createObjectDescription)

Post a new object

Parameters:: httpServletRequest - http servlet request to get requester; headers - http header; storageLogname - the id of the object; createObjectDescription - the object description
Returns:: Response

createStorageAccessLog

@Path(value="/storageaccesslog/{storageaccesslogname}")
 @POST
 @Produces(value="application/json")
 @Consumes(value="application/json")
public javax.ws.rs.core.Response createStorageAccessLog(@Context
                                                                                                                                                                                                 javax.servlet.http.HttpServletRequest httpServletRequest,
                                                                                                                                                                                                 @Context
                                                                                                                                                                                                 javax.ws.rs.core.HttpHeaders headers,
                                                                                                                                                                                                 @PathParam(value="storageaccesslogname")
                                                                                                                                                                                                 String storageAccessLogName,
                                                                                                                                                                                                 ObjectDescription createObjectDescription)

Post a new accesslog object

Parameters:: httpServletRequest - http servlet request to get requester; headers - http header; createObjectDescription - the object description
Returns:: Response

createStorageTraceability

@Path(value="/storagetraceability/{storagetraceabilityname}")
 @POST
 @Produces(value="application/json")
 @Consumes(value="application/json")
public javax.ws.rs.core.Response createStorageTraceability(@Context
                                                                                                                                                                                                          javax.servlet.http.HttpServletRequest httpServletRequest,
                                                                                                                                                                                                          @Context
                                                                                                                                                                                                          javax.ws.rs.core.HttpHeaders headers,
                                                                                                                                                                                                          @PathParam(value="storagetraceabilityname")
                                                                                                                                                                                                          String storagetraceabilityname,
                                                                                                                                                                                                          ObjectDescription createObjectDescription)

Post a new object

Parameters:: httpServletRequest - http servlet request to get requester; headers - http header; storagetraceabilityname - storage traceability name; createObjectDescription - the object description
Returns:: Response

downloadStorageTraceability

@Path(value="/storagetraceability/{storagetraceability_name}")
 @GET
 @Produces(value={"application/octet-stream","application/zip"})
public javax.ws.rs.core.Response downloadStorageTraceability(@Context
                                                                                                                                                                                                   javax.ws.rs.core.HttpHeaders headers,
                                                                                                                                                                                                   @PathParam(value="storagetraceability_name")
                                                                                                                                                                                                   String filename)

Get a storage traceability file

Parameters:: headers - http header; filename - the id of the object
Returns:: the stream
Throws:: IOException - throws an IO Exception

createBackupFile

@Path(value="/backup/{backupfile}")
 @POST
 @Produces(value="application/json")
 @Consumes(value="application/json")
public javax.ws.rs.core.Response createBackupFile(@Context
                                                                                                                                                                       javax.servlet.http.HttpServletRequest httpServletRequest,
                                                                                                                                                                       @Context
                                                                                                                                                                       javax.ws.rs.core.HttpHeaders headers,
                                                                                                                                                                       @PathParam(value="backupfile")
                                                                                                                                                                       String backupfile,
                                                                                                                                                                       ObjectDescription createObjectDescription)

Post a new object

Parameters:: httpServletRequest - http servlet request to get requester; headers - http header; backupfile - the id of the object; createObjectDescription - the object description
Returns:: Response

createRuleFile

@Path(value="/rules/{rulefile}")
 @POST
 @Produces(value="application/json")
 @Consumes(value="application/json")
public javax.ws.rs.core.Response createRuleFile(@Context
                                                                                                                                                                  javax.servlet.http.HttpServletRequest httpServletRequest,
                                                                                                                                                                  @Context
                                                                                                                                                                  javax.ws.rs.core.HttpHeaders headers,
                                                                                                                                                                  @PathParam(value="rulefile")
                                                                                                                                                                  String ruleFile,
                                                                                                                                                                  ObjectDescription createObjectDescription)

Post a new object

Parameters:: httpServletRequest - http servlet request to get requester; headers - http header; ruleFile - the id of the object; createObjectDescription - the object description
Returns:: Response

getRuleFile

@Path(value="/rules/{id_object}")
 @GET
 @Produces(value="application/octet-stream")
public javax.ws.rs.core.Response getRuleFile(@Context
                                                                                                                                  javax.ws.rs.core.HttpHeaders headers,
                                                                                                                                  @PathParam(value="id_object")
                                                                                                                                  String objectId)
                                                                                                                           throws IOException

Throws:: IOException

createUnitGraphFile

@Path(value="/unitgraph/{graph_file_name}")
 @POST
 @Produces(value="application/json")
 @Consumes(value="application/json")
public javax.ws.rs.core.Response createUnitGraphFile(@Context
                                                                                                                                                                                  javax.servlet.http.HttpServletRequest httpServletRequest,
                                                                                                                                                                                  @Context
                                                                                                                                                                                  javax.ws.rs.core.HttpHeaders headers,
                                                                                                                                                                                  @PathParam(value="graph_file_name")
                                                                                                                                                                                  String graph_file_name,
                                                                                                                                                                                  ObjectDescription createObjectDescription)

Create a new graph zip file

Parameters:: httpServletRequest - http servlet request to get requester; headers - http header; graph_file_name - the id of the object; createObjectDescription - the object description
Returns:: Response

getUnitGraphFile

@Path(value="/unitgraph/{graph_file_name}")
 @GET
 @Produces(value="application/octet-stream")
public javax.ws.rs.core.Response getUnitGraphFile(@Context
                                                                                                                                                 javax.ws.rs.core.HttpHeaders headers,
                                                                                                                                                 @PathParam(value="graph_file_name")
                                                                                                                                                 String graph_file_name)

Get graph zip file

Parameters:: headers -; graph_file_name -
Returns:
Throws:: IOException

createObjectGroupGraphFile

@Path(value="/objectgroupgraph/{graph_file_name}")
 @POST
 @Produces(value="application/json")
 @Consumes(value="application/json")
public javax.ws.rs.core.Response createObjectGroupGraphFile(@Context
                                                                                                                                                                                                javax.servlet.http.HttpServletRequest httpServletRequest,
                                                                                                                                                                                                @Context
                                                                                                                                                                                                javax.ws.rs.core.HttpHeaders headers,
                                                                                                                                                                                                @PathParam(value="graph_file_name")
                                                                                                                                                                                                String graph_file_name,
                                                                                                                                                                                                ObjectDescription createObjectDescription)

Create a new graph zip file

Parameters:: httpServletRequest - http servlet request to get requester; headers - http header; graph_file_name - the id of the object; createObjectDescription - the object description
Returns:: Response

getObjectGroupGraphFile

@Path(value="/objectgroupgraph/{graph_file_name}")
 @GET
 @Produces(value="application/octet-stream")
public javax.ws.rs.core.Response getObjectGroupGraphFile(@Context
                                                                                                                                                               javax.ws.rs.core.HttpHeaders headers,
                                                                                                                                                               @PathParam(value="graph_file_name")
                                                                                                                                                               String graph_file_name)

Get graph zip file

Parameters:: headers -; graph_file_name -
Returns:
Throws:: IOException

creatAgencyfileFile

@Path(value="/agencies/{agencyfile}")
 @POST
 @Produces(value="application/json")
 @Consumes(value="application/json")
public javax.ws.rs.core.Response creatAgencyfileFile(@Context
                                                                                                                                                                            javax.servlet.http.HttpServletRequest httpServletRequest,
                                                                                                                                                                            @Context
                                                                                                                                                                            javax.ws.rs.core.HttpHeaders headers,
                                                                                                                                                                            @PathParam(value="agencyfile")
                                                                                                                                                                            String agencyfile,
                                                                                                                                                                            ObjectDescription createObjectDescription)

Post a new object

Parameters:: httpServletRequest - http servlet request to get requester; headers - http header; agencyfile - the id of the object; createObjectDescription - the object description
Returns:: Response

createProfileOrGetInformation

@Path(value="/profiles/{profile_file_name}")
 @POST
 @Produces(value="application/json")
 @Consumes(value="application/json")
public javax.ws.rs.core.Response createProfileOrGetInformation(@Context
                                                                                                                                                                                             javax.servlet.http.HttpServletRequest httpServletRequest,
                                                                                                                                                                                             @Context
                                                                                                                                                                                             javax.ws.rs.core.HttpHeaders headers,
                                                                                                                                                                                             @PathParam(value="profile_file_name")
                                                                                                                                                                                             String profileFileName,
                                                                                                                                                                                             ObjectDescription createObjectDescription)

Post a new object

Parameters:: httpServletRequest - http servlet request to get requester; headers - http header; profileFileName - the id of the object; createObjectDescription - the object description
Returns:: Response

downloadProfile

@Path(value="/profiles/{profile_file_name}")
 @GET
 @Produces(value={"application/octet-stream","application/zip"})
public javax.ws.rs.core.Response downloadProfile(@Context
                                                                                                                                                                     javax.ws.rs.core.HttpHeaders headers,
                                                                                                                                                                     @PathParam(value="profile_file_name")
                                                                                                                                                                     String profileFileName)
                                                                                                                                                              throws IOException

Get a profile

Parameters:: headers - http header; profileFileName - the id of the object
Returns:: the stream
Throws:: IOException - throws an IO Exception

createDistributionReportFile

@Path(value="/distributionreports/{distributionreportfile}")
 @POST
 @Produces(value="application/json")
 @Consumes(value="application/json")
public javax.ws.rs.core.Response createDistributionReportFile(@Context
                                                                                                                                                                                                            javax.servlet.http.HttpServletRequest httpServletRequest,
                                                                                                                                                                                                            @Context
                                                                                                                                                                                                            javax.ws.rs.core.HttpHeaders headers,
                                                                                                                                                                                                            @PathParam(value="distributionreportfile")
                                                                                                                                                                                                            String distributionreportfile,
                                                                                                                                                                                                            ObjectDescription createObjectDescription)

Post a new distribution report file

Parameters:: httpServletRequest - http servlet request to get requester; headers - http header; distributionreportfile - the id of the object; createObjectDescription - the object description
Returns:: Response

createAccessionRegisterDetail

@Path(value="/accessionregistersdetail/{fileName}")
 @POST
 @Produces(value="application/json")
 @Consumes(value="application/json")
public javax.ws.rs.core.Response createAccessionRegisterDetail(@Context
                                                                                                                                                                                                    javax.servlet.http.HttpServletRequest httpServletRequest,
                                                                                                                                                                                                    @Context
                                                                                                                                                                                                    javax.ws.rs.core.HttpHeaders headers,
                                                                                                                                                                                                    @PathParam(value="fileName")
                                                                                                                                                                                                    String fileName,
                                                                                                                                                                                                    ObjectDescription createObjectDescription)

Post a new unit metadata

Parameters:: httpServletRequest - http servlet request to get requester; headers - http header; fileName - the file name of the Accession Register Detail; createObjectDescription - the workspace description of the unit to be created
Returns:: Response containing result infos

getAccessionRegisterDetail

@Path(value="/accessionregistersdetail/{fileName}")
 @GET
 @Produces(value={"application/octet-stream","application/zip"})
public javax.ws.rs.core.Response getAccessionRegisterDetail(@Context
                                                                                                                                                                                       javax.ws.rs.core.HttpHeaders headers,
                                                                                                                                                                                       @PathParam(value="fileName")
                                                                                                                                                                                       String fileName)

Get an accessionregistersdetail

Parameters:: headers - http header; fileName - the file name of the Accession Register Detail
Returns:: the stream

createAccessionRegisterSymbolic

@Path(value="/accessionregisterssymbolic/{fileName}")
 @POST
 @Produces(value="application/json")
 @Consumes(value="application/json")
public javax.ws.rs.core.Response createAccessionRegisterSymbolic(@Context
                                                                                                                                                                                                        javax.servlet.http.HttpServletRequest httpServletRequest,
                                                                                                                                                                                                        @Context
                                                                                                                                                                                                        javax.ws.rs.core.HttpHeaders headers,
                                                                                                                                                                                                        @PathParam(value="fileName")
                                                                                                                                                                                                        String fileName,
                                                                                                                                                                                                        ObjectDescription createObjectDescription)

Post a new unit metadata

Parameters:: httpServletRequest - http servlet request to get requester; headers - http header; fileName - the file name of the Accession Register Symbolic; createObjectDescription - the workspace description of the unit to be created
Returns:: Response containing result infos

getAccessionRegisterSymbolic

@Path(value="/accessionregisterssymbolic/{fileName}")
 @GET
 @Produces(value={"application/octet-stream","application/zip"})
public javax.ws.rs.core.Response getAccessionRegisterSymbolic(@Context
                                                                                                                                                                                           javax.ws.rs.core.HttpHeaders headers,
                                                                                                                                                                                           @PathParam(value="fileName")
                                                                                                                                                                                           String fileName)

Get an accessionregisterssymbolic

Parameters:: headers - http header; fileName - the file name of the Accession Register Symbolic
Returns:: the stream

bulkCreateFromWorkspace

@Path(value="/bulk/{folder}")
 @POST
 @Produces(value="application/json")
 @Consumes(value="application/json")
public javax.ws.rs.core.Response bulkCreateFromWorkspace(@Context
                                                                                                                                                                        javax.servlet.http.HttpServletRequest httpServletRequest,
                                                                                                                                                                        @Context
                                                                                                                                                                        javax.ws.rs.core.HttpHeaders headers,
                                                                                                                                                                        @PathParam(value="folder")
                                                                                                                                                                        String folder,
                                                                                                                                                                        BulkObjectStoreRequest bulkObjectStoreRequest)

getStrategies

@Path(value="/strategies")
 @GET
 @Produces(value="application/json")
public javax.ws.rs.core.Response getStrategies()

Get the strategies available in the module

Returns:: the strategies

close
```
public void close()
```
Specified by:

close in interface VitamAutoCloseable

Specified by:

close in interface AutoCloseable

Class StorageResource

Field Summary

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

Method Summary

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

Methods inherited from class java.lang.Object

Method Detail

copy

create

getStorageInformation

listObjects

getOfferLogs

getInformation

getBatchObjectInformation

getObject

getBackupFile

createObjectOrGetInformation

createOrUpdateBackupOperation

getAccessLogFile

getOffers

getBackupOperation

deleteObject

checkObject

getLogbookStream

createLogbook

getUnit

createUnitMetadata

getObjectGroup

createObjectGroup

storeArchivalTransferReply

createReportOrGetInformation

getReport

getDistributionReport

createManifestOrGetInformation

getManifest

backupStorageAccessLog

backupStorageLog

traceabilityStorageLogbook

createStorageLog

createStorageAccessLog

createStorageTraceability

downloadStorageTraceability

createBackupFile

createRuleFile

getRuleFile

createUnitGraphFile

getUnitGraphFile

createObjectGroupGraphFile

getObjectGroupGraphFile

creatAgencyfileFile

createProfileOrGetInformation

downloadProfile

createDistributionReportFile

createAccessionRegisterDetail

getAccessionRegisterDetail

createAccessionRegisterSymbolic

getAccessionRegisterSymbolic

bulkCreateFromWorkspace

getStrategies

close