ddf.catalog.source.solr

Class UnavailableSolrCatalogProvider

java.lang.Object

ddf.catalog.source.solr.UnavailableSolrCatalogProvider

All Implemented Interfaces:

CatalogProvider, Source, Maskable, Describable

public class UnavailableSolrCatalogProvider
extends Object
implements CatalogProvider

This class is used to signify an unavailable CatalogProvider instance. If a user tries to unsuccessfully connect to Solr, then a message will be displayed to check the connection.

Constructor Summary

Constructors

Constructor and Description
UnavailableSolrCatalogProvider()

Method Summary

Modifier and Type	Method and Description
CreateResponse	create(CreateRequest createRequest) Publishes a list of Metacard objects into the catalog.
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	getId() Returns the name, aka ID, of the describable item.
String	getOrganization() Returns the organization associated with the describable item.
String	getTitle() Returns the title of the describable item.
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 sourceId) Instructs this source of the id to use when reporting an id externally.
SourceResponse	query(QueryRequest queryRequest)
UpdateResponse	update(UpdateRequest updateRequest) Updates a list of Metacard records.

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

Constructor Detail

UnavailableSolrCatalogProvider

public UnavailableSolrCatalogProvider()

Method Detail

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

Returns:

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

getId

public String getId()

Description copied from interface: Describable

Returns the name, aka ID, of the describable item. The name should be unique for each instance.
Example: html for a MetacardTransformer that transforms Metacards to HTML

Specified by:

getId in interface Describable

Returns:

ID of the item

getOrganization

public String getOrganization()

Description copied from interface: Describable

Returns the organization associated with the describable item.

Specified by:

getOrganization in interface Describable

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

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

Returns:

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

maskId

public void maskId(String sourceId)

Description copied from interface: Maskable

Instructs this source of the id to use when reporting an id externally. When instructed, the provided ID must be used and can not be overridden.

Specified by:

maskId in interface Maskable

Parameters:

sourceId - the new id to use

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