Skip to content

Latest commit

 

History

History
68 lines (51 loc) · 2.48 KB

crawler-plugin-dev.md

File metadata and controls

68 lines (51 loc) · 2.48 KB
Raw
copyright lastupdated subcollection
years
2020, 2021
2021-03-12
discovery-data

{:shortdesc: .shortdesc} {:external: target="_blank" .external} {:tip: .tip} {:note: .note} {:pre: .pre} {:important: .important} {:deprecated: .deprecated} {:codeblock: .codeblock} {:screen: .screen} {:download: .download} {:hide-dashboard: .hide-dashboard} {:apikey: data-credential-placeholder='apikey'} {:url: data-credential-placeholder='url'} {:curl: .ph data-hd-programlang='curl'} {:javascript: .ph data-hd-programlang='javascript'} {:java: .ph data-hd-programlang='java'} {:python: .ph data-hd-programlang='python'} {:ruby: .ph data-hd-programlang='ruby'} {:swift: .ph data-hd-programlang='swift'} {:go: .ph data-hd-programlang='go'}

Developing and implementing a Cloud Pak for Data custom crawler plug-in

{: #crawler-plugin-dev}

The crawler plug-in includes a file called com.ibm.es.ama.plugin.CrawlerPlugin. This file is the Initialization interface that includes methods that you can use when you work with your crawler plug-in. {: shortdesc}

Cloud Pak for Data only {{site.data.keyword.icp4dfull_notm}} only

This information applies only to installed deployments. {:note}

Interfaces and JavaDoc

{: #plugin-interfaces-jdoc}

The interface library is available as lib/ama-zing-crawler-plugin-${build-version}.jar in the SDK directory. The JavaDoc for the .jar file is available as lib/ama-zing-crawler-plugin-${build-version}-javadoc.jar in the same directory.

Initialization interface

{: #plugin-init-interface}

Use the com.ibm.es.ama.plugin.CrawlerPlugin interface to initialize or terminate a crawler plug-in or to update the crawled documents. The interface has the following methods:

Method Description
init Initialize a crawler plug-in
term Terminate a crawler plug-in
updateDocument Update crawled documents
{: caption="Supported methods" caption-side="top"}

Dependancy management

{: #dep-mgmt}

The file build.gradle manages the Java dependancy.

Crawler plug-in example

{: #plugin-example}

The example crawler plug-in src/main/java/com/ibm/es/ama/plugin/sample/SampleCrawlerPlugin.java adds, updates, and deletes metadata. The plug-in example also updates and deletes the content of documents that the Local File System connector crawls.