CatalogFramework) API used to interact with providers of data such as a file system or database. The basic premise of a CatalogProvider is to allow query, create, update, and delete operations.
|Modifier and Type||Method and Description|
Publishes a list of
Deletes records specified by a list of attribute values such as an id attribute.
Updates a list of
getContentTypes, getSecurityAttributes, isAvailable, isAvailable, query
CreateResponse create(CreateRequest createRequest) throws IngestException
Metacardobjects into the catalog.
createRequest- - the
CreateRequestthat includes a
Metacardobjects to be stored in a
Source. The ID of the
Metacardobject will be ignored and populated / generated by the
CatalogProviderwhen the record has been stored.
Listof fully populated metacards. This should be similar to the parameter list of
Metacardobjects but it must have the ddf.catalog.data.Metacard ID populated.
IngestException- if any problem occurs when storing the metacards
UpdateResponse update(UpdateRequest updateRequest) throws IngestException
Metacardrecords that are not in the Catalog will not be created.
updateRequest- - the
UpdateRequestthat includes updates to
Metacardrecords that have been previously stored in a
Source. A given
Attributename-value pair in this request must uniquely identify zero metacards or one metacard in the
Source, otherwise an
IngestExceptionwill be thrown.
Updateobjects that represent the new (updated) and old (previous)
IngestException- if an issue occurs during the update such as multiple records were matched for a single update entry
DeleteResponse delete(DeleteRequest deleteRequest) throws IngestException
deleteRequest- - the
DeleteRequestcontaining the attribute values associated with
Metacards to delete
Metacards that were deleted. These
Metacards are fully populated in preparation for any processing services.
IngestException- if an issue occurs during the delete
This work is licensed under a Creative Commons Attribution 4.0 International License.