ddf.catalog.impl

Class CatalogFrameworkImpl

java.lang.Object

ddf.catalog.util.impl.DescribableImpl

ddf.catalog.impl.CatalogFrameworkImpl

All Implemented Interfaces:

CatalogFramework, Describable

public class CatalogFrameworkImpl
extends DescribableImpl
implements CatalogFramework

CatalogFrameworkImpl is the core class of DDF. It is used for query, create, update, delete, and resource retrieval operations.

Constructor Summary

Constructors

Constructor and Description
CatalogFrameworkImpl(CreateOperations createOperations, UpdateOperations updateOperations, DeleteOperations deleteOperations, QueryOperations queryOperations, ResourceOperations resourceOperations, SourceOperations sourceOperations, TransformOperations transformOperations) Instantiates a new CatalogFrameworkImpl which delegates its work to surrogate operations classes.

Method Summary

Modifier and Type	Method and Description
CreateResponse	create(CreateRequest createRequest) Creates Metacards in the CatalogProvider.
CreateResponse	create(CreateStorageRequest createRequest) This code is experimental.
DeleteResponse	delete(DeleteRequest deleteRequest) Deletes Metacards with Attributes matching a specified value.
ResourceResponse	getEnterpriseResource(ResourceRequest resourceRequest) Evaluate a ResourceRequest against the local CatalogProvider and RemoteSources.
Map<String,Set<String>>	getEnterpriseResourceOptions(String metacardId) Deprecated.
ResourceResponse	getLocalResource(ResourceRequest resourceRequest) Evaluate a ResourceRequest using available ResourceReaders (does not attempt to locate the resource via federation).
Map<String,Set<String>>	getLocalResourceOptions(String metacardId) Deprecated.
QueryOperations	getQueryOperations()
ResourceResponse	getResource(ResourceRequest resourceRequest, String resourceSiteName) Evaluate a ResourceRequest using the specified site name.
ResourceOperations	getResourceOperations()
Map<String,Set<String>>	getResourceOptions(String metacardId, String sourceId) Deprecated.
Set<String>	getSourceIds() Return the set of source IDs known to the CatalogFramework.
SourceInfoResponse	getSourceInfo(SourceInfoRequest sourceInfoRequest) Returns information for each Source that is endpoint-addressable in CatalogFramework, including its own CatalogProvider, based on the contents of the SourceInfoRequest.
SourceOperations	getSourceOperations()
TransformOperations	getTransformOperations()
QueryResponse	query(QueryRequest fedQueryRequest) Evaluates a QueryRequest using the default FederationStrategy
QueryResponse	query(QueryRequest queryRequest, FederationStrategy strategy) Evaluates and executes a QueryRequest using the FederationStrategy provided.
void	setFanoutEnabled(boolean fanoutEnabled)
void	setFanoutTagBlacklist(List<String> fanoutTagBlacklist)
void	setId(String sourceId) Sets the source id to identify this framework (DDF).
void	setMasker(Masker masker) Sets the Masker
String	toString() String representation of this CatalogFrameworkImpl.
BinaryContent	transform(Metacard metacard, String transformerShortname, Map<String,Serializable> arguments) Transforms the provided Metacard into BinaryContent.
BinaryContent	transform(SourceResponse response, String transformerShortname, Map<String,Serializable> arguments) Transforms the provided SourceResponse (or QueryResponse) into BinaryContent.
UpdateResponse	update(UpdateRequest updateRequest) Updates a list of Metacards.
UpdateResponse	update(UpdateStorageRequest updateRequest) This code is experimental.

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

getDescription, getId, getOrganization, getTitle, getVersion, setDescription, setOrganization, setShortname, setTitle, setVersion

Methods inherited from class java.lang.Object

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

Methods inherited from interface ddf.catalog.util.Describable

getDescription, getId, getOrganization, getTitle, getVersion

Constructor Detail

CatalogFrameworkImpl

public CatalogFrameworkImpl(CreateOperations createOperations,
                            UpdateOperations updateOperations,
                            DeleteOperations deleteOperations,
                            QueryOperations queryOperations,
                            ResourceOperations resourceOperations,
                            SourceOperations sourceOperations,
                            TransformOperations transformOperations)

Instantiates a new CatalogFrameworkImpl which delegates its work to surrogate operations classes.

Parameters:

createOperations - delegate that handles create operations

updateOperations - delegate that handles update operations

deleteOperations - delegate that handles delete operations

queryOperations - delegate that handles query operations

resourceOperations - delegate that handles resource operations

sourceOperations - delegate that handles source operations

transformOperations - delegate that handles transformation operations

Method Detail

getQueryOperations

public QueryOperations getQueryOperations()

getResourceOperations

public ResourceOperations getResourceOperations()

getSourceOperations

public SourceOperations getSourceOperations()

getTransformOperations

public TransformOperations getTransformOperations()

setFanoutEnabled

public void setFanoutEnabled(boolean fanoutEnabled)

setFanoutTagBlacklist

public void setFanoutTagBlacklist(List<String> fanoutTagBlacklist)

setMasker

public void setMasker(Masker masker)

Sets the Masker

Parameters:

masker - the Masker this framework will use

setId

public void setId(String sourceId)

Sets the source id to identify this framework (DDF). This is also referred to as the site name.

Overrides:

setId in class DescribableImpl

Parameters:

sourceId - the sourceId to set

getSourceIds

public Set<String> getSourceIds()

Description copied from interface: CatalogFramework

Return the set of source IDs known to the CatalogFramework. This set includes the local provider and any federated sources, but not connected sources as they are hidden from external clients.

Specified by:

getSourceIds in interface CatalogFramework

Returns:

Set of source IDs

getSourceInfo

public SourceInfoResponse getSourceInfo(SourceInfoRequest sourceInfoRequest)
                                 throws SourceUnavailableException

Description copied from interface: CatalogFramework

Returns information for each Source that is endpoint-addressable in CatalogFramework, including its own CatalogProvider, based on the contents of the SourceInfoRequest.

The SourceInfoRequest specifies either:

1. an enterprise source search, which includes the catalog provider and all federated and connected sources
2. a list of requested source IDs, which are all federated sources
3. the catalog provider only

Specified by:

getSourceInfo in interface CatalogFramework

Parameters:

sourceInfoRequest - the SourceInfoRequest

Returns:

SourceInfoResponse

Throws:

SourceUnavailableException - if the source indicated in the SourceInfoRequest is null, not found, or cannot provide the requested information

create

public CreateResponse create(CreateStorageRequest createRequest)
                      throws IngestException,
                             SourceUnavailableException

Description copied from interface: CatalogFramework

This code is experimental. While this interface is functional and tested, it may change or be removed in a future version of the library. Creates Metacards in the CatalogProvider.

Implementations of this method must:

1. Before evaluation, call PreIngestPlugin.process(CreateRequest) for each registered PreIngestPlugin in order determined by the OSGi SERVICE_RANKING (Descending, highest first), "daisy chaining" their responses to each other.
2. Call CatalogProvider.create(CreateRequest) on the registered CatalogProvider
3. Call PostIngestPlugin.process(CreateResponse) for each registered PostIngestPlugin in order determined by the OSGi SERVICE_RANKING (Descending, highest first), "daisy chaining" their responses to each other.
4. Call PreCreateStoragePlugin.process(CreateStorageRequest) for each registered PreCreateStoragePlugin in order determined by the OSGi SERVICE_RANKING (Descending, highest first), "daisy chaining" their responses to each other.
5. Call StorageProvider.create(CreateStorageRequest) on the registered CatalogProvider
6. Call PostCreateStoragePlugin.process(ddf.catalog.content.operation.CreateStorageResponse) for each registered PostCreateStoragePlugin in order determined by the OSGi SERVICE_RANKING (Descending, highest first), "daisy chaining" their responses to each other.

Specified by:

create in interface CatalogFramework

Parameters:

createRequest - the CreateStorageRequest

Returns:

CreateResponse

Throws:

IngestException - if an issue occurs during the update

SourceUnavailableException - if the source being updated is unavailable

create

public CreateResponse create(CreateRequest createRequest)
                      throws IngestException,
                             SourceUnavailableException

Description copied from interface: CatalogFramework

Creates Metacards in the CatalogProvider.

Implementations of this method must:

1. Before evaluation, call PreIngestPlugin.process(CreateRequest) for each registered PreIngestPlugin in order determined by the OSGi SERVICE_RANKING (Descending, highest first), "daisy chaining" their responses to each other.
2. Call CatalogProvider.create(CreateRequest) on the registered CatalogProvider
3. Call PostIngestPlugin.process(CreateResponse) for each registered PostIngestPlugin in order determined by the OSGi SERVICE_RANKING (Descending, highest first), "daisy chaining" their responses to each other.

Specified by:

create in interface CatalogFramework

Parameters:

createRequest - the CreateRequest

Returns:

CreateResponse

Throws:

IngestException - if an issue occurs during the update

SourceUnavailableException - if the source being updated is unavailable

update

public UpdateResponse update(UpdateStorageRequest updateRequest)
                      throws IngestException,
                             SourceUnavailableException

Description copied from interface: CatalogFramework

This code is experimental. While this interface is functional and tested, it may change or be removed in a future version of the library. Updates a list of Metacards. Metacards that are not in the Catalog will not be created.

If a Metacard in the list to be updated does not have its ID attribute set, then the associated ID for that Metacard in the UpdateRequest will be used.

Implementations of this method must:

1. Before evaluation, call PreIngestPlugin.process(UpdateRequest) for each registered PreIngestPlugin in order determined by the OSGi SERVICE_RANKING (Descending, highest first), "daisy chaining" their responses to each other.
2. Call CatalogProvider.update(UpdateRequest) on the registered CatalogProvider
3. Call PostIngestPlugin.process(UpdateResponse) for each registered PostIngestPlugin in order determined by the OSGi SERVICE_RANKING (Descending, highest first), "daisy chaining" their responses to each other.
4. Call PreUpdateStoragePlugin.process(UpdateStorageRequest) for each registered PreUpdateStoragePlugin in order determined by the OSGi SERVICE_RANKING (Descending, highest first), "daisy chaining" their responses to each other.
5. Call StorageProvider.update(UpdateStorageRequest) on the registered CatalogProvider
6. Call PostUpdateStoragePlugin.process(ddf.catalog.content.operation.UpdateStorageResponse) for each registered PostUpdateStoragePlugin in order determined by the OSGi SERVICE_RANKING (Descending, highest first), "daisy chaining" their responses to each other.

Specified by:

update in interface CatalogFramework

Parameters:

updateRequest - the UpdateStorageRequest

Returns:

UpdateResponse

Throws:

IngestException - if an issue occurs during the update

SourceUnavailableException - if the source being updated is unavailable

update

public UpdateResponse update(UpdateRequest updateRequest)
                      throws IngestException,
                             SourceUnavailableException

Description copied from interface: CatalogFramework

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

If a Metacard in the list to be updated does not have its ID attribute set, then the associated ID for that Metacard in the UpdateRequest will be used.

Implementations of this method must:

1. Before evaluation, call PreIngestPlugin.process(UpdateRequest) for each registered PreIngestPlugin in order determined by the OSGi SERVICE_RANKING (Descending, highest first), "daisy chaining" their responses to each other.
2. Call CatalogProvider.update(UpdateRequest) on the registered CatalogProvider
3. Call PostIngestPlugin.process(UpdateResponse) for each registered PostIngestPlugin in order determined by the OSGi SERVICE_RANKING (Descending, highest first), "daisy chaining" their responses to each other.

Specified by:

update in interface CatalogFramework

Parameters:

updateRequest - the UpdateRequest

Returns:

UpdateResponse

Throws:

IngestException - if an issue occurs during the update

SourceUnavailableException - if the source being updated is unavailable

delete

public DeleteResponse delete(DeleteRequest deleteRequest)
                      throws IngestException,
                             SourceUnavailableException

Description copied from interface: CatalogFramework

Deletes Metacards with Attributes matching a specified value.

Implementations of this method must:

1. Before evaluation, call PreIngestPlugin.process(DeleteRequest) for each registered PreIngestPlugin in order determined by the OSGi SERVICE_RANKING (Descending, highest first), "daisy chaining" their responses to each other.
2. Call CatalogProvider.delete(DeleteRequest) on the registered CatalogProvider
3. Call PostIngestPlugin.process(DeleteResponse) for each registered PostIngestPlugin in order determined by the OSGi SERVICE_RANKING (Descending, highest first), "daisy chaining" their responses to each other.

Specified by:

delete in interface CatalogFramework

Parameters:

deleteRequest - the DeleteRequest

Returns:

DeleteResponse

Throws:

IngestException - if an issue occurs during the deletion

SourceUnavailableException - if the source being updated is unavailable

query

public QueryResponse query(QueryRequest fedQueryRequest)
                    throws UnsupportedQueryException,
                           SourceUnavailableException,
                           FederationException

Description copied from interface: CatalogFramework

Evaluates a QueryRequest using the default FederationStrategy

Implementations of this method must:

1. Before evaluation, call PreQueryPlugin.process(QueryRequest) for each registered PreQueryPlugin in order determined by the OSGi SERVICE_RANKING (Descending, highest first), "daisy chaining" their responses to each other.
2. Call Source.query(QueryRequest) on the registered CatalogProvider
3. Call Source.query(QueryRequest) on all registered ConnectedSources
4. If applicable, invoke the default FederationStrategy which will call Source.query(QueryRequest) on all registered FederatedSources
5. Before returning, call PostQueryPlugin.process(QueryResponse) for each registered PostQueryPlugin in order determined by the OSGi SERVICE_RANKING (Descending, highest first), "daisy chaining" their responses to each other.
6. Return the last QueryResponse to the caller.

Important: Implementations are free to limit the number of results returned regardless of the page size requested in the QueryRequest. For that reason, clients should not assume that the number of results returned matches the page size requested and write their paging code accordingly. If the QueryResponse does not need to be used, it is highly recommended that clients use an iterable class such as ResultIterable to retrieve and process results. If partitioning of results is required clients may use Guavas Iterables.partition(Iterable, int) method.

Specified by:

query in interface CatalogFramework

Parameters:

fedQueryRequest - the QueryRequest

Returns:

QueryResponse the resulting response

Throws:

UnsupportedQueryException - if the provided query can not be interpreted by a required Source

SourceUnavailableException - if a required Source is not available

FederationException - if federation is requested but can not complete, usually due to the FederationStrategy

See Also:

CatalogFramework.query(QueryRequest, FederationStrategy)

query

public QueryResponse query(QueryRequest queryRequest,
                           FederationStrategy strategy)
                    throws SourceUnavailableException,
                           UnsupportedQueryException,
                           FederationException

Description copied from interface: CatalogFramework

Evaluates and executes a QueryRequest using the FederationStrategy provided.

Implementations of this method must implement all of the rules defined in CatalogFramework.query(QueryRequest), but use the specified FederationStrategy

Important: Implementations are free to limit the number of results returned regardless of the page size requested in the QueryRequest. For that reason, clients should not assume that the number of results returned matches the page size requested and write their paging code accordingly. If the QueryResponse does not need to be used, it is highly recommended that clients use an iterable class such as ResultIterable to retrieve and process results. If partitioning of results is required clients may use Guavas Iterables.partition(Iterable, int) method.

Specified by:

query in interface CatalogFramework

Parameters:

queryRequest - the QueryRequest

strategy - the FederationStrategy to use

Returns:

QueryResponse the resulting response

Throws:

SourceUnavailableException - if a required Source is unavailable

UnsupportedQueryException - if the Query can not be evaluated by this CatalogFramework or any of its Sources.

FederationException - if the QueryRequest includes FederatedSources and there is either a problem connecting to a FederatedSource or a FederatedSource cannot evaluate the Query

transform

public BinaryContent transform(Metacard metacard,
                               String transformerShortname,
                               Map<String,Serializable> arguments)
                        throws CatalogTransformerException

Description copied from interface: CatalogFramework

Transforms the provided Metacard into BinaryContent. The transformerId is used to uniquely identify the MetacardTransformer desired.

Specified by:

transform in interface CatalogFramework

Parameters:

metacard - the Metacard to be transformed

transformerShortname - the id of the MetacardTransformer desired, as registered with the OSGi Service Registry.

arguments - to be used by the the transformer, if applicable

Returns:

BinaryContent the transformed Metacard

Throws:

CatalogTransformerException - if there is a problem transforming the Metacard

transform

public BinaryContent transform(SourceResponse response,
                               String transformerShortname,
                               Map<String,Serializable> arguments)
                        throws CatalogTransformerException

Description copied from interface: CatalogFramework

Transforms the provided SourceResponse (or QueryResponse) into BinaryContent. The transformerId is used to uniquely identify the QueryResponseTransformer desired.

Specified by:

transform in interface CatalogFramework

Parameters:

response - the SourceResponse to be transformed

transformerShortname - the id of the transformer

arguments - to be used by the the transformer, if applicable

Returns:

BinaryContent the transformed SourceResponse

Throws:

CatalogTransformerException - if there is a problem transforming the SourceResponse

getLocalResource

public ResourceResponse getLocalResource(ResourceRequest resourceRequest)
                                  throws IOException,
                                         ResourceNotFoundException,
                                         ResourceNotSupportedException

Description copied from interface: CatalogFramework

Evaluate a ResourceRequest using available ResourceReaders (does not attempt to locate the resource via federation).

Implementations of this method must:

1. Before evaluation, call PreResourcePlugin.process(ResourceRequest) for each registered PreResourcePlugin in order determined by the OSGi SERVICE_RANKING (Descending, highest first), "daisy chaining" their responses to each other.
2. If not provided with a java.net.URI ( ResourceRequest.GET_RESOURCE_BY_PRODUCT_URI.equals(ResourceRequest.getAttributeName())==false ) , retrieve the matching Metacard and get its Product java.net.URI.
3. Locate the ResourceReader that supports the URI.getScheme() of the java.net.URI on the OSGi Registry.
4. Call ResourceReader.retrieveResource(java.net.URI, Map)
5. Call PostResourcePlugin.process(ResourceResponse) for each registered PostResourcePlugin in order determined by the OSGi SERVICE_RANKING (Descending, highest first), "daisy chaining" their responses to each other.

Specified by:

getLocalResource in interface CatalogFramework

Parameters:

resourceRequest - the ResourceRequest

Returns:

ResourceResponse

Throws:

IOException - if there was a problem communicating with the system containing the resource

ResourceNotFoundException - if the requested resource was not found

ResourceNotSupportedException - if the scheme used in the associated java.net.URI is not supported by this CatalogFramework

getResource

public ResourceResponse getResource(ResourceRequest resourceRequest,
                                    String resourceSiteName)
                             throws IOException,
                                    ResourceNotFoundException,
                                    ResourceNotSupportedException

Description copied from interface: CatalogFramework

Evaluate a ResourceRequest using the specified site name.

Implementations of this method must:

1. Before evaluation, call PreResourcePlugin.process(ResourceRequest) for each registered PreResourcePlugin in order determined by the OSGi SERVICE_RANKING (Descending, highest first), "daisy chaining" their responses to each other.
2. If not provided with a java.net.URI ( ResourceRequest.GET_RESOURCE_BY_PRODUCT_URI.equals(ResourceRequest.getAttributeName())==false ) , retrieve the matching Metacard and get its Product java.net.URI.
3. Locate the ResourceReader that supports the URI.getScheme() of the java.net.URI on the OSGi Registry.
4. Call ResourceReader.retrieveResource(java.net.URI, Map)
5. Call PostResourcePlugin.process(ResourceResponse) for each registered PostResourcePlugin in order determined by the OSGi SERVICE_RANKING (Descending, highest first), "daisy chaining" their responses to each other.

Specified by:

getResource in interface CatalogFramework

Parameters:

resourceRequest - the ResourceRequest

resourceSiteName - name of the site/source to retrieve the resource from

Returns:

ResourceResponse

Throws:

IOException - if there was a problem communicating with the system containing the resource

ResourceNotFoundException - if the requested resource was not found

ResourceNotSupportedException - if the scheme used in the associated java.net.URI is not supported by this CatalogFramework

getEnterpriseResource

public ResourceResponse getEnterpriseResource(ResourceRequest resourceRequest)
                                       throws IOException,
                                              ResourceNotFoundException,
                                              ResourceNotSupportedException

Description copied from interface: CatalogFramework

Evaluate a ResourceRequest against the local CatalogProvider and RemoteSources.

Implementations of this method must:

1. Before evaluation, call PreResourcePlugin.process(ResourceRequest) for each registered PreResourcePlugin in order determined by the OSGi SERVICE_RANKING (Descending, highest first), "daisy chaining" their responses to each other.
2. If not provided with a java.net.URI ( ResourceRequest.GET_RESOURCE_BY_PRODUCT_URI.equals(ResourceRequest.getAttributeName())==false ) , retrieve the matching Metacard and get its Product java.net.URI.
3. Locate the ResourceReader that supports the URI.getScheme() of the java.net.URI on the OSGi Registry.
4. Call ResourceReader.retrieveResource(java.net.URI, Map)
5. Call PostResourcePlugin.process(ResourceResponse) for each registered PostResourcePlugin in order determined by the OSGi SERVICE_RANKING (Descending, highest first), "daisy chaining" their responses to each other.

Specified by:

getEnterpriseResource in interface CatalogFramework

Parameters:

resourceRequest - the ResourceRequest

Returns:

ResourceResponse

Throws:

IOException - if there was a problem communicating with the system containing the resource

ResourceNotFoundException - if the requested resource was not found

ResourceNotSupportedException - if the scheme used in the associated java.net.URI is not supported by this CatalogFramework

getLocalResourceOptions

@Deprecated
public Map<String,Set<String>> getLocalResourceOptions(String metacardId)
                                                            throws ResourceNotFoundException

Deprecated.

Description copied from interface: CatalogFramework

Search for a Metacard locally and retrieve arguments that can be used in the retrieval of its associated Resource.

Specified by:

getLocalResourceOptions in interface CatalogFramework

Parameters:

metacardId - the ID of the Metacard

Returns:

Map of supported options with argument name for using those options

Throws:

ResourceNotFoundException - if the Metacard is not found or there is no Resource associated with the Metacard

getEnterpriseResourceOptions

@Deprecated
public Map<String,Set<String>> getEnterpriseResourceOptions(String metacardId)
                                                                 throws ResourceNotFoundException

Deprecated.

Description copied from interface: CatalogFramework

Search for a Metacard in the enterprise and retrieve arguments that can be used in the retrieval of its associated Resource

Specified by:

getEnterpriseResourceOptions in interface CatalogFramework

Parameters:

metacardId - the ID of the Metacard

Returns:

Map of supported options with argument name for using those options

Throws:

ResourceNotFoundException - if the Metacard is not found or there is no Resource associated with the Metacard

getResourceOptions

@Deprecated
public Map<String,Set<String>> getResourceOptions(String metacardId,
                                                              String sourceId)
                                                       throws ResourceNotFoundException

Deprecated.

Description copied from interface: CatalogFramework

Search for a Metacard on specified Source and retrieve arguments that can be used in the retrieval of its associated Resource

Specified by:

getResourceOptions in interface CatalogFramework

Parameters:

metacardId - the ID of the metacard

sourceId - the ID of the source to retrieve the metacard from

Returns:

Map of supported options with argument name for using those options

Throws:

ResourceNotFoundException - if the Metacard is not found or there is no Resource associated with the Metacard

toString

public String toString()

String representation of this CatalogFrameworkImpl.

Overrides:

toString in class Object