Jump to: navigation, search

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

(IndexOrderConfiguration)
 
(42 intermediate revisions by 12 users not shown)
Line 1: Line 1:
== Java implementations ==
+
{{note|This is deprecated for SMILA 1.0, the connectivity framework is still functional but will aimed to be replaced by scalable import based on SMILAs job management.}}
  
* Create a new eclipse Project using the Plug-in Project Wizard and select "Equinox" as OSGi framework
+
Explains how to implement an [[SMILA/Glossary#C|Crawler]] and [[SMILA/Howto integrate a component in SMILA|add its functionality]] to SMILA.  
* name the project using the prefix <tt>org.eclipse.eilf.connectivity.framework.crawler.</tt>
+
* edit the manifest and add the follwing to Imported Packages
+
** <tt>org.eclipse.eilf.connectivity.framework</tt>
+
** <tt>org.eclipse.eilf.connectivity.framework.utils</tt>
+
** <tt>org.eclipse.eilf.datamodel.record</tt>
+
** <tt>org.osoa.sca.annotations</tt>
+
** <tt>com.sun.xml.bind.v2;version="2.1.6"</tt>
+
** <tt>javax.xml.bind;version="2.1.0"</tt>
+
** <tt>javax.xml.bind.annotation;version="2.1.0"</tt>
+
** <tt>javax.xml.bind.annotation.adapters;version="2.1.0"</tt>
+
** <tt>javax.xml.stream;version="1.0.0"</tt>
+
** <tt>org.apache.commons.logging;version="1.1.1"</tt>
+
* <tt>edit the manifest and add the follwing to <tt>Require-Bundle</tt>: (it MUST be imported via reguire bundle instead of package import)</tt>
+
** <tt>org.eclipse.eilf.connectivity.framework.indexorder</tt>
+
* Add <tt>"code/gen"</tt> to source folders (build.properties : <tt>source.. = code/src/,code/gen/</tt>)
+
* Copy content of the folder "schema-compile-runtime\schema-pattern\" into your crawler bundle folder
+
* Implement XSD schema for crawler configuration using template "schemas\TemplateIndexOrder.xsd"
+
* Complile schema into JAXB classes by running schema.cmd ( "schema-compile-runtime" folder should be located on the projects level - it will be used for compilation )
+
* Implement extension point for "org.eclipse.eilf.connectivity.framework.indexorder.schema" with the bundle name used as ID and NAME
+
* Add schema location reference in plug-in implementation ( return "schemas/TemplateIndexOrder.xsd")
+
* Note: if you renamed schema file name, it should be fixed inside
+
** plug-in implementation
+
** TemplateIndexOrder.jxb (it also should be also renamed with the same name as schema)
+
** schema.cmd
+
* implement your crawler in a new Class extending <tt>org.eclipse.eilf.connectivity.framework.AbstractCrawler</tt>
+
  
=== SCA requirements ===
+
== Prepare bundle and manifest  ==
  
Most requirements for SCA are already handled by the base class <tt>org.eclipse.eilf.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:
+
*Create a new bundle that will contain your crawler. Follow the instructions on [[SMILA/Development Guidelines/Create a bundle (plug-in)|How to create a bundle]]. In this sample we use the prefix <tt>myplugin.crawler.mock</tt> for the name of project.  
 +
*For crawler JXB code generation we need to import SMILA.builder project into our workspace.
  
<source lang="java">
+
*Edit the manifest file and add at least the following packages to the ''Import-Package'' section.
@AllowsPassByReference
+
**<tt>org.eclipse.smila.connectivity;version="1.0.0"</tt>
public class FileSystemCrawler extends AbstractCrawler {
+
**<tt>org.eclipse.smila.connectivity.framework;version="1.0.0"</tt>
// implementation goes here ...
+
**<tt>org.eclipse.smila.connectivity.framework.performancecounters;version="1.0.0"</tt>
}
+
**<tt>org.eclipse.smila.connectivity.framework.schema;version="1.0.0"</tt>
 +
**<tt>org.eclipse.smila.connectivity.framework.schema.config;version="1.0.0"</tt>
 +
**<tt>org.eclipse.smila.connectivity.framework.schema.config.interfaces;version="1.0.0"</tt>
 +
**<tt>org.eclipse.smila.connectivity.framework.util;version="1.0.0"</tt>
 +
**<tt>org.eclipse.smila.datamodel;version="1.0.0"</tt>
 +
 
 +
*you will have to add additional packages to fill you crawler with business logic&nbsp;!
 +
 
 +
*Now your MANIFEST.MF file should be like
 +
<source lang="text">
 +
Manifest-Version: 1.0
 +
Bundle-ManifestVersion: 2
 +
Bundle-Name: Mock Crawler
 +
Bundle-SymbolicName: myplugin.crawler.mock
 +
Bundle-Version: 1.0.0
 +
Bundle-RequiredExecutionEnvironment: JavaSE-1.6
 +
Import-Package:
 +
org.eclipse.smila.connectivity;version="1.0.0",
 +
org.eclipse.smila.connectivity.framework;version="1.0.0",
 +
org.eclipse.smila.connectivity.framework.performancecounters;version="1.0.0",
 +
org.eclipse.smila.connectivity.framework.schema;version="1.0.0",
 +
org.eclipse.smila.connectivity.framework.schema.config;version="1.0.0",
 +
org.eclipse.smila.connectivity.framework.schema.config.interfaces;version="1.0.0",
 +
org.eclipse.smila.connectivity.framework.util;version="1.0.0",
 +
org.eclipse.smila.datamodel;version="1.0.0"
 
</source>
 
</source>
  
=== OSGi and Declarative Service requirements ===
+
== Prepare DataSourceConnect schema and classes  ==
  
* 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 with an SCA Domain)
+
*create an additional source folder <tt>code/gen</tt> to contain the generated schema sources
* create a top level folder <tt>OSGI-INF</tt>
+
**Right-click your bundle and click ''New &gt; Source Folder''.
* create a Component Description file in <tt>OSGI-INF</tt>. 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 name followed by DS (for DeclarativeService). Then you have to provide your implementation class and the service interface class, which is always <tt>org.eclipse.eilf.connectivity.framework.Crawler</tt>. Make sure to set attribute "immediate" of tag "component" to <tt>false</tt> and attribute "servicefactory" of tag "service " to <tt>true</tt>. This is required to let SCA dynamically create ServiceReferences. Finally you have to provide a value for the property <tt>org.eclipse.eilf.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:
+
**Enter "code/gen" as the folder name.  
 +
**edit build.properties and add folder <tt>code/gen</tt> to the source folders.
  
'''filesystemcrawler.xml'''
+
<source lang="text">
<source lang="xml">
+
source.. = code/src/,\
<?xml version="1.0" encoding="UTF-8"?>
+
          code/gen/
<component name="FileSystemCrawlerDS" immediate="false">
+
output.. = code/bin/
    <implementation class="org.eclipse.eilf.connectivity.framework.crawler.filesystem.FileSystemCrawler" />
+
</source>  
    <service servicefactory="true">
+
        <provide interface="org.eclipse.eilf.connectivity.framework.Crawler"/>
+
    </service>
+
    <property name="org.eclipse.eilf.connectivity.framework.crawler.type" value="filesystemcrawler"/>
+
</component>
+
</source>
+
  
* add a Service-Component entry to your manifest file, e.g.
+
<br>  
<pre>
+
Service-Component: OSGI-INF/filesystemcrawler.xml
+
</pre>
+
  
== IndexOrderConfiguration ==
+
*create schema definition
 +
**create a folder <tt>schema</tt> in your bundle
 +
**create file <tt>schemas\MockCrawlerSchema.xsd</tt> to contain the XSD schema for the crawler configuration based on the abstract XSD schema "RootDataSourceConnectionConfigSchema"
 +
**therin you have to provide definitions of "Process" and "Attribute" nodes for crawler specific information
 +
**the following code snippet can be used as a template
  
Index Order Configaration based on XSD schema redefinition of abstract "RootIndexOrderConfiguration" schema
 
 
<source lang="xml">
 
<source lang="xml">
 +
<?xml version="1.0" encoding="UTF-8"?>
 
<xs:schema elementFormDefault="qualified" attributeFormDefault="unqualified" xmlns:xs="http://www.w3.org/2001/XMLSchema">
 
<xs:schema elementFormDefault="qualified" attributeFormDefault="unqualified" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:redefine schemaLocation="RootIndexOrderConfiguration.xsd">
+
  <xs:redefine schemaLocation="../../org.eclipse.smila.connectivity.framework.schema/schemas/RootDataSourceConnectionConfigSchema.xsd">
<xs:complexType name="Process">
+
    <xs:complexType name="Process">
<xs:annotation>
+
      <xs:annotation>
<xs:documentation>Process Specification</xs:documentation>
+
        <xs:documentation>Process Specification</xs:documentation>
</xs:annotation>
+
      </xs:annotation>
<xs:complexContent>
+
      <xs:complexContent>
<xs:extension base="Process">
+
        <xs:extension base="Process">
<\!--define process here -->
+
 
</xs:extension>
+
      <\!--define crawler specific process here -->
</xs:complexContent>
+
 
</xs:complexType>
+
        </xs:extension>
<xs:complexType name="Attribute">
+
      </xs:complexContent>
<xs:complexContent>
+
    </xs:complexType>
<xs:extension base="Attribute">
+
    <xs:complexType name="Attribute">
<\!--define attribute here -->
+
      <xs:complexContent>
</xs:extension>
+
        <xs:extension base="Attribute">
</xs:complexContent>
+
 
</xs:complexType>
+
      <\!--define crawler specific attributes here -->
</xs:redefine>
+
 
 +
        </xs:extension>
 +
      </xs:complexContent>
 +
    </xs:complexType>
 +
  </xs:redefine>
 
</xs:schema>
 
</xs:schema>
</source>
+
</source>  
* Developer should define redefinition of "Process" and "Attribute" nodes for crawler specific information.
+
 
* Cofigure all dependencies in MANIFEST.MF (see main section on the top)
+
*create JAXB mapping
<pre>
+
**create file <tt>schemas\MockCrawlerSchema.jxb</tt> to contain the JAXB mappings used for generating configuration classes.
Require-Bundle: org.eclipse.eilf.connectivity.framework.indexorder
+
**Here is an example for the <tt>MockCrawler</tt> JXB file you can use as a template, just rename the "schemaLocation" and "package name":
Import-Package: 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",
+
javax.xml.stream;version="1.0.0",
+
org.apache.commons.io;version="1.4.0",
+
org.apache.commons.logging;version="1.1.1",
+
org.eclipse.eilf.connectivity.framework,
+
org.eclipse.eilf.connectivity.framework.utils,
+
org.eclipse.eilf.datamodel.record,
+
org.osoa.sca.annotations
+
</pre>
+
* Compile schema into JAXB classes (see main section on the top)
+
* Implement extension point "org.eclipse.eilf.connectivity.framework.indexorder.schema" with the same name and ID as bundle name
+
<source lang="java">
+
<plugin>
+
  <extension
+
        id="org.eclipse.eilf.connectivity.framework.crawler.filesystem"
+
        name="org.eclipse.eilf.connectivity.framework.crawler.filesystem"
+
        point="org.eclipse.eilf.connectivity.framework.indexorder.schema">
+
      <schema
+
            class="org.eclipse.eilf.connectivity.framework.crawler.filesystem.IndexOrderSchemaImpl">
+
      </schema>
+
  </extension>
+
</plugin>
+
</source>
+
 
<source lang="xml">
 
<source lang="xml">
package org.eclipse.eilf.connectivity.framework.crawler.filesystem;
+
<jxb:bindings version="1.0"
 +
  xmlns:jxb="http://java.sun.com/xml/ns/jaxb"
 +
  xmlns:xs="http://www.w3.org/2001/XMLSchema"
 +
 +
  <jxb:bindings schemaLocation="MockCrawlerSchema.xsd" node="/xs:schema">
 +
    <jxb:schemaBindings>
 +
      <jxb:package name="mypackage.crawler.mock.messages"/>
 +
    </jxb:schemaBindings>   
 +
    <jxb:globalBindings>
 +
      <jxb:javaType name="java.util.Date" xmlType="xs:dateTime" printMethod="org.eclipse.smila.connectivity.framework.schema.tools.SimpleDateFormatter.print" parseMethod="org.eclipse.smila.connectivity.framework.schema.tools.SimpleDateFormatter.parse"/>
 +
      <jxb:javaType name="org.eclipse.smila.connectivity.framework.schema.config.MimeTypeAttributeType" xmlType="MimeTypeAttributeType" parseMethod="org.eclipse.smila.connectivity.framework.schema.config.MimeTypeAttributeType.fromValue" printMethod="org.eclipse.smila.connectivity.framework.schema.config.MimeTypeAttributeType.toValue"/>
 +
      <jxb:serializable uid="1"/>
 +
    </jxb:globalBindings>
 +
  </jxb:bindings>
 +
</jxb:bindings>
 +
</source>
 +
 
 +
<br>
 +
 
 +
*Add a schema location reference in the plug-in implementation
 +
**Create a new class (<tt>DataSourceConnectionConfigPluginImpl</tt>) which implements the interface <tt>DataSourceConnectionConfigPlugin</tt>.
 +
**Use the method <tt>String getSchemaLocation()</tt> to return "schemas/MockCrawlerSchema.xsd".
 +
**Use the method <tt>String getMessagesPackage()</tt> to return package name"mypackage.crawler.mock.messages".
 +
 
 +
Here is an example implementation for the <tt>MockCrawler</tt> you can use as a template: <source lang="java">
 +
package mypackage.crawler.mock;
  
import org.eclipse.eilf.connectivity.framework.indexorder.IndexOrderSchema;
+
import org.eclipse.smila.connectivity.framework.schema.DataSourceConnectionConfigPlugin;
  
 
/**
 
/**
  * The Class IndexOrderSchemaImpl.
+
  * The Class DataSourceConnectionConfigPluginImpl.
 
  */
 
  */
public class IndexOrderSchemaImpl implements IndexOrderSchema {
+
public class DataSourceConnectionConfigPluginImpl implements DataSourceConnectionConfigPlugin {
  
 
   /**
 
   /**
 
   * {@inheritDoc}
 
   * {@inheritDoc}
 
   *  
 
   *  
   * @see org.eclipse.eilf.connectivity.framework.indexorder.IndexOrderSchema#getSchemaLocation()
+
   * @see org.eclipse.smila.connectivity.framework.schema.DataSourceConnectionConfigPlugin#getSchemaLocation()
 
   */
 
   */
 
   public String getSchemaLocation() {
 
   public String getSchemaLocation() {
     return "schemas/filesystemIndexOrder.xsd";
+
     return "schemas/MockCrawlerSchema.xsd";
 
   }
 
   }
 +
 +
  /**
 +
  * {@inheritDoc}
 +
  *
 +
  * @see org.eclipse.smila.connectivity.framework.schema.DataSourceConnectionConfigPlugin#getMessagesPackage()
 +
  */
 +
  public String getMessagesPackage() {
 +
    return "mypackage.crawler.mock.messages";
 +
  }
 +
 
}
 
}
</source>
+
</source>  
* Enjoy!
+
 
 +
*create new file <tt>plugin.xml</tt>
 +
**define the extension for <tt>org.eclipse.smila.connectivity.framework.schema.extension</tt>, using the bundle name as ID and NAME.
 +
**set the schema class to your implmenetation of interface <tt>DataSourceConnectionConfigPlugin</tt>
 +
**Here is an example for the <tt>MockCrawler</tt> <tt>plugin.xml</tt> file you can use as a template:
 +
 
 +
<source lang="java">
 +
<plugin>
 +
  <extension
 +
        id="myplugin.crawler.mock"
 +
        name="myplugin.crawler.mock"
 +
        point="org.eclipse.smila.connectivity.framework.schema.extension">
 +
      <schema
 +
            class="mypackage.crawler.mock.DataSourceConnectionConfigPluginImpl">
 +
      </schema>
 +
  </extension>
 +
</plugin>
 +
</source>
 +
 
 +
<br>
 +
 
 +
*Compile schema into JAXB classes by using <tt>ant</tt>
 +
**See [[SMILA/Development Guidelines/Setup for JAXB code generation]] for instruction on how to setup the JAXB generation tools. It is advised to let lib outside the workspace, for example in a lower level folder. (my -Dlib.dir=../../
 +
**create a new file <tt>build.xml</tt> to contain JXB build information. Use the following template as the content for file <tt>build.xml</tt> and rename the property value accordingly:
 +
 
 +
<source lang="xml">
 +
<project name="sub-build" default="compile-schema-and-decorate" basedir=".">
 +
 
 +
  <property name="schema.name"  value="MockCrawlerSchema" />
 +
 
 +
  <import file="../SMILA.builder/xjc/build.xml" />
 +
 
 +
</project>
 +
</source>
 +
**Launch <tt>ant -Dlib.dir=../lib</tt> from a cmd console to create the java files or to see any error messages.
 +
 
 +
<br> '''Note:''' If you rename the schema file name, make sure to update the following locations:
 +
*Plug-in implementation classes
 +
*<tt>MockCrawlerSchema.jxb</tt> (it also should be renamed with the same name as schema)
 +
*<tt>build.xml</tt>
 +
 
 +
== OSGi and Declarative Service requirements  ==
 +
 
 +
*It is not required to implement a BundleActivator.
 +
*Create the top level folder <tt>OSGI-INF</tt>.
 +
*Create a Component Description file in <tt>OSGI-INF</tt>. 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. Then you have to provide your implementation class and the service interface class, which is always <tt>org.eclipse.smila.connectivity.framework.Crawler</tt>. Here is an example for the <tt>MockCrawler</tt> component description file you can use as a template:
 +
 
 +
<source lang="xml">
 +
<component name="MockCrawler" immediate="false" factory="CrawlerFactory">
 +
    <implementation class="mypackage.crawer.mock.MockCrawler" />
 +
    <service>
 +
        <provide interface="org.eclipse.smila.connectivity.framework.Crawler"/>
 +
    </service>   
 +
</component>
 +
</source>
 +
 
 +
*Add a ''Service-Component'' entry to your manifest file, e.g.:
 +
<pre>Service-Component: OSGI-INF/mockcrawler.xml
 +
</pre>
 +
*Open <tt>build.properties</tt> and change the binary build: Add the folders <tt>OSGI-INF</tt> and <tt>schemas</tt> as well as the file <tt>plugin.xml</tt>.
 +
 
 +
<source lang="xml">
 +
bin.includes = META-INF/,\
 +
              .,\
 +
              plugin.xml,\
 +
              schemas/,\
 +
              OSGI-INF/
 +
</source>
 +
 
 +
<br>
 +
 
 +
== Implement your crwler  ==
 +
 
 +
*Implement your crawler in a new class extending <tt>org.eclipse.smila.connectivity.framework.AbstractCrawler</tt>.
 +
 
 +
*Integrate your new agent bundle into the build process: Refer to the page [[SMILA/Development Guidelines/How to integrate new bundle into build process|How to integrate new bundle into build process]] for further instructions.
 +
 
 +
* Follow the example of FileSystemCrawler
 +
 
 +
[optional]
 +
 
 +
*Create a JUnit test bundle for this crawler e.g. <tt>myplugin.crawler.mock.test</tt>.
 +
*Integrate your test bundle into the build process: Refer to the page [[SMILA/Development Guidelines/How to integrate test bundle into build process|How to integrate test bundle into build process]]) for further instructions.
 +
 
 +
== Activate your crawler  ==
 +
 
 +
=== Activation SMILA in eclipse  ===
 +
 
 +
*Open the ''Run'' dialog, switch to the configuration page of ''Bundles'', select your bundle and set the parameter ''Default Auto-Start'' to ''true''.
 +
*Launch <tt>SMILA.launch</tt>.
 +
 
 +
=== Activation SMILA application  ===
 +
 
 +
*Insert your bundle , e.g. <tt>myplugin.crawler.mock@4:start</tt>, to the <tt>config.ini</tt> file.
 +
*Launch SMILA by calling either <tt>SMILA.exe</tt> or <tt>eclipse.exe -console</tt>
 +
 
 +
== Run your crawler  ==
 +
 
 +
Information on how to start and run an Crawler can be found in the [[SMILA/Documentation/CrawlerController|CrawlerController]] documentation.
  
 
[[Category:SMILA]]
 
[[Category:SMILA]]

Latest revision as of 08:29, 24 January 2012

Note.png
This is deprecated for SMILA 1.0, the connectivity framework is still functional but will aimed to be replaced by scalable import based on SMILAs job management.


Explains how to implement an 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. In this sample we use the prefix myplugin.crawler.mock for the name of project.
  • For crawler JXB code generation we need to import SMILA.builder project into our workspace.
  • Edit the manifest file and add at least the following packages to the Import-Package section.
    • org.eclipse.smila.connectivity;version="1.0.0"
    • org.eclipse.smila.connectivity.framework;version="1.0.0"
    • org.eclipse.smila.connectivity.framework.performancecounters;version="1.0.0"
    • org.eclipse.smila.connectivity.framework.schema;version="1.0.0"
    • org.eclipse.smila.connectivity.framework.schema.config;version="1.0.0"
    • org.eclipse.smila.connectivity.framework.schema.config.interfaces;version="1.0.0"
    • org.eclipse.smila.connectivity.framework.util;version="1.0.0"
    • org.eclipse.smila.datamodel;version="1.0.0"
  • you will have to add additional packages to fill you crawler with business logic !
  • Now your MANIFEST.MF file should be like
Manifest-Version: 1.0
Bundle-ManifestVersion: 2
Bundle-Name: Mock Crawler
Bundle-SymbolicName: myplugin.crawler.mock
Bundle-Version: 1.0.0
Bundle-RequiredExecutionEnvironment: JavaSE-1.6
Import-Package: 
 org.eclipse.smila.connectivity;version="1.0.0",
 org.eclipse.smila.connectivity.framework;version="1.0.0",
 org.eclipse.smila.connectivity.framework.performancecounters;version="1.0.0",
 org.eclipse.smila.connectivity.framework.schema;version="1.0.0",
 org.eclipse.smila.connectivity.framework.schema.config;version="1.0.0",
 org.eclipse.smila.connectivity.framework.schema.config.interfaces;version="1.0.0",
 org.eclipse.smila.connectivity.framework.util;version="1.0.0",
 org.eclipse.smila.datamodel;version="1.0.0"

Prepare DataSourceConnect schema and classes

  • create an additional source folder code/gen to contain the generated schema sources
    • Right-click your bundle and click New > Source Folder.
    • Enter "code/gen" as the folder name.
    • edit build.properties and add folder code/gen to the source folders.
source.. = code/src/,\
           code/gen/
output.. = code/bin/


  • create schema definition
    • create a folder schema in your bundle
    • create file schemas\MockCrawlerSchema.xsd to contain the XSD schema for the crawler configuration based on the abstract XSD schema "RootDataSourceConnectionConfigSchema"
    • therin you have to provide definitions of "Process" and "Attribute" nodes for crawler specific information
    • the following code snippet can be used as a template
<?xml version="1.0" encoding="UTF-8"?>
<xs:schema elementFormDefault="qualified" attributeFormDefault="unqualified" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:redefine schemaLocation="../../org.eclipse.smila.connectivity.framework.schema/schemas/RootDataSourceConnectionConfigSchema.xsd">
    <xs:complexType name="Process">
      <xs:annotation>
        <xs:documentation>Process Specification</xs:documentation>
      </xs:annotation>
      <xs:complexContent>
        <xs:extension base="Process">
 
    	  <\!--define crawler specific process here -->
 
        </xs:extension>
      </xs:complexContent>
    </xs:complexType>
    <xs:complexType name="Attribute">
      <xs:complexContent>
        <xs:extension base="Attribute">
 
    	  <\!--define crawler specific attributes here -->
 
        </xs:extension>
      </xs:complexContent>
    </xs:complexType>
  </xs:redefine>
</xs:schema>
  • create JAXB mapping
    • create file schemas\MockCrawlerSchema.jxb to contain the JAXB mappings used for generating configuration classes.
    • Here is an example for the MockCrawler JXB file you can use as a template, just rename the "schemaLocation" and "package name":
<jxb:bindings version="1.0" 
  xmlns:jxb="http://java.sun.com/xml/ns/jaxb" 
  xmlns:xs="http://www.w3.org/2001/XMLSchema" 
>  
  <jxb:bindings schemaLocation="MockCrawlerSchema.xsd" node="/xs:schema">
    <jxb:schemaBindings>
      <jxb:package name="mypackage.crawler.mock.messages"/>
    </jxb:schemaBindings>    
    <jxb:globalBindings>
      <jxb:javaType name="java.util.Date" xmlType="xs:dateTime" printMethod="org.eclipse.smila.connectivity.framework.schema.tools.SimpleDateFormatter.print" parseMethod="org.eclipse.smila.connectivity.framework.schema.tools.SimpleDateFormatter.parse"/>
      <jxb:javaType name="org.eclipse.smila.connectivity.framework.schema.config.MimeTypeAttributeType" xmlType="MimeTypeAttributeType" parseMethod="org.eclipse.smila.connectivity.framework.schema.config.MimeTypeAttributeType.fromValue" printMethod="org.eclipse.smila.connectivity.framework.schema.config.MimeTypeAttributeType.toValue"/>
      <jxb:serializable uid="1"/>
    </jxb:globalBindings>
  </jxb:bindings>
</jxb:bindings>


  • Add a schema location reference in the plug-in implementation
    • Create a new class (DataSourceConnectionConfigPluginImpl) which implements the interface DataSourceConnectionConfigPlugin.
    • Use the method String getSchemaLocation() to return "schemas/MockCrawlerSchema.xsd".
    • Use the method String getMessagesPackage() to return package name"mypackage.crawler.mock.messages".
Here is an example implementation for the MockCrawler you can use as a template:
package mypackage.crawler.mock;
 
import org.eclipse.smila.connectivity.framework.schema.DataSourceConnectionConfigPlugin;
 
/**
 * The Class DataSourceConnectionConfigPluginImpl.
 */
public class DataSourceConnectionConfigPluginImpl implements DataSourceConnectionConfigPlugin {
 
  /**
   * {@inheritDoc}
   * 
   * @see org.eclipse.smila.connectivity.framework.schema.DataSourceConnectionConfigPlugin#getSchemaLocation()
   */
  public String getSchemaLocation() {
    return "schemas/MockCrawlerSchema.xsd";
  }
 
  /**
   * {@inheritDoc}
   * 
   * @see org.eclipse.smila.connectivity.framework.schema.DataSourceConnectionConfigPlugin#getMessagesPackage()
   */
  public String getMessagesPackage() {
    return "mypackage.crawler.mock.messages";
  }
 
}
  • create new file plugin.xml
    • define the extension for org.eclipse.smila.connectivity.framework.schema.extension, using the bundle name as ID and NAME.
    • set the schema class to your implmenetation of interface DataSourceConnectionConfigPlugin
    • Here is an example for the MockCrawler plugin.xml file you can use as a template:
<plugin>
   <extension
         id="myplugin.crawler.mock"
         name="myplugin.crawler.mock"
         point="org.eclipse.smila.connectivity.framework.schema.extension">
      <schema
            class="mypackage.crawler.mock.DataSourceConnectionConfigPluginImpl">
      </schema>
   </extension>
</plugin>


  • Compile schema into JAXB classes by using ant
    • See SMILA/Development Guidelines/Setup for JAXB code generation for instruction on how to setup the JAXB generation tools. It is advised to let lib outside the workspace, for example in a lower level folder. (my -Dlib.dir=../../
    • create a new file build.xml to contain JXB build information. Use the following template as the content for file build.xml and rename the property value accordingly:
<project name="sub-build" default="compile-schema-and-decorate" basedir=".">
 
  <property name="schema.name"  value="MockCrawlerSchema" />
 
  <import file="../SMILA.builder/xjc/build.xml" />
 
</project>
    • Launch ant -Dlib.dir=../lib from a cmd console to create the java files or to see any error messages.


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

  • Plug-in implementation classes
  • MockCrawlerSchema.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.
  • 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. 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 MockCrawler component description file you can use as a template:
<component name="MockCrawler" immediate="false" factory="CrawlerFactory">
    <implementation class="mypackage.crawer.mock.MockCrawler" />
    <service>
         <provide interface="org.eclipse.smila.connectivity.framework.Crawler"/>
    </service>    
</component>
  • Add a Service-Component entry to your manifest file, e.g.:
Service-Component: OSGI-INF/mockcrawler.xml
  • Open build.properties and change the binary build: Add the folders OSGI-INF and schemas as well as the file plugin.xml.
bin.includes = META-INF/,\
               .,\
               plugin.xml,\
               schemas/,\
               OSGI-INF/


Implement your crwler

  • Implement your crawler in a new class extending org.eclipse.smila.connectivity.framework.AbstractCrawler.
  • Follow the example of FileSystemCrawler

[optional]

Activate your crawler

Activation SMILA in eclipse

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

Activation SMILA application

  • Insert your bundle , e.g. myplugin.crawler.mock@4:start, to the config.ini file.
  • Launch SMILA by calling either SMILA.exe or eclipse.exe -console

Run your crawler

Information on how to start and run an Crawler can be found in the CrawlerController documentation.