fr.gouv.vitam.ingest.external.rest

Class IngestExternalResource

java.lang.Object

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

fr.gouv.vitam.ingest.external.rest.IngestExternalResource

All Implemented Interfaces:

VitamResource

@Path(value="/ingest-external/v1")
public class IngestExternalResource
extends ApplicationStatusResource

The Ingest External 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
IngestExternalResource(IngestExternalConfiguration ingestExternalConfiguration, SecureEndpointRegistry secureEndpointRegistry) Constructor IngestExternalResource

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	downloadArchiveTransferReplyAsStream(String objectId) Download archive transfer reply stored by Ingest operation
javax.ws.rs.core.Response	downloadIngestManifestsAsStream(String objectId) Download manifest stored by Ingest operation
javax.ws.rs.core.Response	listResourceEndpoints() List secured resource end points
void	upload(String contextId, String action, InputStream uploadedInputStream, javax.ws.rs.container.AsyncResponse asyncResponse) upload the file in local
void	uploadLocal(String contextId, String action, LocalFile localFile, javax.ws.rs.container.AsyncResponse asyncResponse) upload a local file

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

IngestExternalResource

public IngestExternalResource(IngestExternalConfiguration ingestExternalConfiguration,
                              SecureEndpointRegistry secureEndpointRegistry)

Constructor IngestExternalResource

Parameters:

ingestExternalConfiguration - the configuration of server resource

secureEndpointRegistry -

Method Detail

listResourceEndpoints

@Path(value="/")
 @OPTIONS
 @Produces(value="application/json")
public javax.ws.rs.core.Response listResourceEndpoints()

List secured resource end points

Returns:

response

upload

@Path(value="ingests")
 @POST
 @Consumes(value="application/octet-stream")
public void upload(@HeaderParam(value="X-Context-Id")
                                                                                              String contextId,
                                                                                              @HeaderParam(value="X-ACTION")
                                                                                              String action,
                                                                                              InputStream uploadedInputStream,
                                                                                              @Suspended
                                                                                              javax.ws.rs.container.AsyncResponse asyncResponse)

upload the file in local

Parameters:

contextId - the context id of upload

action - in workflow

uploadedInputStream - data input stream

asyncResponse - the asynchronized response

uploadLocal

@Path(value="ingests")
 @POST
 @Consumes(value="application/json")
public void uploadLocal(@HeaderParam(value="X-Context-Id")
                                                                                           String contextId,
                                                                                           @HeaderParam(value="X-ACTION")
                                                                                           String action,
                                                                                           LocalFile localFile,
                                                                                           @Suspended
                                                                                           javax.ws.rs.container.AsyncResponse asyncResponse)

upload a local file

Parameters:

contextId - the context id of upload

action - in workflow

localFile - local file

asyncResponse - the asynchronized response

downloadArchiveTransferReplyAsStream

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

Download archive transfer reply stored by Ingest operation

Return the archive transfer reply as stream asynchronously

The caller is responsible to close the Response after consuming the inputStream.

Parameters:

objectId - the id of archive transfer reply to download

Returns:

response

downloadIngestManifestsAsStream

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

Download manifest stored by Ingest operation

Return the manifest as stream asynchronously

The caller is responsible to close the Response after consuming the inputStream.

Parameters:

objectId - the id of object to download

Returns:

The given response with the manifest