Jump to: navigation, search

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

Line 2: Line 2:
  
 
* Create a new eclipse Project using the Plug-in Project Wizard and select "Equinox" as OSGi framework
 
* Create a new eclipse Project using the Plug-in Project Wizard and select "Equinox" as OSGi framework
* name the project using the prefix <tt>org.eclipse.eilf.connectivity.framework.crawler.</tt>
+
* name the project using the prefix <tt>org.eclipse.smila.connectivity.framework.crawler.</tt>
 
* edit the manifest and add the follwing to Imported Packages
 
* edit the manifest and add the follwing to Imported Packages
** <tt>org.eclipse.eilf.connectivity.framework</tt>
+
** <tt>org.eclipse.smila.connectivity.framework</tt>
** <tt>org.eclipse.eilf.connectivity.framework.utils</tt>
+
** <tt>org.eclipse.smila.connectivity.framework.utils</tt>
** <tt>org.eclipse.eilf.datamodel.record</tt>
+
** <tt>org.eclipse.smila.datamodel.record</tt>
 
** <tt>org.osoa.sca.annotations</tt>
 
** <tt>org.osoa.sca.annotations</tt>
 
** <tt>com.sun.xml.bind.v2;version="2.1.6"</tt>
 
** <tt>com.sun.xml.bind.v2;version="2.1.6"</tt>
Line 16: Line 16:
  
 
* edit the manifest and add the follwing to <tt>Require-Bundle</tt>: (it MUST be imported via reguire bundle instead of package import)
 
* edit the manifest and add the follwing to <tt>Require-Bundle</tt>: (it MUST be imported via reguire bundle instead of package import)
** <tt>org.eclipse.eilf.connectivity.framework.indexorder</tt>
+
** <tt>org.eclipse.smila.connectivity.framework.indexorder</tt>
 
* After edit the manifest, this looks like:
 
* After edit the manifest, this looks like:
 
<pre>
 
<pre>
Require-Bundle: org.eclipse.eilf.connectivity.framework.indexorder
+
Require-Bundle: org.eclipse.smila.connectivity.framework.indexorder
 
Import-Package: com.sun.xml.bind.v2;version="2.1.6",
 
Import-Package: com.sun.xml.bind.v2;version="2.1.6",
 
  javax.xml.bind;version="2.1.0",
 
  javax.xml.bind;version="2.1.0",
Line 27: Line 27:
 
  org.apache.commons.io;version="1.4.0",
 
  org.apache.commons.io;version="1.4.0",
 
  org.apache.commons.logging;version="1.1.1",
 
  org.apache.commons.logging;version="1.1.1",
  org.eclipse.eilf.connectivity.framework,
+
  org.eclipse.smila.connectivity.framework,
  org.eclipse.eilf.connectivity.framework.utils,
+
  org.eclipse.smila.connectivity.framework.utils,
  org.eclipse.eilf.datamodel.record,
+
  org.eclipse.smila.datamodel.record,
 
  org.osoa.sca.annotations
 
  org.osoa.sca.annotations
 
</pre>
 
</pre>
Line 73: Line 73:
 
** use method String getSchemaLocation() to return "schemas/TemplateIndexOrder.xsd"
 
** use method String getSchemaLocation() to return "schemas/TemplateIndexOrder.xsd"
 
<source lang="xml">
 
<source lang="xml">
package org.eclipse.eilf.connectivity.framework.crawler.filesystem;
+
package org.eclipse.smila.connectivity.framework.crawler.filesystem;
  
import org.eclipse.eilf.connectivity.framework.indexorder.IndexOrderSchema;
+
import org.eclipse.smila.connectivity.framework.indexorder.IndexOrderSchema;
  
 
/**
 
/**
Line 85: Line 85:
 
   * {@inheritDoc}
 
   * {@inheritDoc}
 
   *  
 
   *  
   * @see org.eclipse.eilf.connectivity.framework.indexorder.IndexOrderSchema#getSchemaLocation()
+
   * @see org.eclipse.smila.connectivity.framework.indexorder.IndexOrderSchema#getSchemaLocation()
 
   */
 
   */
 
   public String getSchemaLocation() {
 
   public String getSchemaLocation() {
Line 94: Line 94:
  
  
* Implement extension for "org.eclipse.eilf.connectivity.framework.indexorder.schema" with the bundle name used as ID and NAME
+
* Implement extension for "org.eclipse.smila.connectivity.framework.indexorder.schema" with the bundle name used as ID and NAME
 
** in plugin.xml check schema class and change if it is necessary
 
** in plugin.xml check schema class and change if it is necessary
  
Line 100: Line 100:
 
<plugin>
 
<plugin>
 
   <extension
 
   <extension
         id="org.eclipse.eilf.connectivity.framework.crawler.filesystem"
+
         id="org.eclipse.smila.connectivity.framework.crawler.filesystem"
         name="org.eclipse.eilf.connectivity.framework.crawler.filesystem"
+
         name="org.eclipse.smila.connectivity.framework.crawler.filesystem"
         point="org.eclipse.eilf.connectivity.framework.indexorder.schema">
+
         point="org.eclipse.smila.connectivity.framework.indexorder.schema">
 
       <schema
 
       <schema
             class="org.eclipse.eilf.connectivity.framework.crawler.filesystem.IndexOrderSchemaImpl">
+
             class="org.eclipse.smila.connectivity.framework.crawler.filesystem.IndexOrderSchemaImpl">
 
       </schema>
 
       </schema>
 
   </extension>
 
   </extension>
Line 119: Line 119:
 
* 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)
 
* 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 a top level folder <tt>OSGI-INF</tt>
 
* create a 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 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>.  
+
* 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.smila.connectivity.framework.Crawler</tt>.  
  
 
'''filesystemcrawler.xml'''
 
'''filesystemcrawler.xml'''
Line 125: Line 125:
 
<?xml version="1.0" encoding="UTF-8"?>
 
<?xml version="1.0" encoding="UTF-8"?>
 
<component name="FileSystemCrawlerDS" immediate="true">
 
<component name="FileSystemCrawlerDS" immediate="true">
     <implementation class="org.eclipse.eilf.connectivity.framework.crawler.filesystem.FileSystemCrawler" />
+
     <implementation class="org.eclipse.smila.connectivity.framework.crawler.filesystem.FileSystemCrawler" />
 
     <service>
 
     <service>
         <provide interface="org.eclipse.eilf.connectivity.framework.Crawler"/>
+
         <provide interface="org.eclipse.smila.connectivity.framework.Crawler"/>
 
     </service>
 
     </service>
     <property name="org.eclipse.eilf.connectivity.framework.crawler.type" value="filesystemcrawler"/>
+
     <property name="org.eclipse.smila.connectivity.framework.crawler.type" value="filesystemcrawler"/>
 
</component>
 
</component>
 
</source>
 
</source>
Line 152: Line 152:
 
=== SCA requirements ===
 
=== SCA requirements ===
  
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:
+
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:
  
 
<source lang="java">
 
<source lang="java">
Line 161: Line 161:
 
</source>
 
</source>
  
For SCA, make sure to set attribute "immediate" of tag "component" to <tt>false</tt> and attribute "servicefactory" of tag "service " to <tt>true</tt> 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.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:
+
For SCA, make sure to set attribute "immediate" of tag "component" to <tt>false</tt> and attribute "servicefactory" of tag "service " to <tt>true</tt> 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:
  
 
'''filesystemcrawler.xml'''
 
'''filesystemcrawler.xml'''
Line 167: Line 167:
 
<?xml version="1.0" encoding="UTF-8"?>
 
<?xml version="1.0" encoding="UTF-8"?>
 
<component name="FileSystemCrawlerDS" immediate="false">
 
<component name="FileSystemCrawlerDS" immediate="false">
     <implementation class="org.eclipse.eilf.connectivity.framework.crawler.filesystem.FileSystemCrawler" />
+
     <implementation class="org.eclipse.smila.connectivity.framework.crawler.filesystem.FileSystemCrawler" />
 
     <service servicefactory="true">
 
     <service servicefactory="true">
         <provide interface="org.eclipse.eilf.connectivity.framework.Crawler"/>
+
         <provide interface="org.eclipse.smila.connectivity.framework.Crawler"/>
 
     </service>
 
     </service>
     <property name="org.eclipse.eilf.connectivity.framework.crawler.type" value="filesystemcrawler"/>
+
     <property name="org.eclipse.smila.connectivity.framework.crawler.type" value="filesystemcrawler"/>
 
</component>
 
</component>
 
</source>
 
</source>
Line 184: Line 184:
 
** [[SMILA/Development_Guidelines/How to integrate test bundle into build process|How to integrate test bundle into build process]])
 
** [[SMILA/Development_Guidelines/How to integrate test bundle into build process|How to integrate test bundle into build process]])
 
* Start your crawler with launch
 
* Start your crawler with launch
** by EILF.exe
+
** by SMILA.exe
** insert "org.eclipse.eilf.connectivity.framework.crawler.filesystem@4:start, \" to config.ini
+
** insert "org.eclipse.smila.connectivity.framework.crawler.filesystem@4:start, \" to config.ini
** by EILF.launch
+
** by SMILA.launch
 
** Open run dialog, and set your bundle to start level 4 and auto start true.
 
** Open run dialog, and set your bundle to start level 4 and auto start true.
  

Revision as of 05:41, 26 September 2008

Java implementations

  • Create a new eclipse Project using the Plug-in Project Wizard and select "Equinox" as OSGi framework
  • name the project using the prefix org.eclipse.smila.connectivity.framework.crawler.
  • edit the manifest and add the follwing to Imported Packages
    • org.eclipse.smila.connectivity.framework
    • org.eclipse.smila.connectivity.framework.utils
    • org.eclipse.smila.datamodel.record
    • org.osoa.sca.annotations
    • 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.logging;version="1.1.1"
  • edit the manifest and add the follwing to Require-Bundle: (it MUST be imported via reguire bundle instead of package import)
    • org.eclipse.smila.connectivity.framework.indexorder
  • After edit the manifest, this looks like:
Require-Bundle: org.eclipse.smila.connectivity.framework.indexorder
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.smila.connectivity.framework,
 org.eclipse.smila.connectivity.framework.utils,
 org.eclipse.smila.datamodel.record,
 org.osoa.sca.annotations
  • Compile schema into JAXB classes (see main section on the top)
  • Add "code/gen" to source folders (build.properties : source.. = code/src/,code/gen/)
    • click right on your bundle
    • go to the menu item New
    • click on Source folder
    • folder name: code/gen
  • Copy content of the folder "schema-compile-runtime\schema-pattern\" into your crawler bundle folder
  • 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 )
    • start schema.cmd from cmd console, to see the result or error messages
  • Implement XSD schema for crawler configuration using template "schemas\TemplateIndexOrder.xsd"
    • Index Order Configaration 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="http://www.w3.org/2001/XMLSchema">
	<xs:redefine schemaLocation="RootIndexOrderConfiguration.xsd">
		<xs:complexType name="Process">
			<xs:annotation>
				<xs:documentation>Process Specification</xs:documentation>
			</xs:annotation>
			<xs:complexContent>
				<xs:extension base="Process">
					<\!--define process here -->
				</xs:extension>
			</xs:complexContent>
		</xs:complexType>
		<xs:complexType name="Attribute">
			<xs:complexContent>
				<xs:extension base="Attribute">
					<\!--define attribute here -->
				</xs:extension>
			</xs:complexContent>
		</xs:complexType>
	</xs:redefine>
</xs:schema>
  • Add schema location reference in plug-in implementation (return "schemas/TemplateIndexOrder.xsd")
    • create a new class (IndexOrderSchemaImpl) which implements interface IndexOrderSchema
    • use method String getSchemaLocation() to return "schemas/TemplateIndexOrder.xsd"
package org.eclipse.smila.connectivity.framework.crawler.filesystem;
 
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/filesystemIndexOrder.xsd";
  }
}


  • Implement extension for "org.eclipse.smila.connectivity.framework.indexorder.schema" with the bundle name used as ID and NAME
    • in plugin.xml check schema class and change if it is necessary
<plugin>
   <extension
         id="org.eclipse.smila.connectivity.framework.crawler.filesystem"
         name="org.eclipse.smila.connectivity.framework.crawler.filesystem"
         point="org.eclipse.smila.connectivity.framework.indexorder.schema">
      <schema
            class="org.eclipse.smila.connectivity.framework.crawler.filesystem.IndexOrderSchemaImpl">
      </schema>
   </extension>
</plugin>
  • 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

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 a 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 name followed by DS (for DeclarativeService). Then you have to provide your implementation class and the service interface class, which is always org.eclipse.smila.connectivity.framework.Crawler.

filesystemcrawler.xml

<?xml version="1.0" encoding="UTF-8"?>
<component name="FileSystemCrawlerDS" immediate="true">
    <implementation class="org.eclipse.smila.connectivity.framework.crawler.filesystem.FileSystemCrawler" />
    <service>
         <provide interface="org.eclipse.smila.connectivity.framework.Crawler"/>
    </service>
    <property name="org.eclipse.smila.connectivity.framework.crawler.type" value="filesystemcrawler"/>
</component>
  • add a Service-Component entry to your manifest file, e.g.
Service-Component: OSGI-INF/filesystemcrawler.xml
  • open build.properties and change binary build: select folders OSGI-INF, schemas and file plugin.xml
source.. = code/src/,\
           code/gen/
output.. = code/bin/
bin.includes = META-INF/,\
               .,\
               plugin.xml,\
               schemas/,\
               OSGI-INF/

SCA requirements

Most requirements for SCA are already handled by the base class org.eclipse.smila.connectivity.framework.AbstractCrawler. You should annotate your implementation with @AllowsPassByReference, to allow SCA to pass service parameters by reference when service interactions are within the same adress space. Here is an example:

@AllowsPassByReference
public class FileSystemCrawler extends AbstractCrawler {
// implementation goes here ...
}

For SCA, make sure to set attribute "immediate" of tag "component" to false and attribute "servicefactory" of tag "service " 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 org.eclipse.smila.connectivity.framework.crawler.type. 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:

filesystemcrawler.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"/>
    </service>
    <property name="org.eclipse.smila.connectivity.framework.crawler.type" value="filesystemcrawler"/>
</component>

Develope 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 build process
  • integrate your test bundle into build process
  • Start your crawler with launch
    • by SMILA.exe
    • insert "org.eclipse.smila.connectivity.framework.crawler.filesystem@4:start, \" to config.ini
    • by SMILA.launch
    • Open run dialog, and set your bundle to start level 4 and auto start true.
  • Enjoy