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:

CatalogProvider, Source, Maskable, Describable

Direct Known Subclasses:

SolrCatalogProvider

public abstract class RemoteSolrCatalogProvider
extends MaskableImpl
implements CatalogProvider

Common base class for all remote Solr Catalog providers. Sub-classes need to implement the createClient() method and return a new SolrClient.

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	SOLR_CATALOG_CORE_NAME

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
CreateResponse	create(CreateRequest createRequest) Publishes a list of Metacard objects into the catalog.
protected abstract Future<org.apache.solr.client.solrj.SolrClient>	createClient() Request the creation of a new SolrClient.
DeleteResponse	delete(DeleteRequest deleteRequest) Deletes records specified by a list of attribute values such as an id attribute.
Set<ContentType>	getContentTypes() Gets the ContentTypes that are currently stored by the Source.
String	getDescription() Returns a description of the describable item.
String	getOrganization() Returns the organization associated with the describable item.
String	getTitle() Returns the title of the describable item.
String	getUrl() Returns the current Solr server URL.
String	getVersion() Retrieve the version.
boolean	isAvailable() This method states whether this source is available, typically connecting and performing some sort of simple query or ping to the native catalog.
boolean	isAvailable(SourceMonitor callback) This method is the same as Source.isAvailable() but allows a caller to provide a SourceMonitor callback object which is meant to be used as a way for the Source to dynamically contact the caller with its availability.
void	maskId(String id) Sets the masked ID of this maskable item to the specified ID, and then sets an internal flag indicating that the masked ID cannot be changed.
SourceResponse	query(QueryRequest queryRequest)
void	setDisableTextPath(boolean disableTextPath) Disables text path indexing for every subsequent update or insert.
void	setForceAutoCommit(boolean forceAutoCommit) Used to signal to the Solr client to commit on every transaction.
void	setUrl(String url) Sets Solr's URL.
void	shutdown() Shuts down the connection to Solr and releases resources.
UpdateResponse	update(UpdateRequest updateRequest) Updates a list of Metacard records.
protected void	updateClient() Forces an update of the Solr client.

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.source.Source

getSecurityAttributes

Methods inherited from interface ddf.catalog.util.Describable

getId

Field Detail

SOLR_CATALOG_CORE_NAME

protected static final String SOLR_CATALOG_CORE_NAME

See Also:

Constant Field Values

Constructor Detail

RemoteSolrCatalogProvider

public RemoteSolrCatalogProvider(FilterAdapter filterAdapter,
                                 @Nullable
                                 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. If set to null, a new client will be created using createClient() when needed.

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.

RemoteSolrCatalogProvider

public RemoteSolrCatalogProvider(FilterAdapter filterAdapter,
                                 @Nullable
                                 org.apache.solr.client.solrj.SolrClient client,
                                 SolrFilterDelegateFactory solrFilterDelegateFactory)

Constructor. Uses a default DynamicSchemaResolver.

Parameters:

filterAdapter - filter adaptor this provider will use

client - client this provider will use to connect to Solr. If set to null, a new client will be created using createClient() when needed.

solrFilterDelegateFactory - Solr filter delegate factory this provider will use

RemoteSolrCatalogProvider

public RemoteSolrCatalogProvider(FilterAdapter filterAdapter,
                                 SolrFilterDelegateFactory solrFilterDelegateFactory)

Constructor. Creates and uses a default SolrClient and DynamicSchemaResolver.

Parameters:

filterAdapter - filter adaptor this provider will use

solrFilterDelegateFactory - Solr filter delegate factory this provider will use

Method Detail

maskId

public void maskId(String id)

Description copied from class: MaskableImpl

Sets the masked ID of this maskable item to the specified ID, and then sets an internal flag indicating that the masked ID cannot be changed.

Specified by:

maskId in interface Maskable

Overrides:

maskId in class MaskableImpl

Parameters:

id - the new id to use

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

setDisableTextPath

public void setDisableTextPath(boolean disableTextPath)

Disables text path indexing for every subsequent update or insert.

Parameters:

disableTextPath - true to turn off text path indexing

getContentTypes

public Set<ContentType> getContentTypes()

Description copied from interface: Source

Gets the ContentTypes that are currently stored by the Source. Notice the return object is a Set, meaning it returns all unique content types found in the Source without duplications.

Specified by:

getContentTypes in interface Source

Returns:

a Set of ContentTypes currently available from this Source.

isAvailable

public boolean isAvailable()

Description copied from interface: Source

This method states whether this source is available, typically connecting and performing some sort of simple query or ping to the native catalog.

This is expected to be an expensive operation, possibly involving network I/O. Typically only CatalogFramework implementations will call this and only periodically.

Specified by:

isAvailable in interface Source

Returns:

true - if the site is available (up), false - if the site is unavailable (down)

See Also:

ddf.catalog.util.SourcePoller

isAvailable

public boolean isAvailable(SourceMonitor callback)

Description copied from interface: Source

This method is the same as Source.isAvailable() but allows a caller to provide a SourceMonitor callback object which is meant to be used as a way for the Source to dynamically contact the caller with its availability. The intent is to return a boolean as to whether the Source is available at this very moment and also to use the SourceMonitor object to update the caller of this method if this Source's availability changes later in the future.

Specified by:

isAvailable in interface Source

Parameters:

callback - - used to notify the caller of this method when the Source object wants to update its availability.

Returns:

true - if the site is available (up), false - if the site is unavailable (down)

query

public SourceResponse query(QueryRequest queryRequest)
                     throws UnsupportedQueryException

Specified by:

query in interface Source

Parameters:

queryRequest - the query to execute

Returns:

a SourceResponse with query results and query response details

Throws:

UnsupportedQueryException - when the query is not understood, malformed, or not supported by a Source

getDescription

public String getDescription()

Description copied from interface: Describable

Returns a description of the describable item.

Specified by:

getDescription in interface Describable

Overrides:

getDescription in class DescribableImpl

Returns:

description of the item (example: Provider that returns back static results)

getOrganization

public String getOrganization()

Description copied from interface: Describable

Returns the organization associated with the describable item.

Specified by:

getOrganization in interface Describable

Overrides:

getOrganization in class DescribableImpl

Returns:

organizational name or acronym (example: USAF)

getTitle

public String getTitle()

Description copied from interface: Describable

Returns the title of the describable item. It is generally more verbose than the name (aka ID).

Specified by:

getTitle in interface Describable

Overrides:

getTitle in class DescribableImpl

Returns:

title of the item (example: Dummy Catalog Provider)

getVersion

public String getVersion()

Description copied from interface: Describable

Retrieve the version.

Specified by:

getVersion in interface Describable

Overrides:

getVersion in class DescribableImpl

Returns:

the version of the item being described (example: 1.0)

create

public CreateResponse create(CreateRequest createRequest)
                      throws IngestException

Description copied from interface: CatalogProvider

Publishes a list of Metacard objects into the catalog.

Specified by:

create in interface CatalogProvider

Parameters:

createRequest - - the CreateRequest that includes a List of Metacard objects to be stored in a Source. The ID of the Metacard object will be ignored and populated / generated by the CatalogProvider when the record has been stored.

Returns:

the CreateResponse containing a List of fully populated metacards. This should be similar to the parameter list of Metacard objects but it must have the ddf.catalog.data.Metacard ID populated.

Throws:

IngestException - if any problem occurs when storing the metacards

delete

public DeleteResponse delete(DeleteRequest deleteRequest)
                      throws IngestException

Description copied from interface: CatalogProvider

Deletes records specified by a list of attribute values such as an id attribute.

Specified by:

delete in interface CatalogProvider

Parameters:

deleteRequest - - the DeleteRequest containing the attribute values associated with Metacards to delete

Returns:

a DeleteResponse with Metacards that were deleted. These Metacards are fully populated in preparation for any processing services.

Throws:

IngestException - if an issue occurs during the delete

update

public UpdateResponse update(UpdateRequest updateRequest)
                      throws IngestException

Description copied from interface: CatalogProvider

Updates a list of Metacard records. Metacard records that are not in the Catalog will not be created.

Specified by:

update in interface CatalogProvider

Parameters:

updateRequest - - the UpdateRequest that includes updates to Metacard records that have been previously stored in a Source. A given Attribute name-value pair in this request must uniquely identify zero metacards or one metacard in the Source, otherwise an IngestException will be thrown.

Returns:

the UpdateResponse containing a List of Update objects that represent the new (updated) and old (previous) Metacard records.

Throws:

IngestException - if an issue occurs during the update such as multiple records were matched for a single update entry

shutdown

public void shutdown()

Shuts down the connection to Solr and releases resources.

getUrl

@Nullable
public String getUrl()

Returns the current Solr server URL. The format of the URL may vary based on the current Solr configuration (embedded, external or cloud).

Returns:

current Solr URL

setUrl

public void setUrl(@Nullable
                   String url)

Sets Solr's URL. The format of the URL may vary based on the current Solr configuration, e.g., embedded, external or cloud. See the system.properties configuration file for the different options and formats.
Changing the URL will trigger the creation of a new Solr client using createClient().

Parameters:

url - new Solr URL

updateClient

protected void updateClient()

Forces an update of the Solr client.

createClient

protected abstract Future<org.apache.solr.client.solrj.SolrClient> createClient()

Request the creation of a new SolrClient.

Returns:

Future used to retrieve the new SolrClient created