ddf.catalog.source

Interface Source

All Superinterfaces:

Describable

All Known Subinterfaces:

CatalogProvider, CatalogStore, ConnectedSource, FederatedSource, RegistryStore, RemoteSource, SourceCache

All Known Implementing Classes:

AbstractCswSource, AbstractCswStore, CachedSource, ConfluenceSource, CswSourceImpl, OpenSearchSource, RegistryStoreImpl, RemoteSolrCatalogProvider, SolrCacheSource, SolrCatalogProvider, SolrCatalogProvider, TransactionalCswStoreImpl, TwitterSource, UnavailableSolrCatalogProvider, WfsSource, WfsSource

public interface Source
extends Describable

The Source is used to represent a system that has Metacards in a catalog. A Source may be remote or local. A local source may be a CatalogProvider or ConnectedSource. A remote source is typically a FederatedSource, but can be a ConnectedSource.

Method Summary

Modifier and Type	Method and Description
Set<ContentType>	getContentTypes() Gets the ContentTypes that are currently stored by the Source.
default Map<String,Set<String>>	getSecurityAttributes() Gets the map of security attributes associated with this source
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 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.
SourceResponse	query(QueryRequest request)

Methods inherited from interface ddf.catalog.util.Describable

getDescription, getId, getOrganization, getTitle, getVersion

Method Detail

isAvailable

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.

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

Returns:

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

See Also:

ddf.catalog.util.SourcePoller

isAvailable

boolean isAvailable(SourceMonitor callback)

This method is the same as 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.

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

SourceResponse query(QueryRequest request)
              throws UnsupportedQueryException

Parameters:

request - 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

getContentTypes

Set<ContentType> getContentTypes()

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.

Returns:

a Set of ContentTypes currently available from this Source.

getSecurityAttributes

default Map<String,Set<String>> getSecurityAttributes()

Gets the map of security attributes associated with this source

Returns:

a map of security attributes