Package fr.gouv.vitam.ingest.external.client

Interface IngestExternalClient

All Superinterfaces:
AutoCloseable, MockOrRestClient, VitamAutoCloseable
public interface IngestExternalClient extends MockOrRestClient
Ingest external interface

  • Method Details

    • ingest

      RequestResponse<Void> ingest(VitamContext vitamContext, InputStream stream, String contextId, String action) throws IngestExternalException
      ingest upload file in local and launch an ingest workflow
      Parameters:
      vitamContext - the vitam context
      stream -
      contextId - a type of ingest among "DEFAULT_WORKFLOW" (Sip ingest), "HOLDING_SCHEME" (tree) "FILING_SCHEME" (plan) and "BLANK_TEST" (Sip ingest test)
      action - an action as a string among "RESUME" (launch workflow entirely) and "NEXT" (launch ingest in step by step mode)
      Returns:
      response
      Throws:
      IngestExternalException

    • ingest

      RequestResponse<Void> ingest(VitamContext vitamContext, InputStream stream, IngestRequestParameters ingestRequestParameters) throws IngestExternalException
      ingest upload file in local and launch an ingest workflow
      Parameters:
      vitamContext - the vitam context
      stream - sip input stream
      ingestRequestParameters - ingest request parameters
      Returns:
      response
      Throws:
      IngestExternalException

    • downloadObjectAsync

      javax.ws.rs.core.Response downloadObjectAsync(VitamContext vitamContext, String objectId, IngestCollection type) throws VitamClientException
      Download object stored by ingest operation

      The caller is responsible to close the Response after consuming the inputStream.
      Parameters:
      vitamContext - the vitam context
      objectId -
      type -
      Returns:
      object as stream
      Throws:
      VitamClientException

    • ingestLocal

      RequestResponse<Void> ingestLocal(VitamContext vitamContext, LocalFile localFile, String contextId, String action) throws IngestExternalException
      ingest a file that has been uploaded locally on a vitam folder then launch an ingest workflow
      Parameters:
      vitamContext - the vitam context
      localFile - the localFile information
      contextId - a type of ingest among "DEFAULT_WORKFLOW" (Sip ingest), "HOLDING_SCHEME" (tree) "FILING_SCHEME" (plan) and "BLANK_TEST" (Sip ingest test)
      action - an action as a string among "RESUME" (launch workflow entirely) and "NEXT" (launch ingest in step by step mode)
      Returns:
      response
      Throws:
      IngestExternalException

    • ingestLocal

      RequestResponse<Void> ingestLocal(VitamContext vitamContext, LocalFile localFile, IngestRequestParameters ingestRequestParameters) throws IngestExternalException
      ingest a file that has been uploaded locally on a vitam folder then launch an ingest workflow
      Parameters:
      vitamContext - the vitam context
      localFile - the localFile information
      ingestRequestParameters - ingest request parameters
      Returns:
      response
      Throws:
      IngestExternalException