Uploaded image for project: 'Tika'
  1. Tika
  2. TIKA-3226

Add custom connector endpoint

    XMLWordPrintableJSON

    Details

    • Type: New Feature
    • Status: Resolved
    • Priority: Major
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: 2.0.0
    • Component/s: server
    • Labels:
      None

      Description

      Let's say you call the following api to parse a file and get its metadata and body content:

      /rmeta/text
      

      In order to do this, the caller needs to send the file to the tika server, then get the metadata and body sent to the caller. When you are working in microservices, this causes a lot of inner-service network communication.

      You can cut down on a majority of this overhead by using the local file system optimization. So that you send a file path instead of the entire file. But this obviously only works when you are on the same machine.

      Ideally - we would have a way to deploy "connector plugins" into tika, and be able to send files to be parsed with these plugins (asynchronously?).

      /connector/{fetcherId}/{emitterId}
      

      The Fetcher interface:

      init(Map initParams)

      • initializes the fetcher (for example, initialize an http connection pool, etc)

      void fetch(Map parseParams, Metadata metadata, OutputStream bodyOutputStream)

      • fetches the document indicated by parseParams and does whatever it is you want with it (for example, download a file from a web data source, then index the document into Solr). Sends the body to bodyOutputStream and metadata object will be populated with the metadata).

      The Emitter interface would be

      init(Map initParams)

      • initializes the emitter. (for example, initialize a buffer to store output documents to solr, connect to solr, etc)

      void emit(Map parseParams, Fetcher fetcher)

      • fetches and parses the "document" using the passed in fetcher, then emits it meaningfully.

      We could provide the most common fetchers and emitters such as:

      HttpFetcher
      S3Fetcher
      SolrEmitter
      ...

        Attachments

          Issue Links

            Activity

              People

              • Assignee:
                tallison Tim Allison
                Reporter:
                ndipiazza_gmail Nicholas DiPiazza
              • Votes:
                0 Vote for this issue
                Watchers:
                4 Start watching this issue

                Dates

                • Created:
                  Updated:
                  Resolved: