Difference between revisions of "SMILA/Documentation"

From Eclipsepedia

Jump to: navigation, search
Line 1: Line 1:
This page provides an overview of all available documentation pages for already implemented components.
+
== Basics ==
*JavaDoc
+
* [[SMILA/Architecture_Overview|Architecture]]
*[http://build.eclipse.org/rt/smila/javadoc/current current version JavaDoc]
+
* [[SMILA/Default_configuration_workflow_overview|Overview on Default Configuration]]
 +
* [[SMILA/Documentation/Data_Model_and_Serialization_Formats|Data Model, XML, JSON, BON]]
 +
* [[SMILA/Documentation/Using_The_ReST_API|Using the ReST API]]
 +
* [[SMILA/REST_API_Reference|REST API Reference]]
  
*Common
+
== The SMILA Development Environment ==
**[[SMILA/Documentation/Data Model and Serialization Formats|Data Model and Serialization Formats]]
+
* [[SMILA/Development_Guidelines/Howto_set_up_dev_environment|Setup your Eclipse IDE for SMILA]]
**[[SMILA/Documentation/JettyHttpServer|Configuration and Usage of the embedded Jetty HTTP server]]
+
* [[SMILA/Development_Guidelines/Howto_build_a_SMILA-Distribution|Build SMILA]]
**[[SMILA/Documentation/MimeTypeIdentifier|MimeTypeIdentifier]]
+
* [[SMILA/Development_Guidelines/Create_a_bundle_(plug-in)|Creating new components]]
***[[SMILA/Documentation/ApertureMimeTypeIdentifier|ApertureMimeTypeIdentifier]] (<span style="color:#ff0000">This component is not yet available in our repository.</span>)
+
* [[SMILA/Development_Guidelines/Create_a_test_bundle_(plug-in)|Testing new components]]
**[[SMILA/Documentation/PublishingJAXWSWebservices|Publishing JAX-WS Webservices]]
+
* [[SMILA/Development_Guidelines/3rd_party_bundle|Adding Third Party libraries to SMILA]]
**[[SMILA/Documentation/General_JPA_Configuration_in_SMILA|General JPA Configuration in SMILA]]
+
* [[SMILA/Development_Guidelines/Declarative_Services|Using OSGi Declarative Services]]
**[[SMILA/Documentation/Bundle org.eclipse.smila.clusterconfig|Configuration bundle org.eclipse.smila.clusterconfig]]
+
* Extending the build process:
**[[SMILA/Documentation/Bundle org.eclipse.smila.clusterconfig.simple|Simple configuration implementation bundle org.eclipse.smila.clusterconfig.simple]]
+
** [[SMILA/Development_Guidelines/How_to_integrate_new_bundle_into_build_process|Adding a new component bundle to the build]]
 +
** [[SMILA/Development_Guidelines/How_to_integrate_test_bundle_into_build_process|Adding a new test bundle to the build]]
  
*Connectivity
+
== Pipelines and Pipelets: Synchronous Workflows of Java components ==
 +
* [[SMILA/Documentation/Pipelets|What are Pipelines? What are Pipelets?]]
 +
* [[SMILA/Documentation/BPEL_Workflow_Processor|Configuration and Creating BPEL Pipelines]]
 +
** [[SMILA/Development_Guidelines/How_to_filter_and_access_record_data_in_BPEL|Accessing SMILA records in BPEL activities]]
 +
* [[SMILA/BPEL_Designer|Using the SMILA BPEL Designer]]
 +
* ReST APIs
 +
** [[SMILA/Documentation/Processing/JSON_REST_API_for_pipelets|for showing pipelets]]
 +
** [[SMILA/Documentation/Processing/JSON_REST_API_for_BPEL_pipelines|for showing, manipulating and executing pipelines]]
 +
* Basic Pipelets
 +
** [[SMILA/Documentation/Bundle org.eclipse.smila.processing.pipelets|Common pipelets: bundle org.eclipse.smila.processing.pipelets]]
 +
** [[SMILA/Documentation/Bundle org.eclipse.smila.processing.pipelets.xmlprocessing|Common XML pipelets: Bundle org.eclipse.smila.processing.pipelets.xmlprocessing]]
 +
** More special pipelets are provided by components described below.
 +
* Developing Pipelets
 +
** [[SMILA/Development_Guidelines/How_to_write_a_Pipelet|How to write a pipelet]]
 +
** [[SMILA/Documentation/Usage_of_Blackboard_Service|BlackboardService]]
 +
 
 +
== Using SMILA for Search ==
 +
 
 +
* [[SMILA/Documentation/Search|Search Processing and APIs]]
 +
* [[SMILA/Documentation/Solr|Solr Integration: Configuration and Pipelets]]
 +
 
 +
== JobManager: Asynchronous Workflows ==
 +
* [[SMILA/Documentation/JobManager|Concepts: Jobs and Tasks]]
 +
** [[SMILA/Documentation/JobManagerFirstExample|A simple example]]
 +
* Creating Workflows and Jobs
 +
** [[SMILA/Documentation/DataObjectTypesAndBuckets|Defining Buckets]]
 +
** [[SMILA/Documentation/WorkerAndWorkflows|Modeling Workflows]]
 +
** [[SMILA/Documentation/JobDefinitions|Creating Jobs]]
 +
** [[SMILA/Documentation/JobParameters|Evaluation of Job Parameters]]
 +
* [[SMILA/Documentation/JobRuns|Running and Monitoring Jobs]]
 +
* [[SMILA/Documentation/JobManagerConfiguration|JobManager Configuration]]
 +
* [[SMILA/Documentation/TaskManager|TaskManager: Asynchronous scheduling of tasks]]
 +
* Workers Reference
 +
** [[SMILA/Documentation/Bulkbuilder|Bulkbuilder]]
 +
** [[SMILA/Documentation/Worker/PipelineProcessorWorker|PipelineProcesor]]
 +
** [[SMILA/Documentation/Worker/PipeletProcessorWorker|PipeletProcessor]]
 +
** See [[SMILA/Manual#Importing|Importing]] below for more workers
 +
* Developing Workers
 +
** [[SMILA/Documentation/WorkerManager|WorkerManager: Workers made easy]]
 +
** [[SMILA/Development_Guidelines/How_to_write_a_Worker|How to write a worker]]
 +
** [[SMILA/Documentation/TaskGenerators|Task Generators]]
 +
 
 +
== Importing ==
 +
* [[SMILA/Documentation/Importing/Concept|Concepts]]
 +
* Importing Workers reference
 +
**[[SMILA/Documentation/Importing/Crawler/File | FileCrawler and FileFetcher worker]]
 +
**[[SMILA/Documentation/Importing/Crawler/Web | WebCrawler and WebFetcher worker]]
 +
**[[SMILA/Documentation/Importing/DeltaCheck | DeltaCheck worker]]
 +
**[[SMILA/Documentation/Importing/UpdatePusher | UpdatePusher worker]]
 +
* Developing Importing Workers
 +
** [[SMILA/Documentation/Importing/VisitedLinks | VisitedLinks service]]
 +
** [[SMILA/Documentation/Importing/Crawler/Web#Internal_structure|Extending the WebCrawler worker]]
 +
** [[SMILA/Development_Guidelines/How to add a new Data Source to the importing framework|How to add a new '''Data Source''' to the SMILA importing framework]]
 +
 
 +
== The SMILA HTTP Server ==
 +
* [[SMILA/Documentation/JettyHttpServer|Configuration of Jetty]]
 +
* [[SMILA/Documentation/JettyHttpServer#JSON_Handlers|Developing JSON ReST handlers for SMILA]]
 +
 
 +
== Common Services ==
 +
* [[SMILA/Project Concepts/Simple configuration handler|Configuration Helper]]
 +
* [[SMILA/Documentation/Workspace Handling|Workspace Helper]]
 +
* [[SMILA/Documentation/Bundle_org.eclipse.smila.clusterconfig|ClusterConfig service]]
 +
** [[SMILA/Documentation/Bundle_org.eclipse.smila.clusterconfig.simple|Simple implementation]]
 +
* [[SMILA/Documentation/ObjectStore/Bundle_org.eclipse.smila.objectstore|ObjectStore]]
 +
** [[SMILA/Documentation/ObjectStore/Bundle_org.eclipse.smila.objectstore.filesystem|Filesystem Objectstore implementation]]
 +
* [[SMILA/Documentation/Binary_Storage|BinaryStorage]]
 +
* [[SMILA/Documentation/Security|Processing security information]]
 +
** [[SMILA/Documentation/LDAPSecurityResolver|Implementation for using LDAP]]
 +
** [[SMILA/Documentation/SecurityProcessingServices|Example Pipelets]]
 +
* [[SMILA/Documentation/SesameOntologyManager|Ontology processing with Sesame: Configuration and Pipelets]]
 +
* [[SMILA/Documentation/MimeTypeIdentifier|MimeTypeIdentifier]]
 +
* [[SMILA/Documentation/PublishingJAXWSWebservices|Publishing Web Services]]
 +
* [[SMILA/Documentation/General JPA Configuration in SMILA|General JPA Configuration in SMILA]]
 +
 
 +
== Deprecated Components ==
 +
* [[SMILA/Documentation/ConnectivityFramework|Connectivity Framework]]
 
**[[SMILA/Documentation/ConnectivityManager|ConnectivityManager]]
 
**[[SMILA/Documentation/ConnectivityManager|ConnectivityManager]]
 
**[[SMILA/Documentation/DeltaIndexingManager|DeltaIndexingManager]]
 
**[[SMILA/Documentation/DeltaIndexingManager|DeltaIndexingManager]]
**[[SMILA/Documentation/ConnectivityFramework|ConnectivityFramework]]
 
 
***[[SMILA/Documentation/CrawlerController|CrawlerController]]
 
***[[SMILA/Documentation/CrawlerController|CrawlerController]]
 
***[[SMILA/Documentation/Crawler|Crawler]]
 
***[[SMILA/Documentation/Crawler|Crawler]]
Line 28: Line 106:
 
****[[SMILA/Documentation/JobFile Agent|JobFile Agent]]
 
****[[SMILA/Documentation/JobFile Agent|JobFile Agent]]
 
***[[SMILA/Documentation/CompoundManagement|CompoundManagement]]
 
***[[SMILA/Documentation/CompoundManagement|CompoundManagement]]
+
** Developing
*Processing
+
*** [[SMILA/Development_Guidelines/How_to_implement_a_Crawler|How to implement a crawler]]
**[[SMILA/Documentation/BPEL Workflow Processor|BPEL Workflow Processor]]
+
*** [[SMILA/Development_Guidelines/How_to_implement_an_agent|How to implement an agent]]
**[[SMILA/Documentation/Processing/JSON REST API for BPEL pipelines|JSON REST API for BPEL pipelines]]
+
** [[SMILA/Documentation/Management|JMX Management]]
**[[SMILA/Documentation/Processing/JSON REST API for pipelets|JSON REST API for pipelets]]
+
*** [[SMILA/Documentation/Management#JMX_Client|JMX Clients]]
**[[SMILA/Documentation/Usage of Blackboard Service|Usage of Blackboard Service]]
+
** [[SMILA/Documentation/Record_Storage|RecordStorage]]
**[[SMILA/Documentation/Pipelets|Pipelets]]
+
**Available Pipelets
+
***[[SMILA/Documentation/Solr|SMILA/Documentation/Solr]]
+
***[[SMILA/Documentation/Bundle org.eclipse.smila.processing.pipelets|Bundle org.eclipse.smila.processing.pipelets]]
+
***[[SMILA/Documentation/Bundle org.eclipse.smila.processing.pipelets.xmlprocessing|Bundle org.eclipse.smila.processing.pipelets.xmlprocessing]]
+
***[[SMILA/Documentation/SampleSecurityConverterPipelet|SampleSecurityConverterPipelet]]
+
***[[SMILA/Documentation/AperturePipelet|AperturePipelet]] (<span style="color:#ff0000">This pipelet is not yet available in our repository.</span>)
+
 
+
*Search:
+
**[[SMILA/Documentation/Search|Search API and Processing]]
+
 
+
*[[SMILA/Documentation/Security|Security]]
+
**[[SMILA/Documentation/LDAPSecurityResolver|LDAPSecurityResolver]]
+
**[[SMILA/Documentation/SecurityProcessingServices|SecurityProcessingServices]] (SampleSecurityConverter)
+
+
*Storage
+
**[[SMILA/Documentation/Binary Storage|Binary Storage]]
+
**[[SMILA/Documentation/Record Storage|Record Storage]] (not used in 0.9 by default)
+
**[[SMILA/Documentation/ObjectStore/Bundle org.eclipse.smila.objectstore|Bundle org.eclipse.smila.objectstore]]
+
**[[SMILA/Documentation/ObjectStore/Bundle org.eclipse.smila.objectstore.filesystem|Bundle org.eclipse.smila.objectstore.filesystem]]
+
 
+
*Job Management
+
**[[SMILA/Documentation/JobManager|JobManager]]
+
**[[SMILA/Documentation/TaskManager|TaskManager]]
+
**[[SMILA/Documentation/WorkerManager|WorkerManager]]
+
** Worker
+
***[[SMILA/Documentation/Bulkbuilder|Bulkbuilder worker]]
+
***[[SMILA/Documentation/Worker/PipelineProcessorWorker | Pipeline worker (BPEL worker) ]]
+
***[[SMILA/Documentation/Worker/PipeletProcessorWorker | Pipelet worker]]
+
** Workers for Importing
+
***[[SMILA/Documentation/Importing/Concept | The idea]]
+
***[[SMILA/Documentation/Importing/DeltaCheck | DeltaCheck worker]]
+
***[[SMILA/Documentation/Importing/UpdatePusher | UpdatePusher worker]]
+
***[[SMILA/Documentation/Importing/Crawler/File | FileCrawler worker]]
+
***[[SMILA/Documentation/Importing/Crawler/Web | WebCrawler worker]]
+
***[[SMILA/Documentation/Importing/VisitedLinks | VisitedLinks service]]
+
**Examples
+
***[[SMILA/Documentation/JobManagerFirstExample]]
+
 
+
*[[SMILA/Documentation/Management|Management]]
+
+
*Utilities
+
**[[SMILA/Documentation/Management#JMX_Client|JMX Client]]
+
**[[SMILA/Documentation/Workspace Handling|Workspace Handling]]
+
**...
+
+
*Semantic Layer: Ontology Integration
+
**[[SMILA/Documentation/SesameOntologyManager|Sesame Ontology Manager]]
+
 
+
*Concerning Third Party Software
+
**[[SMILA/Documentation/SNAPSHOT versions - which and why|SNAPSHOT versions - which and why]]
+
 
+
  
 
[[Category:SMILA]]
 
[[Category:SMILA]]

Revision as of 09:21, 24 January 2012

Contents

Basics

The SMILA Development Environment

Pipelines and Pipelets: Synchronous Workflows of Java components

Using SMILA for Search

JobManager: Asynchronous Workflows

Importing

The SMILA HTTP Server

Common Services

Deprecated Components