Standard Catalog Framework
- Shaun Morris
- Alexander Lamar (Unlicensed)
Description
The Standard Catalog Framework provides the reference implementation of a Catalog Framework that implements all requirements of the
DDF
Catalog API.CatalogFrameworkImpl is the implementation of the DDF
Standard Catalog Framework.Usage
The Standard Catalog Framework is the core class of
DDF
. It provides the methods for query, create, update, delete, and resource retrieval (QCRUD) operations on the Sources. By contrast, the Fanout Catalog Framework only allows for query and resource retrieval operations, no catalog modifications, and all queries are enterprise-wide.Use this framework if:
- access to a catalog provider to create, update, and delete catalog entries are required
- queries to specific sites are required
- queries to only the local provider are required
It is possible to have only remote Sources configured with no local CatalogProvider configured and be able to execute queries to specific remote Sources by specifying the site name(s) in the query request.
The Standard Catalog Framework also maintains a list of ResourceReaders for resource retrieval operations. A resource reader is matched to the scheme (i.e., protocol, such as file://) in the URI of the resource specified in the request to be retrieved.
Site information about the catalog provider and/or any federated source(s) can be retrieved using the Standard Catalog Framework. Site information includes the source's name, version, availability, and the list of unique content types currently stored in the source (e.g., NITF). If no local catalog provider is configured, then the site information returned includes site info for the catalog framework with no content types included.
Installation and Uninstallation
The Standard Catalog Framework is bundled as the catalog-core-standardframework feature and can be installed and uninstalled using the normal processes described in Configuration.
When this feature is installed, the Catalog Fanout Framework App feature catalog-core-fanoutframework should be uninstalled, as both catalog frameworks should not be installed simultaneously.
Configuration
DDF
Configurable Properties
Catalog Standard Framework
| Property | Type | Description | Default Value | Required |
|---|---|---|---|---|
poolSize | Integer | The federation thread pool size (0 for unlimited) | 0 | yes |
| Managed Service PID | ddf.catalog.CatalogFrameworkImpl |
|---|---|
| Managed Service Factory PID | N/A |
Implementation Details
Exported Services
| Registered Interface | Service Property | Value |
|---|---|---|
ddf.catalog.federation.FederationStrategy | shortname | sorted |
org.osgi.service.event.EventHandler | event.topics | ddf/catalog/event/CREATED, ddf/catalog/event/UPDATED, ddf/catalog/event/DELETED |
ddf.catalog.CatalogFramework | ||
ddf.catalog.util.DdfConfigurationWatcher | ||
ddf.catalog.event.EventProcessor | ||
ddf.catalog.plugin.PostIngestPlugin |
Imported Services
| Registered Interface | Availability | Multiple |
|---|---|---|
ddf.catalog.plugin.PostIngestPlugin | optional | true |
ddf.catalog.plugin.PostQueryPlugin | optional | true |
ddf.catalog.plugin.PostResourcePlugin | optional | true |
ddf.catalog.plugin.PreDeliveryPlugin | optional | true |
ddf.catalog.plugin.PreIngestPlugin | optional | true |
ddf.catalog.plugin.PreQueryPlugin | optional | true |
ddf.catalog.plugin.PreResourcePlugin | optional | true |
ddf.catalog.plugin.PreSubscriptionPlugin | optional | true |
ddf.catalog.resource.ResourceReader | optional | true |
ddf.catalog.source.ConnectedSource, | optional | true |
ddf.catalog.source.FederatedSource | optional | true |
org.osgi.service.event.EventAdmin | false |
Known Issues
None