fr.gouv.vitam.workspace.rest

Class WorkspaceResource

java.lang.Object

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

fr.gouv.vitam.workspace.rest.WorkspaceResource

All Implemented Interfaces:

VitamResource

@Path(value="/workspace/v1")
public class WorkspaceResource
extends ApplicationStatusResource

The Workspace 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
WorkspaceResource(StorageConfiguration configuration) Constructor used to configure a workspace

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	compress(String containerName, CompressInformation compressInformation) zip a specific folder into a other directory
javax.ws.rs.core.Response	computeObjectDigest(String containerName, String objectName, String algo) checks if a object exists in an container or compute object Digest
javax.ws.rs.core.Response	countObjects(String containerName) Count the number of binary files in the container
javax.ws.rs.core.Response	createContainer(String containerName) creates a container into the workspace
javax.ws.rs.core.Response	createFolder(String containerName, String folderName) creates a folder into a container
javax.ws.rs.core.Response	deleteContainer(String containerName, boolean recursive) deletes a container in the workspace
javax.ws.rs.core.Response	deleteFolder(String containerName, String folderName) deletes a folder in a container
javax.ws.rs.core.Response	deleteObject(String containerName, String objectName) Deletes an objects in a container *
javax.ws.rs.core.Response	getContainerInformation(String containerName) Get container information like capacity
javax.ws.rs.core.Response	getObject(String containerName, String objectName) gets an objects from a container in the workspace
javax.ws.rs.core.Response	getObjectInformation(String containerName, String objectName) gets an objects from a container in the workspace
javax.ws.rs.core.Response	getUriDigitalObjectListByFolder(String containerName, String folderName) gets the list of object from folder
javax.ws.rs.core.Response	isExistingContainer(String containerName) checks if a container exists in the workspace
javax.ws.rs.core.Response	isExistingFolder(String containerName, String folderName) checks if a folder exists in a container
javax.ws.rs.core.Response	putObject(InputStream stream, String containerName, String objectName) puts an object into a container
javax.ws.rs.core.Response	uncompressObject(InputStream stream, String containerName, String folderName, String archiveType) uncompress a sip into the workspace

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

WorkspaceResource

public WorkspaceResource(StorageConfiguration configuration)

Constructor used to configure a workspace

Parameters:

configuration - the storage config

Method Detail

createContainer

@Path(value="/containers/{containerName}")
 @POST
 @Produces(value="application/json")
public javax.ws.rs.core.Response createContainer(@PathParam(value="containerName")
                                                                                                                                        String containerName)

creates a container into the workspace

Parameters:

containerName - as path param

Returns:

Response

deleteContainer

@Path(value="/containers/{containerName}")
 @DELETE
 @Produces(value="application/json")
public javax.ws.rs.core.Response deleteContainer(@PathParam(value="containerName")
                                                                                                                                          String containerName,
                                                                                                                                          @HeaderParam(value="X-Recursive")
                                                                                                                                          boolean recursive)

deletes a container in the workspace

Parameters:

containerName - path param of container name

recursive - true if the container should be deleted recursively

Returns:

Response

isExistingContainer

@Path(value="/containers/{containerName}")
 @HEAD
 @Produces(value="application/json")
public javax.ws.rs.core.Response isExistingContainer(@PathParam(value="containerName")
                                                                                                                                            String containerName)

checks if a container exists in the workspace

Parameters:

containerName - path param for container name

Returns:

Response

countObjects

@Path(value="/containers/{containerName}/count")
 @GET
 @Produces(value="application/json")
public javax.ws.rs.core.Response countObjects(@PathParam(value="containerName")
                                                                                                                                          String containerName)

Count the number of binary files in the container

Parameters:

containerName - path param for container name

Returns:

Response containing the number of objects in "objectNumber"

getContainerInformation

@Path(value="/container/{containerName}")
 @GET
 @Produces(value="application/json")
public javax.ws.rs.core.Response getContainerInformation(@PathParam(value="containerName")
                                                                                                                                              String containerName)

Get container information like capacity

Parameters:

containerName - the container name

Returns:

a Json with usableSpace and usedSpace information

createFolder

@Path(value="/containers/{containerName}/folders/{folderName:.*}")
 @POST
 @Produces(value="application/json")
public javax.ws.rs.core.Response createFolder(@PathParam(value="containerName")
                                                                                                                                                             String containerName,
                                                                                                                                                             @PathParam(value="folderName")
                                                                                                                                                             String folderName)

creates a folder into a container

Parameters:

containerName - path param of container name

folderName - path param of folder

Returns:

Response

deleteFolder

@Path(value="/containers/{containerName}/folders/{folderName:.*}")
 @DELETE
 @Produces(value="application/json")
public javax.ws.rs.core.Response deleteFolder(@PathParam(value="containerName")
                                                                                                                                                               String containerName,
                                                                                                                                                               @PathParam(value="folderName")
                                                                                                                                                               String folderName)

deletes a folder in a container

Parameters:

containerName - path param for container name

folderName - path param for folder name

Returns:

Response

isExistingFolder

@Path(value="/containers/{containerName}/folders/{folderName:.*}")
 @HEAD
 @Produces(value="application/json")
public javax.ws.rs.core.Response isExistingFolder(@PathParam(value="containerName")
                                                                                                                                                                 String containerName,
                                                                                                                                                                 @PathParam(value="folderName")
                                                                                                                                                                 String folderName)

checks if a folder exists in a container

Parameters:

containerName - path param for container name

folderName - path param for folder name

Returns:

Response

uncompressObject

@Path(value="/containers/{containerName}/folders/{folderName:.*}")
 @PUT
 @Consumes(value={"application/zip","application/x-gzip","application/x-tar","application/x-bzip2"})
 @Produces(value="application/json")
public javax.ws.rs.core.Response uncompressObject(InputStream stream,
                                                                                                                                                                                                                                                                     @PathParam(value="containerName")
                                                                                                                                                                                                                                                                     String containerName,
                                                                                                                                                                                                                                                                     @PathParam(value="folderName")
                                                                                                                                                                                                                                                                     String folderName,
                                                                                                                                                                                                                                                                     @HeaderParam(value="Content-Type")
                                                                                                                                                                                                                                                                     String archiveType)

uncompress a sip into the workspace

Parameters:

stream - data input stream

containerName - name of container

folderName - name of folder

archiveType - the type of archive

Returns:

Response

compress

@Path(value="/containers/{containerName}")
 @POST
 @Consumes(value="application/json")
public javax.ws.rs.core.Response compress(@PathParam(value="containerName")
                                                                                                                                 String containerName,
                                                                                                                                 CompressInformation compressInformation)

zip a specific folder into a other directory

Parameters:

containerName -

Returns:

getUriDigitalObjectListByFolder

@Path(value="/containers/{containerName}/folders/{folderName:.*}")
 @GET
 @Produces(value="application/json")
public javax.ws.rs.core.Response getUriDigitalObjectListByFolder(@PathParam(value="containerName")
                                                                                                                                                                               String containerName,
                                                                                                                                                                               @PathParam(value="folderName")
                                                                                                                                                                               String folderName)

gets the list of object from folder

Parameters:

containerName - name of container

folderName - name of folder

Returns:

Response

putObject

@Path(value="/containers/{containerName}/objects/{objectName:.*}")
 @POST
 @Consumes(value="application/octet-stream")
 @Produces(value="application/json")
public javax.ws.rs.core.Response putObject(InputStream stream,
                                                                                                                                                                                                       @PathParam(value="containerName")
                                                                                                                                                                                                       String containerName,
                                                                                                                                                                                                       @PathParam(value="objectName")
                                                                                                                                                                                                       String objectName)

puts an object into a container

Parameters:

stream - data input stream

objectName - name of data object

containerName - name of container

Returns:

Response

deleteObject

@Path(value="/containers/{containerName}/objects/{objectName:.*}")
 @DELETE
 @Produces(value="application/json")
public javax.ws.rs.core.Response deleteObject(@PathParam(value="containerName")
                                                                                                                                                               String containerName,
                                                                                                                                                               @PathParam(value="objectName")
                                                                                                                                                               String objectName)

Deletes an objects in a container *

Parameters:

containerName - container name

objectName - object name

Returns:

Response

getObject

@Path(value="/containers/{containerName}/objects/{objectName:.*}")
 @GET
 @Produces(value="application/octet-stream")
public javax.ws.rs.core.Response getObject(@PathParam(value="containerName")
                                                                                                                                                                 String containerName,
                                                                                                                                                                 @PathParam(value="objectName")
                                                                                                                                                                 String objectName)

gets an objects from a container in the workspace

Parameters:

containerName - name of container

objectName - name of object

Returns:

response

Throws:

IOException - when there is an error of get object

getObjectInformation

@Path(value="/containers/{containerName}/objects/{objectName:.*}")
 @GET
 @Produces(value="application/json")
public javax.ws.rs.core.Response getObjectInformation(@PathParam(value="containerName")
                                                                                                                                                                    String containerName,
                                                                                                                                                                    @PathParam(value="objectName")
                                                                                                                                                                    String objectName)
                                                                                                                                                             throws IOException

gets an objects from a container in the workspace

Parameters:

containerName - name of container

objectName - name of object

Returns:

Response

Throws:

IOException - when there is an error of get object

computeObjectDigest

@Path(value="/containers/{containerName}/objects/{objectName:.*}")
 @HEAD
 @Produces(value="application/json")
public javax.ws.rs.core.Response computeObjectDigest(@PathParam(value="containerName")
                                                                                                                                                                    String containerName,
                                                                                                                                                                    @PathParam(value="objectName")
                                                                                                                                                                    String objectName,
                                                                                                                                                                    @HeaderParam(value="X-digest-algorithm")
                                                                                                                                                                    String algo)

checks if a object exists in an container or compute object Digest

Parameters:

containerName - name of container

objectName - name of object

algo - path parameter of algo

Returns:

Response