ddf.catalog.history

Class Historian

java.lang.Object

ddf.catalog.history.Historian

public class Historian
extends Object

Class utilizing StorageProvider and CatalogProvider to version Metacards and associated ContentItems.

Constructor Summary

Constructors

Constructor and Description
Historian()

Method Summary

Modifier and Type	Method and Description
List<CatalogProvider>	getCatalogProviders()
List<StorageProvider>	getStorageProviders()
void	init()
boolean	isHistoryEnabled()
void	setCatalogProviders(List<CatalogProvider> catalogProviders)
void	setFilterBuilder(FilterBuilder filterBuilder)
void	setHistoryEnabled(boolean historyEnabled)
void	setMetacardTypes(List<MetacardType> metacardTypes)
void	setSkipFlag(Operation op)
void	setStorageProviders(List<StorageProvider> storageProviders)
void	setUuidGenerator(UuidGenerator uuidGenerator)
DeleteResponse	version(DeleteResponse deleteResponse) Versions deleted Metacards.
UpdateResponse	version(UpdateResponse updateResponse) Versions metacards being updated based off of the Update.getOldMetacard() method on UpdateResponse
UpdateStorageResponse	version(UpdateStorageRequest streamUpdateRequest, UpdateStorageResponse updateStorageResponse, UpdateResponse updateResponse) Versions updated Metacards and ContentItems.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Historian

public Historian()

Method Detail

init

public void init()

version

public UpdateResponse version(UpdateResponse updateResponse)
                       throws SourceUnavailableException,
                              IngestException

Versions metacards being updated based off of the Update.getOldMetacard() method on UpdateResponse

Parameters:

updateResponse - Versioned metacards created from any old metacards

Returns:

The original UpdateResponse

Throws:

SourceUnavailableException

IngestException

version

public UpdateStorageResponse version(UpdateStorageRequest streamUpdateRequest,
                                     UpdateStorageResponse updateStorageResponse,
                                     UpdateResponse updateResponse)
                              throws UnsupportedQueryException,
                                     SourceUnavailableException,
                                     IngestException

Versions updated Metacards and ContentItems.

Parameters:

streamUpdateRequest - Needed to pass MetacardVersion.SKIP_VERSIONING flag into downstream update

updateStorageResponse - Versions this response's updated items

Returns:

the update response originally passed in

Throws:

UnsupportedQueryException

SourceUnavailableException

IngestException

version

public DeleteResponse version(DeleteResponse deleteResponse)
                       throws SourceUnavailableException,
                              IngestException

Versions deleted Metacards.

Parameters:

deleteResponse - Versions this responses deleted metacards

Throws:

SourceUnavailableException

IngestException

isHistoryEnabled

public boolean isHistoryEnabled()

setHistoryEnabled

public void setHistoryEnabled(boolean historyEnabled)

getStorageProviders

public List<StorageProvider> getStorageProviders()

setStorageProviders

public void setStorageProviders(List<StorageProvider> storageProviders)

getCatalogProviders

public List<CatalogProvider> getCatalogProviders()

setCatalogProviders

public void setCatalogProviders(List<CatalogProvider> catalogProviders)

setFilterBuilder

public void setFilterBuilder(FilterBuilder filterBuilder)

setUuidGenerator

public void setUuidGenerator(UuidGenerator uuidGenerator)

setSkipFlag

public void setSkipFlag(@Nullable
                        Operation op)

setMetacardTypes

public void setMetacardTypes(List<MetacardType> metacardTypes)