Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 5.3

...

Sources are components that enable 

Insert excerpt
ApplicationName
ApplicationName
nopaneltrueApplicationName
 to talk to back-end services. They let 
Insert excerpt
ApplicationName
ApplicationName
nopaneltrueApplicationName
 do query and ingest operations on catalog stores, and query operations on federated sources. Sources reside in the Sources area of the 
Insert excerpt
ApplicationName
ApplicationName
nopaneltrueApplicationName
 Overview.

Anchor
CreatingANewSource
CreatingANewSource
Creating a New Source

...

  1. Create a new class that implements the specified Source interface.
  2. Implement the required methods.
  3. Create OSGi descriptor file to communicate with the OSGi registry (described in the Working with OSGi  section).
    1. Import
      Insert excerpt
      ApplicationName
      ApplicationName
      nopaneltrueApplicationName
      packages
    2. Register source class as service to OSGi registry
  4. Deploy to
    Insert excerpt
    ApplicationName
    ApplicationName
    nopaneltrueApplicationName

...

  1. Create java class that implements CatalogProvider

    Code Block
    public class TestCatalogProvider implements ddf.catalog.source.CatalogProvider
    
  2. Implement the required methods from the ddf.catalog.source.CatalogProvider interface

    Code Block
    public CreateResponse create(CreateRequest createRequest) throws IngestException;
    
    public UpdateResponset update(UpdateRequest updateRequest) throws IngestException;
    
    public DeleteResponse delete(DeleteRequest deleteRequest) throws IngestException;
    
  3. Import the

    Insert excerpt
    ApplicationName
    ApplicationName
    nopaneltrueApplicationName
    interface packages to the bundle manifest (in addition to any other required packages):

    Code Block
    Import-Package: ddf.catalog, ddf.catalog.source
    
  4. Export the service to the OSGi registry:

    Code Block
    xml
    xml
    titleBlueprint examplexml
    <service ref="[[TestCatalogProvider]]" interface="ddf.catalog.source.CatalogProvider" />
    

The

Insert excerpt
ApplicationName
ApplicationName
nopaneltrueApplicationName
Integrator's Guide provides details on the following Catalog Providers that come with 
Insert excerpt
ApplicationName
ApplicationName
nopaneltrueApplicationName
out of the box:

Tip

A code example of a Catalog Provider delivered with 

Insert excerpt
ApplicationName
ApplicationName
nopaneltrueApplicationName
is the Catalog Solr Embedded Provider.

...

  1. Create Java class that implements FederatedSource

    Code Block
    public class TestFederatedSource implements ddf.catalog.source.FederatedSource
    
  2. Implement the required methods of the ddf.catalog.source.FederatedSource interface.


     

  3. Import the

    Insert excerpt
    ApplicationName
    ApplicationName
    nopaneltrueApplicationName
    interface packages to the bundle manifest (in addition to any other required packages):

    Code Block
    Import-Package: ddf.catalog, ddf.catalog.source
    
  4. Export the service to the OSGi registry:

    Code Block
    xml
    xml
    titleBlueprint examplexml
    <service ref="[[TestFederatedSource]]" interface="ddf.catalog.source.FederatedSource" />

The

Insert excerpt
ApplicationName
ApplicationName
nopaneltrueApplicationName
Integrator's Guide provides details on the following Federated Sources that come with 
Insert excerpt
ApplicationName
ApplicationName
nopaneltrueApplicationName
out of the box:

Tip

A code example of a Federated Source delivered with 

Insert excerpt
ApplicationName
ApplicationName
nopaneltrueApplicationName
can be found in ddf.catalog.source.solr

...

  1. Create Java class that implements ConnectedSource

    Code Block
    public class TestConnectedSource implements ddf.catalog.source.ConnectedSource
    
  2. Implement the required methods of the ddf.catalog.source.ConnectedSource interface.


     

  3. Import the

    Insert excerpt
    ApplicationName
    ApplicationName
    nopaneltrueApplicationName
    interface packages to the bundle manifest (in addition to any other required packages):

    Code Block
    Import-Package: ddf.catalog, ddf.catalog.source
    
  4. Export the service to the OSGi registry:

    Code Block
    xml
    xml
    titleBlueprint examplexml
    <service ref="[[TestConnectedSource]]" interface="ddf.catalog.source.ConnectedSource" />

...