[/map {"- map/map "}) [/map/topicref {"- map/topicref "}) [/map/topicref/topicmeta {"- map/topicmeta "}) [/map/topicref/topicmeta/navtitle {"- topic/navtitle "}) IAS Server API (navtitle][/map/topicref/topicmeta/linktext {"- map/linktext "}) IAS Server API (linktext][/map/topicref/topicmeta/shortdesc {"- map/shortdesc "}) This section describes the IAS Server API. (shortdesc] (topicmeta][/map/topicref/topicref {"- map/topicref "}) [/map/topicref/topicref/topicmeta {"- map/topicmeta "}) [/map/topicref/topicref/topicmeta/navtitle {"- topic/navtitle "}) IAS Server core operations (navtitle][/map/topicref/topicref/topicmeta/linktext {"- map/linktext "}) IAS Server core operations (linktext][/map/topicref/topicref/topicmeta/shortdesc {"- map/shortdesc "}) This topic describes the IAS Server API core methods. (shortdesc] (topicmeta] (topicref][/map/topicref/topicref {"- map/topicref "}) [/map/topicref/topicref/topicmeta {"- map/topicmeta "}) [/map/topicref/topicref/topicmeta/navtitle {"- topic/navtitle "}) Connecting to the IAS Server (navtitle][/map/topicref/topicref/topicmeta/linktext {"- map/linktext "}) Connecting to the IAS Server (linktext][/map/topicref/topicref/topicmeta/shortdesc {"- map/shortdesc "}) Call the IasCrawlerLocator.create() method to connect to the IAS Server. (shortdesc] (topicmeta] (topicref][/map/topicref/topicref {"- map/topicref "}) [/map/topicref/topicref/topicmeta {"- map/topicmeta "}) [/map/topicref/topicref/topicmeta/navtitle {"- topic/navtitle "}) Creating crawls (navtitle][/map/topicref/topicref/topicmeta/linktext {"- map/linktext "}) Creating crawls (linktext][/map/topicref/topicref/topicmeta/shortdesc {"- map/shortdesc "}) Use the IasCrawler.createCrawl() method to create a new crawl of any type (for example, file system, delimited file, or custom data source). (shortdesc] (topicmeta][/map/topicref/topicref/topicref {"- map/topicref "}) [/map/topicref/topicref/topicref/topicmeta {"- map/topicmeta "}) [/map/topicref/topicref/topicref/topicmeta/navtitle {"- topic/navtitle "}) About the source properties for crawls (navtitle][/map/topicref/topicref/topicref/topicmeta/linktext {"- map/linktext "}) About the source properties for crawls (linktext][/map/topicref/topicref/topicref/topicmeta/shortdesc {"- map/shortdesc "}) The SourceConfig class allows a client to specify information about the data source that is being crawled.The SourceConfig class uses two methods to set data source properties: setModuleId() and setModuleProperties(). (shortdesc] (topicmeta][/map/topicref/topicref/topicref/topicref {"- map/topicref "}) [/map/topicref/topicref/topicref/topicref/topicmeta {"- map/topicmeta "}) [/map/topicref/topicref/topicref/topicref/topicmeta/navtitle {"- topic/navtitle "}) File system source properties and example (navtitle][/map/topicref/topicref/topicref/topicref/topicmeta/linktext {"- map/linktext "}) File system source properties and example (linktext][/map/topicref/topicref/topicref/topicref/topicmeta/shortdesc {"- map/shortdesc "}) The SourceConfig object for a file system crawl requires a ModuleId that specifies "File System", a ModuleProperty to specify the seeds, and additional ModuleProperty objects for any optional source properties. (shortdesc] (topicmeta] (topicref][/map/topicref/topicref/topicref/topicref {"- map/topicref "}) [/map/topicref/topicref/topicref/topicref/topicmeta {"- map/topicmeta "}) [/map/topicref/topicref/topicref/topicref/topicmeta/navtitle {"- topic/navtitle "}) Source properties for a custom data source (navtitle][/map/topicref/topicref/topicref/topicref/topicmeta/linktext {"- map/linktext "}) Source properties for a custom data source (linktext][/map/topicref/topicref/topicref/topicref/topicmeta/shortdesc {"- map/shortdesc "}) The SourceConfig for a custom data source crawl contains a mandatory ModuleId and ModuleProperty objects that define the custom data source to crawl and any other optional properties that are necessary for a custom data source. (shortdesc] (topicmeta] (topicref][/map/topicref/topicref/topicref/topicref {"- map/topicref "}) [/map/topicref/topicref/topicref/topicref/topicmeta {"- map/topicmeta "}) [/map/topicref/topicref/topicref/topicref/topicmeta/navtitle {"- topic/navtitle "}) Source properties for a manipulator (navtitle][/map/topicref/topicref/topicref/topicref/topicmeta/linktext {"- map/linktext "}) Source properties for a manipulator (linktext][/map/topicref/topicref/topicref/topicref/topicmeta/shortdesc {"- map/shortdesc "}) The ManipulatorConfig for a manipulator contains a mandatory ModuleId and ModuleProperty objects that define the manipulator to run and any other optional properties that are necessary for a manipulator. (shortdesc] (topicmeta] (topicref][/map/topicref/topicref/topicref/topicref {"- map/topicref "}) [/map/topicref/topicref/topicref/topicref/topicmeta {"- map/topicmeta "}) [/map/topicref/topicref/topicref/topicref/topicmeta/navtitle {"- topic/navtitle "}) Setting text extraction options (navtitle][/map/topicref/topicref/topicref/topicref/topicmeta/linktext {"- map/linktext "}) Setting text extraction options (linktext][/map/topicref/topicref/topicref/topicref/topicmeta/shortdesc {"- map/shortdesc "}) The TextExtractionConfig class specifies document conversion parameters to override default values. (shortdesc] (topicmeta] (topicref] (topicref][/map/topicref/topicref/topicref {"- map/topicref "}) [/map/topicref/topicref/topicref/topicmeta {"- map/topicmeta "}) [/map/topicref/topicref/topicref/topicmeta/navtitle {"- topic/navtitle "}) Filtering files and folders (navtitle][/map/topicref/topicref/topicref/topicmeta/linktext {"- map/linktext "}) Filtering files and folders (linktext][/map/topicref/topicref/topicref/topicmeta/shortdesc {"- map/shortdesc "}) The API provides classes to specify inclusion and exclusion filters for files and folders. (shortdesc] (topicmeta][/map/topicref/topicref/topicref/topicref {"- map/topicref "}) [/map/topicref/topicref/topicref/topicref/topicmeta {"- map/topicmeta "}) [/map/topicref/topicref/topicref/topicref/topicmeta/navtitle {"- topic/navtitle "}) Creating wildcard filters (navtitle][/map/topicref/topicref/topicref/topicref/topicmeta/linktext {"- map/linktext "}) Creating wildcard filters (linktext][/map/topicref/topicref/topicref/topicref/topicmeta/shortdesc {"- map/shortdesc "}) The WildcardFilter class specifies a wildcard as an inclusion or exclusion filter. (shortdesc] (topicmeta] (topicref][/map/topicref/topicref/topicref/topicref {"- map/topicref "}) [/map/topicref/topicref/topicref/topicref/topicmeta {"- map/topicmeta "}) [/map/topicref/topicref/topicref/topicref/topicmeta/navtitle {"- topic/navtitle "}) Creating regular expression filters (navtitle][/map/topicref/topicref/topicref/topicref/topicmeta/linktext {"- map/linktext "}) Creating regular expression filters (linktext][/map/topicref/topicref/topicref/topicref/topicmeta/shortdesc {"- map/shortdesc "}) The RegexFilter class specifies a regular expression as an inclusion or exclusion filter. (shortdesc] (topicmeta] (topicref][/map/topicref/topicref/topicref/topicref {"- map/topicref "}) [/map/topicref/topicref/topicref/topicref/topicmeta {"- map/topicmeta "}) [/map/topicref/topicref/topicref/topicref/topicmeta/navtitle {"- topic/navtitle "}) Creating date filters (navtitle][/map/topicref/topicref/topicref/topicref/topicmeta/linktext {"- map/linktext "}) Creating date filters (linktext][/map/topicref/topicref/topicref/topicref/topicmeta/shortdesc {"- map/shortdesc "}) The DateFilter class specifies a date against which files and folders can be filtered. (shortdesc] (topicmeta] (topicref][/map/topicref/topicref/topicref/topicref {"- map/topicref "}) [/map/topicref/topicref/topicref/topicref/topicmeta {"- map/topicmeta "}) [/map/topicref/topicref/topicref/topicref/topicmeta/navtitle {"- topic/navtitle "}) Creating long filters (navtitle][/map/topicref/topicref/topicref/topicref/topicmeta/linktext {"- map/linktext "}) Creating long filters (linktext][/map/topicref/topicref/topicref/topicref/topicmeta/shortdesc {"- map/shortdesc "}) The LongFilter class specifies a long value against which files can be filtered.LongFilter extends the ComparableValueFilter class. (shortdesc] (topicmeta] (topicref] (topicref][/map/topicref/topicref/topicref {"- map/topicref "}) [/map/topicref/topicref/topicref/topicmeta {"- map/topicmeta "}) [/map/topicref/topicref/topicref/topicmeta/navtitle {"- topic/navtitle "}) About the output properties for crawls (navtitle][/map/topicref/topicref/topicref/topicmeta/linktext {"- map/linktext "}) About the output properties for crawls (linktext][/map/topicref/topicref/topicref/topicmeta/shortdesc {"- map/shortdesc "}) The OutputConfig class specifies whether the output from a crawl is stored in a Record Store instance or an output file. (shortdesc] (topicmeta][/map/topicref/topicref/topicref/topicref {"- map/topicref "}) [/map/topicref/topicref/topicref/topicref/topicmeta {"- map/topicmeta "}) [/map/topicref/topicref/topicref/topicref/topicmeta/navtitle {"- topic/navtitle "}) Record Store output properties and example (navtitle][/map/topicref/topicref/topicref/topicref/topicmeta/linktext {"- map/linktext "}) Record Store output properties and example (linktext][/map/topicref/topicref/topicref/topicref/topicmeta/shortdesc {"- map/shortdesc "}) The OutputConfig class configures a crawl to write crawl output to a Record Store instance. (shortdesc] (topicmeta] (topicref][/map/topicref/topicref/topicref/topicref {"- map/topicref "}) [/map/topicref/topicref/topicref/topicref/topicmeta {"- map/topicmeta "}) [/map/topicref/topicref/topicref/topicref/topicmeta/navtitle {"- topic/navtitle "}) File system output properties and example (navtitle][/map/topicref/topicref/topicref/topicref/topicmeta/linktext {"- map/linktext "}) File system output properties and example (linktext][/map/topicref/topicref/topicref/topicref/topicmeta/shortdesc {"- map/shortdesc "}) The OutputConfig class configures a crawl to write output to a record output file. (shortdesc] (topicmeta] (topicref] (topicref] (topicref][/map/topicref/topicref {"- map/topicref "}) [/map/topicref/topicref/topicmeta {"- map/topicmeta "}) [/map/topicref/topicref/topicmeta/navtitle {"- topic/navtitle "}) Listing crawls (navtitle][/map/topicref/topicref/topicmeta/linktext {"- map/linktext "}) Listing crawls (linktext][/map/topicref/topicref/topicmeta/shortdesc {"- map/shortdesc "}) Call the IasCrawler.listCrawls() method to list the existing crawls. (shortdesc] (topicmeta] (topicref][/map/topicref/topicref {"- map/topicref "}) [/map/topicref/topicref/topicmeta {"- map/topicmeta "}) [/map/topicref/topicref/topicmeta/navtitle {"- topic/navtitle "}) Starting a crawl (navtitle][/map/topicref/topicref/topicmeta/linktext {"- map/linktext "}) Starting a crawl (linktext][/map/topicref/topicref/topicmeta/shortdesc {"- map/shortdesc "}) Call the IasCrawler.startCrawl() method to start a crawl. (shortdesc] (topicmeta] (topicref][/map/topicref/topicref {"- map/topicref "}) [/map/topicref/topicref/topicmeta {"- map/topicmeta "}) [/map/topicref/topicref/topicmeta/navtitle {"- topic/navtitle "}) Stopping a crawl (navtitle][/map/topicref/topicref/topicmeta/linktext {"- map/linktext "}) Stopping a crawl (linktext][/map/topicref/topicref/topicmeta/shortdesc {"- map/shortdesc "}) Call the IasCrawler.stopCrawl() method to stop a crawl. (shortdesc] (topicmeta] (topicref][/map/topicref/topicref {"- map/topicref "}) [/map/topicref/topicref/topicmeta {"- map/topicmeta "}) [/map/topicref/topicref/topicmeta/navtitle {"- topic/navtitle "}) Deleting crawls (navtitle][/map/topicref/topicref/topicmeta/linktext {"- map/linktext "}) Deleting crawls (linktext][/map/topicref/topicref/topicmeta/shortdesc {"- map/shortdesc "}) Call the IasCrawler.deleteCrawl() method to delete an existing crawl. (shortdesc] (topicmeta] (topicref][/map/topicref/topicref {"- map/topicref "}) [/map/topicref/topicref/topicmeta {"- map/topicmeta "}) [/map/topicref/topicref/topicmeta/navtitle {"- topic/navtitle "}) Listing modules available to a crawl (navtitle][/map/topicref/topicref/topicmeta/linktext {"- map/linktext "}) Listing modules available to a crawl (linktext][/map/topicref/topicref/topicmeta/shortdesc {"- map/shortdesc "}) 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. (shortdesc] (topicmeta] (topicref][/map/topicref/topicref {"- map/topicref "}) [/map/topicref/topicref/topicmeta {"- map/topicmeta "}) [/map/topicref/topicref/topicmeta/navtitle {"- topic/navtitle "}) Retrieving crawl configurations (navtitle][/map/topicref/topicref/topicmeta/linktext {"- map/linktext "}) Retrieving crawl configurations (linktext][/map/topicref/topicref/topicmeta/shortdesc {"- map/shortdesc "}) Call the IasCrawler.getCrawlConfig() method to retrieve the configuration settings of a crawl. (shortdesc] (topicmeta] (topicref][/map/topicref/topicref {"- map/topicref "}) [/map/topicref/topicref/topicmeta {"- map/topicmeta "}) [/map/topicref/topicref/topicmeta/navtitle {"- topic/navtitle "}) Updating crawl configurations (navtitle][/map/topicref/topicref/topicmeta/linktext {"- map/linktext "}) Updating crawl configurations (linktext][/map/topicref/topicref/topicmeta/shortdesc {"- map/shortdesc "}) Call the IasCrawler.updateCrawl() method to change the configuration settings for an existing crawl. (shortdesc] (topicmeta] (topicref][/map/topicref/topicref {"- map/topicref "}) [/map/topicref/topicref/topicmeta {"- map/topicmeta "}) [/map/topicref/topicref/topicmeta/navtitle {"- topic/navtitle "}) Getting crawl metrics (navtitle][/map/topicref/topicref/topicmeta/linktext {"- map/linktext "}) Getting crawl metrics (linktext][/map/topicref/topicref/topicmeta/shortdesc {"- map/shortdesc "}) 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. (shortdesc] (topicmeta] (topicref][/map/topicref/topicref {"- map/topicref "}) [/map/topicref/topicref/topicmeta {"- map/topicmeta "}) [/map/topicref/topicref/topicmeta/navtitle {"- topic/navtitle "}) Getting the status of a crawl (navtitle][/map/topicref/topicref/topicmeta/linktext {"- map/linktext "}) Getting the status of a crawl (linktext][/map/topicref/topicref/topicmeta/shortdesc {"- map/shortdesc "}) Call the IasCrawler.getStatus() method to retrieve the status of a crawl. (shortdesc] (topicmeta] (topicref][/map/topicref/topicref {"- map/topicref "}) [/map/topicref/topicref/topicmeta {"- map/topicmeta "}) [/map/topicref/topicref/topicmeta/navtitle {"- topic/navtitle "}) Retrieving IAS Server information (navtitle][/map/topicref/topicref/topicmeta/linktext {"- map/linktext "}) Retrieving IAS Server information (linktext][/map/topicref/topicref/topicmeta/shortdesc {"- map/shortdesc "}) Call the Ias.getServerInfo() method to get the server properties of the IAS Server. (shortdesc] (topicmeta] (topicref] (topicref] (map]