fr.gouv.vitam.storage.offers.common.rest

Class DefaultOfferResource

java.lang.Object

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

fr.gouv.vitam.storage.offers.common.rest.DefaultOfferResource

All Implemented Interfaces:

VitamResource

@Path(value="/offer/v1")
 @ApplicationPath(value="webresources")
public class DefaultOfferResource
extends ApplicationStatusResource

Default offer REST Resource

Field Summary

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

STATUS_URL, TENANTS_URL

Constructor Summary

Constructors

Constructor and Description
DefaultOfferResource(DefaultOfferService defaultOfferService) Constructor

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	countObjects(String xTenantId, DataCategory type) Count the number of objects on the offer objects defined container (exlude directories)
javax.ws.rs.core.Response	deleteObject(String xTenantId, String xDigest, String xDigestAlgorithm, DataCategory type, String idObject) Delete an Object
javax.ws.rs.core.Response	getCapacity(String xTenantId, DataCategory type) Get the information on the offer objects collection (free and used capacity, etc)
javax.ws.rs.core.Response	getContainerList(boolean xcursor, String xcursorId, String xTenantId, DataCategory type) Get container object list
javax.ws.rs.core.Response	getObject(DataCategory type, String objectId, javax.ws.rs.core.HttpHeaders headers) Get the object data or digest from its id.
javax.ws.rs.core.Response	getObjectMetadata(DataCategory type, String idObject, String xTenantId) Get metadata of the object type.
javax.ws.rs.core.Response	getOfferLogs(String xTenantId, DataCategory type, OfferLogRequest offerLogRequest) Get log of objects from container
javax.ws.rs.core.Response	headObject(DataCategory type, String idObject, String xTenantId, String xDigest, String xDigestAlgorithm) Test the existence of an object HEADER X-Tenant-Id (mandatory) : tenant's identifier
javax.ws.rs.core.Response	postObject(String objectGUID, DataCategory type, javax.ws.rs.core.HttpHeaders headers, ObjectInit objectInit) Initialise a new object.
javax.ws.rs.core.Response	putObject(DataCategory type, String objectId, javax.ws.rs.core.HttpHeaders headers, InputStream input) Write a new chunk in an object or end its creation. Replaces units and objectGroups object type if exist

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

Constructor Detail

DefaultOfferResource

public DefaultOfferResource(DefaultOfferService defaultOfferService)

Constructor

Parameters:

defaultOfferService -

Method Detail

getCapacity

@HEAD
 @Path(value="/objects/{type}")
 @Produces(value="application/json")
public javax.ws.rs.core.Response getCapacity(@HeaderParam(value="X-Tenant-Id")
                                                                                                                        String xTenantId,
                                                                                                                        @PathParam(value="type")
                                                                                                                        DataCategory type)

Get the information on the offer objects collection (free and used capacity, etc)

Parameters:

xTenantId - XtenantId

type - The container type

Returns:

information on the offer objects collection

getContainerList

@GET
 @Path(value="/objects/{type}")
 @Consumes(value="application/json")
 @Produces(value="application/json")
public javax.ws.rs.core.Response getContainerList(@HeaderParam(value="X-Cursor")
                                                                                                                                                                 boolean xcursor,
                                                                                                                                                                 @HeaderParam(value="X-Cursor-Id")
                                                                                                                                                                 String xcursorId,
                                                                                                                                                                 @HeaderParam(value="X-Tenant-Id")
                                                                                                                                                                 String xTenantId,
                                                                                                                                                                 @PathParam(value="type")
                                                                                                                                                                 DataCategory type)

Get container object list

Parameters:

xcursor - if true means new query, if false means end of query from client side

xcursorId - if present, means continue on cursor

xTenantId - the tenant id

type - object type

Returns:

an iterator with each object metadata (actually only the id)

getOfferLogs

@GET
 @Path(value="/objects/{type}/logs")
 @Consumes(value="application/json")
 @Produces(value="application/json")
public javax.ws.rs.core.Response getOfferLogs(@HeaderParam(value="X-Tenant-Id")
                                                                                                                                                                  String xTenantId,
                                                                                                                                                                  @PathParam(value="type")
                                                                                                                                                                  DataCategory type,
                                                                                                                                                                  OfferLogRequest offerLogRequest)

Get log of objects from container

Parameters:

xTenantId - the tenant id

type - object type

offerLogRequest - request params

Returns:

list of objects infos

countObjects

@GET
 @Path(value="/count/objects/{type}")
 @Produces(value="application/json")
public javax.ws.rs.core.Response countObjects(@HeaderParam(value="X-Tenant-Id")
                                                                                                                              String xTenantId,
                                                                                                                              @PathParam(value="type")
                                                                                                                              DataCategory type)

Count the number of objects on the offer objects defined container (exlude directories)

Parameters:

xTenantId -

type -

Returns:

number of binary objects in the container

getObject

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

Get the object data or digest from its id.

HEADER X-Tenant-Id (mandatory) : tenant's identifier HEADER "X-type" (optional) : data (dfault) or digest

Parameters:

type - Object type

objectId - object id :.+ in order to get all path if some '/' are provided

headers - http header

Returns:

response

Throws:

IOException - when there is an error of get object

postObject

@POST
 @Path(value="/objects/{type}/{guid:.+}")
 @Consumes(value="application/json")
 @Produces(value="application/json")
public javax.ws.rs.core.Response postObject(@PathParam(value="guid")
                                                                                                                                                                      String objectGUID,
                                                                                                                                                                      @PathParam(value="type")
                                                                                                                                                                      DataCategory type,
                                                                                                                                                                      @Context
                                                                                                                                                                      javax.ws.rs.core.HttpHeaders headers,
                                                                                                                                                                      ObjectInit objectInit)

Initialise a new object.

HEADER X-Command (mandatory) : INIT
HEADER X-Tenant-Id (mandatory) : tenant's identifier

Parameters:

type - New object's type

objectGUID - the GUID Of the object

headers - http header

objectInit - data for object creation

Returns:

structured response with the object id

putObject

@PUT
 @Path(value="/objects/{type}/{id:.+}")
 @Consumes(value="application/octet-stream")
 @Produces(value="application/json")
public javax.ws.rs.core.Response putObject(@PathParam(value="type")
                                                                                                                                                                          DataCategory type,
                                                                                                                                                                          @PathParam(value="id")
                                                                                                                                                                          String objectId,
                                                                                                                                                                          @Context
                                                                                                                                                                          javax.ws.rs.core.HttpHeaders headers,
                                                                                                                                                                          InputStream input)

Write a new chunk in an object or end its creation.
Replaces units and objectGroups object type if exist

HEADER X-Command (mandatory) : WRITE/END HEADER X-Tenant-Id (mandatory) : tenant's identifier

Parameters:

type - Object type to update

objectId - object id

headers - http header

input - object data

Returns:

structured response with the object id (and new digest ?)

deleteObject

@DELETE
 @Path(value="/objects/{type}/{id:.+}")
 @Produces(value="application/json")
public javax.ws.rs.core.Response deleteObject(@HeaderParam(value="X-Tenant-Id")
                                                                                                                                   String xTenantId,
                                                                                                                                   @HeaderParam(value="X-digest")
                                                                                                                                   String xDigest,
                                                                                                                                   @HeaderParam(value="X-digest-algorithm")
                                                                                                                                   String xDigestAlgorithm,
                                                                                                                                   @PathParam(value="type")
                                                                                                                                   DataCategory type,
                                                                                                                                   @PathParam(value="id")
                                                                                                                                   String idObject)

Delete an Object

Parameters:

xTenantId - the tenantId

xDigest - the digest of the object to delete

xDigestAlgorithm - the digest algorithm

type - Object type to delete

idObject - the id of the object to be tested

Returns:

the response with a specific HTTP status

headObject

@HEAD
 @Path(value="/objects/{type}/{id:.+}")
public javax.ws.rs.core.Response headObject(@PathParam(value="type")
                                                                                          DataCategory type,
                                                                                          @PathParam(value="id")
                                                                                          String idObject,
                                                                                          @HeaderParam(value="X-Tenant-Id")
                                                                                          String xTenantId,
                                                                                          @HeaderParam(value="X-digest")
                                                                                          String xDigest,
                                                                                          @HeaderParam(value="X-digest-algorithm")
                                                                                          String xDigestAlgorithm)

Test the existence of an object HEADER X-Tenant-Id (mandatory) : tenant's identifier

Parameters:

type - Object type to test

idObject - the id of the object to be tested

xTenantId - the id of the tenant

xDigest - the digest

xDigestAlgorithm - the digest algorithm

Returns:

the response with a specific HTTP status. If none of DIGEST or DIGEST_ALGORITHM headers is given, an existence test is done and can return 204/404 as response. If only DIGEST or only DIGEST_ALGORITHM header is given, a not implemented exception is thrown. Later, this should respond with 200/409. If both DIGEST and DIGEST_ALGORITHM header are given, a full digest check is done and can return 200/409 as response

getObjectMetadata

@GET
 @Path(value="/objects/{type}/{id:.+}/metadatas")
 @Produces(value="application/json")
public javax.ws.rs.core.Response getObjectMetadata(@PathParam(value="type")
                                                                                                                                               DataCategory type,
                                                                                                                                               @PathParam(value="id")
                                                                                                                                               String idObject,
                                                                                                                                               @HeaderParam(value="X-Tenant-Id")
                                                                                                                                               String xTenantId)

Get metadata of the object type.

Parameters:

type - Object type to test

idObject - the id of the object to be tested

xTenantId - the id of the tenant

Returns:

metadatas