IAS Server API

This section describes the IAS Server API.

IAS Server core operations
This topic describes the IAS Server API core methods.
Connecting to the IAS Server
Call the IasCrawlerLocator.create() method to connect to the IAS Server.
Creating crawls
Use the IasCrawler.createCrawl() method to create a new crawl of any type (for example, file system, delimited file, or custom data source).
Listing crawls
Call the IasCrawler.listCrawls() method to list the existing crawls.
Starting a crawl
Call the IasCrawler.startCrawl() method to start a crawl.
Stopping a crawl
Call the IasCrawler.stopCrawl() method to stop a crawl.
Deleting crawls
Call the IasCrawler.deleteCrawl() method to delete an existing crawl.
Listing modules available to a crawl
Call the IasCrawler.listModules() method to return a list of modules you can include in a crawl. Modules include the default crawl types provided by IAS and any data source extensions and manipulator extensions you may have created using the IAS Extension API.
Retrieving crawl configurations
Call the IasCrawler.getCrawlConfig() method to retrieve the configuration settings of a crawl.
Updating crawl configurations
Call the IasCrawler.updateCrawl() method to change the configuration settings for an existing crawl.
Getting crawl metrics
Call the IasCrawler.getMetrics() method to return the metrics of a crawl. Metrics can be returned for a running crawl or (if the crawl is not running) for the last complete crawl.
Getting the status of a crawl
Call the IasCrawler.getStatus() method to retrieve the status of a crawl.
Retrieving IAS Server information
Call the Ias.getServerInfo() method to get the server properties of the IAS Server.