Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

The Http Listener connector will create endpoint, which will be listening for requests to put them to Aspire pipeline. 

Easy Heading Free
navigationTitleOn this Page
wrapNavigationTexttrue
navigationExpandOptionexpand-all-by-default

Introduction


Use the Http Listener connector to receive RESTFul requests and to feed these requests to an Aspire pipeline. This feeder can turn Aspire into a "RESTful Web Service", accepting requests from outside clients, processing jobs, and then returning results.

The Http Listener connector will register a new endpoint URL, based on the Aspire server path. For example, if your seed description is "http seed" and endpoint name is "submitFiles" , then the new URL will be http://localhost:50505/aspire/_api/http_seed/submitFiles/. Look that the underscore replaced space in words "http seed".  In other words, it is separate and apart from the standard Aspire admin user interface (which is under "/aspire").

There are two modes of operation for the HTTP Feeder: 1) Input parameters specified on the URL, and 2) Input data POST'ed to the feeder. In the case of parameters on the URL, the input parameters are added to the AspireObject which is fed down the pipeline. In the case of POSTed data, this may either be parameters from a form that will be added to AspireObject which is fed down the pipeline or data streamed to the endpoint which is attached to the published Job as a stream.

The HTTP Feeder can also be used to upload files, using a Multipart form submission. See below for details.

Environment and Access Requirements

Repository Support

The SMB supports crawling the following the repositories


HTTP Listener connector
Factory Namecom.accenture.aspire:aspire-http-listener-connector
subTypedefault
InputsRESTful requests in standard URL query string format (name=value pairs).
OutputsAspireObjects containing HTTP Request data, including all name=value pairs from the query string.
RepositoryVersionConnector VersionWindowsAll5.0LinuxAll5.0
Info

This component has been officially tested on local Windows and Linux.

Account Privileges

For the SMB connector to be able to crawl the Aspire Worker nodes must be run with a domain account with full read permissions over the shared folder to be crawled.

If the feature to "not change the last access date" is used, the account also requires write permissions.

Environment Requirements

The SMB connector was created and tested using Microsoft SMB2 Protocol

 A Samba file server installed and setup. The Samba file server enables file sharing across different operating systems over a network.

Framework and Connector Features


Framework Features

NameSupported
Content CrawlingYes
Identity CrawlingNo
Snapshot-based IncrementalsYes
Non-snapshot-based IncrementalsNo
Document HierarchyYes

Connector Features

The SMB connector has the following features:

  • Document filtering using include and exclude regex patterns.
  • Static acls can be added the documents crawled.
  • Distributed File System support.
  • Security Information retrieval.
  • Read documents without changing the last accessed date

Content Crawled


The SMB connector is able to crawl the following objects:

NameType Relevant MetadataContent Fetch & ExtractionDescription
Foldercontainer
  • Last Modified Date
NAThe directories of the share folder. Each directory will be scanned to retrieve more directories or files
Filedocument
  • Last Modified Date
  • Data size
yesThe files contained by the directories in the crawled share folder.

Limitations


The SMB Connector has the following limitations:

  • The following features are not currently implemented, but are on the development plan:

    • SMBv3 support