Skip to main content
Jump to: navigation, search

Difference between revisions of "SMILA/Documentation/HowTo/How to implement a crawler"

m (SCA requirements)
Line 181: Line 181:
== SCA requirements ==
'''Note''': SCA is currently not supported by SMILA! This section can be skipped.
Most requirements for SCA are already handled by the base class <tt>org.eclipse.smila.connectivity.framework.AbstractCrawler</tt>. You should annotate your implementation with <tt>@AllowsPassByReference</tt>, to allow SCA to pass service parameters by reference when service interactions are within the same adress space. Here is an example for the <tt>FileSystemCrawler</tt>:
<source lang="java">
public class FileSystemCrawler extends AbstractCrawler {
// implementation goes here ...
For SCA, make sure to set the attribute ''immediate'' of the element <tt><component></tt> to ''"false"'' and the attribute ''servicefactory'' of the element <tt><service></tt> to ''"true"'' in your XML file. This is required to let SCA dynamically create ServiceReferences. Finally, you have to provide a value for the property <tt>org.eclipse.smila.connectivity.framework.crawler.type</tt>. This is used by SCA to find the correct OSGi Declarative Service during runtime. The value has to be unique (it is used in SCA contribution files) and should be named like the crawler. Here is an example for the <tt>FileSystemCrawler</tt>:
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<component name="FileSystemCrawlerDS" immediate="false">
    <implementation class="org.eclipse.smila.connectivity.framework.crawler.filesystem.FileSystemCrawler" />
    <service servicefactory="true">
        <provide interface="org.eclipse.smila.connectivity.framework.Crawler"/>
    <property name="org.eclipse.smila.connectivity.framework.crawler.type" value="filesystemcrawler"/>
== Develop your crawler ==
== Develop your crawler ==

Revision as of 08:36, 26 March 2009

This page explains how to implement a crawler and add its functionality to SMILA.

Prepare bundle and manifest

  • Create a new bundle that will contain your crawler. Follow the instructions on How to create a bundle and name the project org.eclipse.smila.connectivity.framework.crawler.
  • Edit the manifest file and add the following packages to the Import-Package section.
    • org.eclipse.smila.connectivity.framework;version="0.5.0"
    • org.eclipse.smila.connectivity.framework.indexorder;version="0.5.0"
    • org.eclipse.smila.connectivity.framework.indexorder.messages.interfaces;version="0.5.0"
    • org.eclipse.smila.connectivity.framework.indexorder.schematools;version="0.5.0"
    • org.eclipse.smila.connectivity.framework.utils;version="0.5.0"
    • org.eclipse.smila.datamodel.record;version="0.5.0"
    • (not required because SCA is not used now)
    • com.sun.xml.bind.v2;version="2.1.6"
    • javax.xml.bind;version="2.1.0"
    • javax.xml.bind.annotation;version="2.1.0"
    • javax.xml.bind.annotation.adapters;version="2.1.0"
    • org.apache.commons.logging;version="1.1.1"
  • The manifest should now look like this:
Manifest-Version: 1.0
Bundle-ManifestVersion: 2
Bundle-Name: Filesystem Crawler Plug-in (Incubation)
Bundle-SymbolicName: org.eclipse.smila.connectivity.framework.crawler.filesystem;singleton:=true
Bundle-Version: 0.5.0
Bundle-Vendor: empolis GmbH and brox IT Solutions GmbH
Import-Package: com.sun.xml.bind.v2;version="2.1.6",
Export-Package: org.eclipse.smila.connectivity.framework.crawler.filesystem;version="0.5.0",
Service-Component: OSGI-INF/filesystemcrawler.xml
Eclipse-LazyStart: false

Prepare Indexorder schema and classes

  • Add the code/gen folder to the source folders ( : source.. = code/src/,code/gen/):
    • Right-click your bundle and click New > Source Folder.
    • Enter "code/gen" as the folder name.
  • Copy the content of the folder template-crawler\ into your crawler bundle folder.
  • Compile schema into JAXB classes by running ant.
    • Launch ant from a cmd console to see the result or error messages.
  • Implement XSD schema for the crawler configuration using the template schemas\TemplateIndexOrder.xsd.
    • Index Order configuration based on XSD schema redefinition of abstract "RootIndexOrderConfiguration" schema
    • Developer should define redefinition of "Process" and "Attribute" nodes for crawler specific information.
<xs:schema elementFormDefault="qualified" attributeFormDefault="unqualified" xmlns:xs="">
  <xs:redefine schemaLocation="../../org.eclipse.smila.connectivity.framework.indexorder/schemas/RootIndexOrderConfiguration.xsd">
    <xs:complexType name="Process">
        <xs:documentation>Process Specification</xs:documentation>
        <xs:extension base="Process">
	  <\!--define process here -->
    <xs:complexType name="Attribute">
        <xs:extension base="Attribute">
	  <\!--define attribute here -->
  • Rename and edit JAXB mapping file used for generating configuration classes (TemplateIndexOrder.jxb).
    • Update package name
  <jxb:package name="org.eclipse.smila.connectivity.framework.crawler.MYCRAWLER.messages"/>
    • Update schema location
<jxb:bindings schemaLocation="TemplateIndexOrder.xsd"
  • Add a schema location reference in the plug-in implementation (return "schemas/TemplateIndexOrder.xsd").
    • Create a new class (IndexOrderSchemaImpl) which implements the interface IndexOrderSchema.
    • Use the method String getSchemaLocation() to return "schemas/TemplateIndexOrder.xsd".
    • Use the method String getMessagesPackage() to return package name"org.eclipse.smila.connectivity.framework.crawler.MYCRAWLER.messages".
package org.eclipse.smila.connectivity.framework.crawler.MYCRAWLER;
import org.eclipse.smila.connectivity.framework.indexorder.IndexOrderSchema;
 * The Class IndexOrderSchemaImpl.
public class IndexOrderSchemaImpl implements IndexOrderSchema {
   * {@inheritDoc}
   * @see org.eclipse.smila.connectivity.framework.indexorder.IndexOrderSchema#getSchemaLocation()
  public String getSchemaLocation() {
    return "schemas/MYCRAWLER_IndexOrder.xsd";
   * {@inheritDoc}
   * @see org.eclipse.smila.connectivity.framework.indexorder.IndexOrderSchema#getMessagesPackage()
  public String getMessagesPackage() {
    return "org.eclipse.smila.connectivity.framework.crawler.MYCRAWLER.messages";
  • Implement the extension for org.eclipse.smila.connectivity.framework.indexorder.schema with the bundle name used as ID and NAME.
  • Check the schema classes in the file plugin.xml and change if necessary.

Note: If you rename the schema file name, make sure to update the following locations:

  • Plug-in implementation classes
  • TemplateIndexOrder.jxb (it also should be renamed with the same name as schema)
  • build.xml

OSGi and Declarative Service requirements

  • It is not required to implement a BundleActivator. (This may change if SCA Nodes are used; then it may be required to register the crawler.)
  • Create the top level folder OSGI-INF.
  • Create a Component Description file in OSGI-INF. You can name the file as you like, but it is good practice to name it like the crawler. Therein you have to provide a unique component name, it should be the same as the crawler's class name followed by DS (for Declarative Service). Then you have to provide your implementation class and the service interface class, which is always org.eclipse.smila.connectivity.framework.Crawler. Here is an example for the FileSystemCrawler:
<?xml version="1.0" encoding="UTF-8"?>
<component name="FileSystemCrawlerDS" immediate="true">
    <implementation class="org.eclipse.smila.connectivity.framework.crawler.filesystem.FileSystemCrawler" />
         <provide interface="org.eclipse.smila.connectivity.framework.Crawler"/>
    <property name="org.eclipse.smila.connectivity.framework.crawler.type" value="filesystemcrawler"/>
  • Add a Service-Component entry to your manifest file, e.g.:
Service-Component: OSGI-INF/filesystemcrawler.xml
  • Open and change the binary build: Add the folders OSGI-INF and schemas as well as the file plugin.xml.
source.. = code/src/,\
output.. = code/bin/
bin.includes = META-INF/,\

Develop your crawler

  • Implement your crawler in a new class extending org.eclipse.smila.connectivity.framework.AbstractCrawler.
  • Create a JUnit test bundle for this crawler e.g. org.eclipse.smila.connectivity.framework.crawler.filesystem.test.
  • Integrate your new crawler bundle into the build process: Refer to the page How to integrate new bundle into build process for further instructions.
  • Integrate your test bundle into the build process: Refer to the page How to integrate test bundle into build process) for further instructions.

Run your crawler

Running SMILA in eclipse

  • Open the Run dialog, switch to the configuration page of your bundle, set the parameter Default Start level to 4, and the parameter Default Auto-Start to true.
  • Launch SMILA.launch.

Running SMILA application

  • Insert org.eclipse.smila.connectivity.framework.crawler.filesystem@4:start, \ to the config.ini file.
  • Launch SMILA by calling either SMILA.exe or eclipse.exe -console

Back to the top