Package ddf.catalog.source.solr

Class RemoteSolrCatalogProvider

java.lang.Object

ddf.catalog.util.impl.DescribableImpl

ddf.catalog.util.impl.MaskableImpl

ddf.catalog.source.solr.RemoteSolrCatalogProvider

All Implemented Interfaces:

ddf.catalog.source.CatalogProvider, ddf.catalog.source.Source, ddf.catalog.util.Describable, ddf.catalog.util.Maskable, org.codice.ddf.platform.services.common.Describable

public abstract class RemoteSolrCatalogProvider
extends MaskableImpl
implements ddf.catalog.source.CatalogProvider

Common base class for all remote Solr Catalog providers.

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	SOLR_CATALOG_CORE_NAME

Constructor Summary

Constructors

Constructor	Description
RemoteSolrCatalogProvider(ddf.catalog.filter.FilterAdapter filterAdapter, org.apache.solr.client.solrj.SolrClient client, SolrFilterDelegateFactory solrFilterDelegateFactory, DynamicSchemaResolver resolver)	Constructor.

Method Summary

Modifier and Type	Method	Description
ddf.catalog.operation.CreateResponse	create(ddf.catalog.operation.CreateRequest createRequest)
ddf.catalog.operation.DeleteResponse	delete(ddf.catalog.operation.DeleteRequest deleteRequest)
Set<ddf.catalog.data.ContentType>	getContentTypes()
String	getDescription()
String	getOrganization()
String	getTitle()
String	getVersion()
boolean	isAvailable()
boolean	isAvailable(ddf.catalog.source.SourceMonitor callback)
void	maskId(String id)
ddf.catalog.operation.SourceResponse	query(ddf.catalog.operation.QueryRequest queryRequest)
void	setForceAutoCommit(boolean forceAutoCommit)	Used to signal to the Solr client to commit on every transaction.
void	shutdown()	Shuts down the connection to Solr and releases resources.
ddf.catalog.operation.UpdateResponse	update(ddf.catalog.operation.UpdateRequest updateRequest)

Methods inherited from class ddf.catalog.util.impl.MaskableImpl

setId

Methods inherited from class ddf.catalog.util.impl.DescribableImpl

getId, setDescription, setOrganization, setShortname, setTitle, setVersion

Methods inherited from class java.lang.Object

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

Methods inherited from interface ddf.catalog.util.Describable

getId

Methods inherited from interface ddf.catalog.source.Source

getSecurityAttributes

Field Details

SOLR_CATALOG_CORE_NAME

protected static final String SOLR_CATALOG_CORE_NAME

See Also:

• Constant Field Values

Constructor Details

RemoteSolrCatalogProvider

public RemoteSolrCatalogProvider(ddf.catalog.filter.FilterAdapter filterAdapter,
 org.apache.solr.client.solrj.SolrClient client,
 SolrFilterDelegateFactory solrFilterDelegateFactory,
 @Nullable
 DynamicSchemaResolver resolver)

Constructor.

Parameters:

filterAdapter - filter adaptor this provider will use

client - client this provider will use to connect to Solr

solrFilterDelegateFactory - Solr filter delegate factory this provider will use

resolver - schema resolver this provider will use. A default schema resolver will be used if this parameter is null.

Method Details

maskId

public void maskId(String id)

Specified by:

maskId in interface ddf.catalog.util.Maskable

Overrides:

maskId in class MaskableImpl

setForceAutoCommit

public void setForceAutoCommit(boolean forceAutoCommit)

Used to signal to the Solr client to commit on every transaction. Updates the underlying ConfigurationStore so that the property is propagated throughout the Solr Catalog Provider code.

Parameters:

forceAutoCommit - true to force auto-commits

getContentTypes

public Set<ddf.catalog.data.ContentType> getContentTypes()

Specified by:

getContentTypes in interface ddf.catalog.source.Source

isAvailable

public boolean isAvailable()

Specified by:

isAvailable in interface ddf.catalog.source.Source

isAvailable

public boolean isAvailable(ddf.catalog.source.SourceMonitor callback)

Specified by:

isAvailable in interface ddf.catalog.source.Source

query

public ddf.catalog.operation.SourceResponse query(ddf.catalog.operation.QueryRequest queryRequest)
                                           throws ddf.catalog.source.UnsupportedQueryException

Specified by:

query in interface ddf.catalog.source.Source

Throws:

ddf.catalog.source.UnsupportedQueryException

getDescription

public String getDescription()

Specified by:

getDescription in interface ddf.catalog.util.Describable

Specified by:

getDescription in interface org.codice.ddf.platform.services.common.Describable

Overrides:

getDescription in class DescribableImpl

getOrganization

public String getOrganization()

Specified by:

getOrganization in interface ddf.catalog.util.Describable

Specified by:

getOrganization in interface org.codice.ddf.platform.services.common.Describable

Overrides:

getOrganization in class DescribableImpl

getTitle

public String getTitle()

Specified by:

getTitle in interface ddf.catalog.util.Describable

Specified by:

getTitle in interface org.codice.ddf.platform.services.common.Describable

Overrides:

getTitle in class DescribableImpl

getVersion

public String getVersion()

Specified by:

getVersion in interface ddf.catalog.util.Describable

Specified by:

getVersion in interface org.codice.ddf.platform.services.common.Describable

Overrides:

getVersion in class DescribableImpl

create

public ddf.catalog.operation.CreateResponse create(ddf.catalog.operation.CreateRequest createRequest)
                                            throws ddf.catalog.source.IngestException

Specified by:

create in interface ddf.catalog.source.CatalogProvider

Throws:

ddf.catalog.source.IngestException

delete

public ddf.catalog.operation.DeleteResponse delete(ddf.catalog.operation.DeleteRequest deleteRequest)
                                            throws ddf.catalog.source.IngestException

Specified by:

delete in interface ddf.catalog.source.CatalogProvider

Throws:

ddf.catalog.source.IngestException

update

public ddf.catalog.operation.UpdateResponse update(ddf.catalog.operation.UpdateRequest updateRequest)
                                            throws ddf.catalog.source.IngestException

Specified by:

update in interface ddf.catalog.source.CatalogProvider

Throws:

ddf.catalog.source.IngestException

shutdown

public void shutdown()

Shuts down the connection to Solr and releases resources.