fr.gouv.vitam.ingest.internal.upload.rest

Class IngestInternalResource

java.lang.Object

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

fr.gouv.vitam.ingest.internal.upload.rest.IngestInternalResource

All Implemented Interfaces:

VitamResource

@Path(value="/ingest/v1")
 @ApplicationPath(value="webresources")
public class IngestInternalResource
extends ApplicationStatusResource

IngestInternalResource

Field Summary

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

STATUS_URL, TENANTS_URL

Constructor Summary

Constructors

Constructor and Description
IngestInternalResource(IngestInternalConfiguration configuration) IngestInternalResource constructor

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	delegateCreateLogbookOperation(Queue<LogbookOperationParameters> queue) Allow to create a logbook by delegation
javax.ws.rs.core.Response	delegateUpdateLogbookOperation(Queue<LogbookOperationParameters> queue) Allow to update a logbook by delegation
javax.ws.rs.core.Response	downloadObjectAsStream(String objectId, String type) Download object stored by Ingest operation (currently ATR and manifest)
javax.ws.rs.core.Response	executeWorkFlow(javax.ws.rs.core.HttpHeaders headers, String id, InputStream uploadedInputStream) Execute the process of an operation related to the id.
javax.ws.rs.core.Response	getWorkflowDefinitions(javax.ws.rs.core.HttpHeaders headers)
javax.ws.rs.core.Response	getWorkFlowExecutionStatus(String id)
javax.ws.rs.core.Response	getWorkFlowStatus(String id) get the workflow status
javax.ws.rs.core.Response	interruptWorkFlowExecution(String id) Interrupt the process of an operation identified by Id.
javax.ws.rs.core.Response	listOperationsDetails(javax.ws.rs.core.HttpHeaders headers, ProcessQuery query)
javax.ws.rs.core.Response	storeATR(String guid, InputStream atr)
javax.ws.rs.core.Response	updateWorkFlowStatus(javax.ws.rs.core.HttpHeaders headers, String id) Update the status of an operation.
javax.ws.rs.core.Response	uploadSipAsStream(String contentType, String contextId, String actionId, InputStream uploadedInputStream) Upload compressed SIP as Stream, will be uncompressed in workspace. Will return Response containing an InputStream for the ArchiveTransferReply (OK or KO) except in INTERNAL_ERROR (no body)

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

IngestInternalResource

public IngestInternalResource(IngestInternalConfiguration configuration)

IngestInternalResource constructor

Parameters:

configuration - ingest configuration

Method Detail

delegateCreateLogbookOperation

@POST
 @Path(value="/logbooks")
 @Consumes(value="application/json")
 @Produces(value="application/json")
public javax.ws.rs.core.Response delegateCreateLogbookOperation(Queue<LogbookOperationParameters> queue)

Allow to create a logbook by delegation

Parameters:

queue - list of LogbookOperationParameters, first being the created master

Returns:

the status of the request (CREATED meaning OK)

delegateUpdateLogbookOperation

@PUT
 @Path(value="/logbooks")
 @Consumes(value="application/json")
 @Produces(value="application/json")
public javax.ws.rs.core.Response delegateUpdateLogbookOperation(Queue<LogbookOperationParameters> queue)

Allow to update a logbook by delegation

Parameters:

queue - list of LogbookOperationParameters in append mode (created already done before)

Returns:

the status of the request (OK)

uploadSipAsStream

@POST
 @Path(value="/ingests")
 @Consumes(value={"application/octet-stream","application/zip","application/x-gzip","application/x-tar","application/x-bzip2"})
public javax.ws.rs.core.Response uploadSipAsStream(@HeaderParam(value="Content-Type")
                                                                                                                                                                                                                  String contentType,
                                                                                                                                                                                                                  @HeaderParam(value="X-Context-Id")
                                                                                                                                                                                                                  String contextId,
                                                                                                                                                                                                                  @HeaderParam(value="X-ACTION")
                                                                                                                                                                                                                  String actionId,
                                                                                                                                                                                                                  InputStream uploadedInputStream)

Upload compressed SIP as Stream, will be uncompressed in workspace.

Will return Response containing an InputStream for the ArchiveTransferReply (OK or KO) except in INTERNAL_ERROR (no body)

Parameters:

contentType - the header Content-Type (zip, tar, ...)

contextId - the header X-Context-Id (steptoStep or not)

actionId - the header X-ACTION (next,resume,..)

uploadedInputStream - the stream to upload

Throws:

InternalServerException - if request resources server exception occurred

VitamClientException - if the server is unreachable

updateWorkFlowStatus

@Path(value="/operations/{id}")
 @PUT
 @Produces(value="application/json")
public javax.ws.rs.core.Response updateWorkFlowStatus(@Context
                                                                                                                                 javax.ws.rs.core.HttpHeaders headers,
                                                                                                                                 @PathParam(value="id")
                                                                                                                                 String id)

Update the status of an operation.

Parameters:

headers - contain X-Action and X-Context-ID

id - operation identifier

Returns:

http response

executeWorkFlow

@Path(value="/operations/{id}")
 @POST
 @Consumes(value={"application/octet-stream","application/zip","application/x-gzip","application/x-tar","application/x-bzip2"})
 @Produces(value="application/octet-stream")
public javax.ws.rs.core.Response executeWorkFlow(@Context
                                                                                                                                                                                                                                                                     javax.ws.rs.core.HttpHeaders headers,
                                                                                                                                                                                                                                                                     @PathParam(value="id")
                                                                                                                                                                                                                                                                     String id,
                                                                                                                                                                                                                                                                     InputStream uploadedInputStream)

Execute the process of an operation related to the id.

Parameters:

headers - contain X-Action and X-Context-ID

id - operation identifier

uploadedInputStream - input stream to upload

Returns:

http response

Throws:

InternalServerException - if request resources server exception

VitamClientException - if the server is unreachable

IngestInternalException - if error when request to ingest internal server

InvalidGuidOperationException - if error when create guid

ProcessingException - if error in workflow execution

getWorkFlowExecutionStatus

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

Parameters:

id - operation identifier

Returns:

http response

getWorkFlowStatus

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

get the workflow status

Parameters:

id - operation identifier

Returns:

http response

interruptWorkFlowExecution

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

Interrupt the process of an operation identified by Id.

Parameters:

id - operation identifier

Returns:

http response

downloadObjectAsStream

@GET
 @Path(value="/ingests/{objectId}/{type}")
 @Produces(value="application/octet-stream")
public javax.ws.rs.core.Response downloadObjectAsStream(@PathParam(value="objectId")
                                                                                                                                                     String objectId,
                                                                                                                                                     @PathParam(value="type")
                                                                                                                                                     String type)

Download object stored by Ingest operation (currently ATR and manifest)

Return the object as stream asynchronously

Parameters:

objectId - the object id

type - the collection type

storeATR

@POST
 @Path(value="/ingests/{objectId}/report")
 @Consumes(value="application/octet-stream")
public javax.ws.rs.core.Response storeATR(@PathParam(value="objectId")
                                                                                                                                        String guid,
                                                                                                                                        InputStream atr)

Parameters:

guid - the object guid

atr - the inputstream ATR

Returns:

the status of the request (OK)

listOperationsDetails

@GET
 @Path(value="/operations")
 @Consumes(value="application/json")
 @Produces(value="application/json")
public javax.ws.rs.core.Response listOperationsDetails(@Context
                                                                                                                                                                  javax.ws.rs.core.HttpHeaders headers,
                                                                                                                                                                  ProcessQuery query)

Parameters:

headers - the http header for request

query - the filter query

Returns:

Response

getWorkflowDefinitions

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

Parameters:

headers - the http header for request

Returns:

Response