Class DocumentController


  • public class DocumentController
    extends Object
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      io.swagger.oas.inflector.models.ResponseContext alignDocument​(io.swagger.oas.inflector.models.RequestContext request, UUID docId, com.fasterxml.jackson.databind.JsonNode bodyNode)  
      io.swagger.oas.inflector.models.ResponseContext cancelDocumentProcessing​(io.swagger.oas.inflector.models.RequestContext request, UUID docId)
      Cancels an in-progress document processing operation.
      io.swagger.oas.inflector.models.ResponseContext clearModifiedSegmentsSummary​(io.swagger.oas.inflector.models.RequestContext request, UUID docId)  
      io.swagger.oas.inflector.models.ResponseContext createDocument​(io.swagger.oas.inflector.models.RequestContext request, File docFile, String docUrl, String docFileName, String docEncoding, UUID docId, String docGcsUrl, UUID userId)  
      io.swagger.oas.inflector.models.ResponseContext createDocumentSegment​(io.swagger.oas.inflector.models.RequestContext request, UUID docId, com.fasterxml.jackson.databind.JsonNode bodyNode)
      Create a new segment for a document that has already been imported.
      io.swagger.oas.inflector.models.ResponseContext deleteDocument​(io.swagger.oas.inflector.models.RequestContext request, UUID docId)  
      io.swagger.oas.inflector.models.ResponseContext deleteDocumentSegment​(io.swagger.oas.inflector.models.RequestContext request, UUID docId, UUID docSegId)  
      io.swagger.oas.inflector.models.ResponseContext downloadDocument​(io.swagger.oas.inflector.models.RequestContext request, UUID docId)  
      io.swagger.oas.inflector.models.ResponseContext exportDocument​(io.swagger.oas.inflector.models.RequestContext request, UUID docId, com.fasterxml.jackson.databind.JsonNode bodyNode)  
      io.swagger.oas.inflector.models.ResponseContext getDocuments​(io.swagger.oas.inflector.models.RequestContext request, Integer page, Integer pageSize)  
      io.swagger.oas.inflector.models.ResponseContext getDocumentSegment​(io.swagger.oas.inflector.models.RequestContext request, UUID docId, UUID docSegId)  
      io.swagger.oas.inflector.models.ResponseContext getDocumentSegments​(io.swagger.oas.inflector.models.RequestContext request, UUID docId, Integer page, Integer pageSize)  
      io.swagger.oas.inflector.models.ResponseContext getDocumentStatus​(io.swagger.oas.inflector.models.RequestContext request, UUID docId)  
      io.swagger.oas.inflector.models.ResponseContext getModifiedSegmentsSummary​(io.swagger.oas.inflector.models.RequestContext request, UUID docId, Integer page, Integer pageSize)  
      io.swagger.oas.inflector.models.ResponseContext importDocument​(io.swagger.oas.inflector.models.RequestContext request, UUID docId, com.fasterxml.jackson.databind.JsonNode bodyNode)  
      io.swagger.oas.inflector.models.ResponseContext processDocument​(io.swagger.oas.inflector.models.RequestContext request, UUID docId, com.fasterxml.jackson.databind.JsonNode bodyNode)  
      static void shutdownExecutor()  
      io.swagger.oas.inflector.models.ResponseContext updateDocumentSegment​(io.swagger.oas.inflector.models.RequestContext request, UUID docId, UUID docSegId, com.fasterxml.jackson.databind.JsonNode bodyNode)  
    • Constructor Detail

      • DocumentController

        public DocumentController()
    • Method Detail

      • shutdownExecutor

        public static void shutdownExecutor()
      • cancelDocumentProcessing

        public io.swagger.oas.inflector.models.ResponseContext cancelDocumentProcessing​(io.swagger.oas.inflector.models.RequestContext request,
                                                                                        UUID docId)
        Cancels an in-progress document processing operation.

        This method can cancel any active processing operation (import, align, export, or process) by setting the document status to CANCELLED in Solr and stopping the active pipeline if it's running on this worker node.

        Parameters:
        request - the HTTP request context
        docId - UUID of the document to cancel processing for
        Returns:
        ResponseContext with 204 No Content on success, 400/404/409/500 on error
      • getDocuments

        public io.swagger.oas.inflector.models.ResponseContext getDocuments​(io.swagger.oas.inflector.models.RequestContext request,
                                                                            Integer page,
                                                                            Integer pageSize)
      • importDocument

        public io.swagger.oas.inflector.models.ResponseContext importDocument​(io.swagger.oas.inflector.models.RequestContext request,
                                                                              UUID docId,
                                                                              com.fasterxml.jackson.databind.JsonNode bodyNode)
      • exportDocument

        public io.swagger.oas.inflector.models.ResponseContext exportDocument​(io.swagger.oas.inflector.models.RequestContext request,
                                                                              UUID docId,
                                                                              com.fasterxml.jackson.databind.JsonNode bodyNode)
      • getDocumentStatus

        public io.swagger.oas.inflector.models.ResponseContext getDocumentStatus​(io.swagger.oas.inflector.models.RequestContext request,
                                                                                 UUID docId)
      • downloadDocument

        public io.swagger.oas.inflector.models.ResponseContext downloadDocument​(io.swagger.oas.inflector.models.RequestContext request,
                                                                                UUID docId)
      • deleteDocument

        public io.swagger.oas.inflector.models.ResponseContext deleteDocument​(io.swagger.oas.inflector.models.RequestContext request,
                                                                              UUID docId)
      • getDocumentSegments

        public io.swagger.oas.inflector.models.ResponseContext getDocumentSegments​(io.swagger.oas.inflector.models.RequestContext request,
                                                                                   UUID docId,
                                                                                   Integer page,
                                                                                   Integer pageSize)
      • createDocumentSegment

        public io.swagger.oas.inflector.models.ResponseContext createDocumentSegment​(io.swagger.oas.inflector.models.RequestContext request,
                                                                                     UUID docId,
                                                                                     com.fasterxml.jackson.databind.JsonNode bodyNode)
        Create a new segment for a document that has already been imported. If a segment with the same position already exists, it will be updated instead. You cannot import a document by calling this method in a loop over all its segments -- use createDocument for that.
        Parameters:
        request -
        docId -
        bodyNode -
        Returns:
      • getDocumentSegment

        public io.swagger.oas.inflector.models.ResponseContext getDocumentSegment​(io.swagger.oas.inflector.models.RequestContext request,
                                                                                  UUID docId,
                                                                                  UUID docSegId)
      • updateDocumentSegment

        public io.swagger.oas.inflector.models.ResponseContext updateDocumentSegment​(io.swagger.oas.inflector.models.RequestContext request,
                                                                                     UUID docId,
                                                                                     UUID docSegId,
                                                                                     com.fasterxml.jackson.databind.JsonNode bodyNode)
      • deleteDocumentSegment

        public io.swagger.oas.inflector.models.ResponseContext deleteDocumentSegment​(io.swagger.oas.inflector.models.RequestContext request,
                                                                                     UUID docId,
                                                                                     UUID docSegId)
      • getModifiedSegmentsSummary

        public io.swagger.oas.inflector.models.ResponseContext getModifiedSegmentsSummary​(io.swagger.oas.inflector.models.RequestContext request,
                                                                                          UUID docId,
                                                                                          Integer page,
                                                                                          Integer pageSize)
      • clearModifiedSegmentsSummary

        public io.swagger.oas.inflector.models.ResponseContext clearModifiedSegmentsSummary​(io.swagger.oas.inflector.models.RequestContext request,
                                                                                            UUID docId)
      • createDocument

        public io.swagger.oas.inflector.models.ResponseContext createDocument​(io.swagger.oas.inflector.models.RequestContext request,
                                                                              File docFile,
                                                                              String docUrl,
                                                                              String docFileName,
                                                                              String docEncoding,
                                                                              UUID docId,
                                                                              String docGcsUrl,
                                                                              UUID userId)
      • alignDocument

        public io.swagger.oas.inflector.models.ResponseContext alignDocument​(io.swagger.oas.inflector.models.RequestContext request,
                                                                             UUID docId,
                                                                             com.fasterxml.jackson.databind.JsonNode bodyNode)
      • processDocument

        public io.swagger.oas.inflector.models.ResponseContext processDocument​(io.swagger.oas.inflector.models.RequestContext request,
                                                                               UUID docId,
                                                                               com.fasterxml.jackson.databind.JsonNode bodyNode)