Package 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

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

Field Summary

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

STATUS_URL, TENANTS_URL

Constructor Summary

Constructors

Constructor	Description
IngestExternalResource(IngestExternalConfiguration ingestExternalConfiguration, SecureEndpointRegistry secureEndpointRegistry, FormatIdentifierFactory formatIdentifierFactory, IngestInternalClientFactory ingestInternalClientFactory, AntivirusClientFactory antivirusClientFactory)	Constructor IngestExternalResource

Method Summary

Modifier and Type	Method	Description
jakarta.ws.rs.core.Response	downloadArchiveTransferReplyAsStream(String objectId)	Download archive transfer reply stored by Ingest operation
jakarta.ws.rs.core.Response	downloadIngestManifestsAsStream(String objectId)	Download manifest stored by Ingest operation
jakarta.ws.rs.core.Response	listResourceEndpoints()	List secured resource end points
void	upload(String contextId, String action, String manifestDigestAlgo, String manifestDigestValue, InputStream uploadedInputStream, jakarta.ws.rs.container.AsyncResponse asyncResponse)	upload the file in local
void	uploadLocal(String contextId, String action, String manifestDigestAlgo, String manifestDigestValue, LocalFile localFile, jakarta.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 Details

IngestExternalResource

public IngestExternalResource(IngestExternalConfiguration ingestExternalConfiguration,
 SecureEndpointRegistry secureEndpointRegistry,
 FormatIdentifierFactory formatIdentifierFactory,
 IngestInternalClientFactory ingestInternalClientFactory,
 AntivirusClientFactory antivirusClientFactory)

Constructor IngestExternalResource

Parameters:

ingestExternalConfiguration - the configuration of server resource

secureEndpointRegistry -

Method Details

listResourceEndpoints

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

List secured resource end points

Returns:

response

upload

@Path("ingests")
@POST
@Consumes("application/octet-stream")
public void upload(@HeaderParam("X-Context-Id")
 String contextId,
 @HeaderParam("X-ACTION")
 String action,
 @HeaderParam("X-Manifest-Digest-Algo")
 String manifestDigestAlgo,
 @HeaderParam("X-Manifest-Digest-Value")
 String manifestDigestValue,
 InputStream uploadedInputStream,
 @Suspended
 jakarta.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("ingests")
@POST
@Consumes("application/json")
public void uploadLocal(@HeaderParam("X-Context-Id")
 String contextId,
 @HeaderParam("X-ACTION")
 String action,
 @HeaderParam("X-Manifest-Digest-Algo")
 String manifestDigestAlgo,
 @HeaderParam("X-Manifest-Digest-Value")
 String manifestDigestValue,
 LocalFile localFile,
 @Suspended
 jakarta.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("/ingests/{objectId}/archivetransferreply")
@Produces("application/octet-stream")
public jakarta.ws.rs.core.Response downloadArchiveTransferReplyAsStream(@PathParam("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("/ingests/{objectId}/manifests")
@Produces("application/octet-stream")
public jakarta.ws.rs.core.Response downloadIngestManifestsAsStream(@PathParam("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