Package com.opentext.ia.sdk.client.api

Interface ArchiveClient

All Known Implementing Classes:
InfoArchiveRestClient
public interface ArchiveClient
Client that interacts with an Archive.

  • Method Summary

    Modifier and Type Method Description
    OrderItem export​(SearchResults searchResults, ExportConfiguration exportConfiguration, java.lang.String outputName)
    Start the export of the search results for the specified export configuration.
    OrderItem exportAndWaitForDownloadLink​(SearchResults searchResults, ExportConfiguration exportConfiguration, java.lang.String outputName, java.util.concurrent.TimeUnit timeUnit, long timeOut)
    Start and wait the export of the search results for the specified export configuration.
    ContentResult fetchContent​(java.lang.String contentId)
    Deprecated.
    Will be removed without replacement in a future version
    ContentResult fetchOrderContent​(OrderItem orderItem)
    Deprecated.
    Will be removed without replacement in a future version
    java.lang.String ingest​(java.io.InputStream sip)
    Ingest a Submission Information Package (SIP) into the Archive.
    java.lang.String ingestDirect​(java.io.InputStream sip)
    Ingest a Submission Information Package (SIP) into the Archive.
    SearchResults search​(SearchQuery searchQuery, SearchComposition searchComposition)
    Get the search results for the specified search query and composition.
    JobInstance search​(java.lang.String jobName, java.lang.String applicationName, java.lang.String tenantName)
    Creates Job Instance for the specified tenant and application .
    LinkContainer uploadTransformation​(ExportTransformation exportTransformation, java.io.InputStream zip)
    Deprecated.
    Use declarative configuration to define transformations

  • Method Details

    • ingest

      java.lang.String ingest​(java.io.InputStream sip) throws java.io.IOException
      Ingest a Submission Information Package (SIP) into the Archive.
      Parameters:
      sip - The SIP to add to the Archive
      Returns:
      The ID of the Archival Information Package (AIP) that was generated from the SIP
      Throws:
      java.io.IOException - When an I/O error occurs

    • ingestDirect

      java.lang.String ingestDirect​(java.io.InputStream sip) throws java.io.IOException
      Ingest a Submission Information Package (SIP) into the Archive. Will take advantage of the ingestDirect resource if present, otherwise will revert to receive + ingest. Note: only works if synchronous commit is enabled on the holding and the SIP being ingested is NOT part of a multi-SIP DSS.
      Parameters:
      sip - The SIP to add to the Archive
      Returns:
      The ID of the Archival Information Package (AIP) that was generated from the SIP
      Throws:
      java.io.IOException - When an I/O error occurs

    • fetchContent

      @Deprecated ContentResult fetchContent​(java.lang.String contentId) throws java.io.IOException
      Deprecated.
      Will be removed without replacement in a future version
      Fetch the content for the specified content id.
      Parameters:
      contentId - The id of the content to fetch.
      Returns:
      A ContentResult
      Throws:
      java.io.IOException - When an I/O error occurs

    • fetchOrderContent

      @Deprecated ContentResult fetchOrderContent​(OrderItem orderItem) throws java.io.IOException
      Deprecated.
      Will be removed without replacement in a future version
      Fetch the content for the specified order item.
      Parameters:
      orderItem - The order item.
      Returns:
      A ContentResult
      Throws:
      java.io.IOException - When an I/O error occurs

    • search

      SearchResults search​(SearchQuery searchQuery, SearchComposition searchComposition) throws java.io.IOException
      Get the search results for the specified search query and composition.
      Parameters:
      searchQuery - The search query.
      searchComposition - The search composition.
      Returns:
      A SearchResults
      Throws:
      java.io.IOException - When an I/O error occurs

    • export

      OrderItem export​(SearchResults searchResults, ExportConfiguration exportConfiguration, java.lang.String outputName) throws java.io.IOException
      Start the export of the search results for the specified export configuration.
      Parameters:
      searchResults - The search results.
      exportConfiguration - The export configuration.
      outputName - The output name of result package.
      Returns:
      An OrderItem object that contains information about exported package without link to download it
      Throws:
      java.io.IOException - When an I/O error occurs

    • exportAndWaitForDownloadLink

      OrderItem exportAndWaitForDownloadLink​(SearchResults searchResults, ExportConfiguration exportConfiguration, java.lang.String outputName, java.util.concurrent.TimeUnit timeUnit, long timeOut) throws java.io.IOException
      Start and wait the export of the search results for the specified export configuration.
      Parameters:
      searchResults - The search results.
      exportConfiguration - The export configuration.
      outputName - The output name of result package.
      timeUnit - The unit of the timeOut value
      timeOut - The time out of export process
      Returns:
      An OrderItem object that contains information about exported package and link to download it
      Throws:
      java.io.IOException - When an I/O error occurs

    • uploadTransformation

      @Deprecated LinkContainer uploadTransformation​(ExportTransformation exportTransformation, java.io.InputStream zip) throws java.io.IOException
      Deprecated.
      Use declarative configuration to define transformations
      Upload the transformation zip with the stylesheet into Archive.
      Parameters:
      exportTransformation - The export transformation.
      zip - The input stream of zip with stylesheet.
      Returns:
      The uploaded transformation
      Throws:
      java.io.IOException - When an I/O error occurs

    • search

      JobInstance search​(java.lang.String jobName, java.lang.String applicationName, java.lang.String tenantName) throws java.io.IOException
      Creates Job Instance for the specified tenant and application .
      Parameters:
      jobName - The anme of the Job to run
      applicationName - The application name that the job in run over
      tenantName - The tenant name that the application is located at
      Returns:
      A JobInstance
      Throws:
      java.io.IOException - When an I/O error occurs