org.codice.ddf.spatial.ogc.csw.catalog.common.source

Class AbstractCswStore

java.lang.Object

ddf.catalog.util.impl.DescribableImpl

ddf.catalog.util.impl.MaskableImpl

org.codice.ddf.spatial.ogc.csw.catalog.common.source.AbstractCswSource

org.codice.ddf.spatial.ogc.csw.catalog.common.source.AbstractCswStore

All Implemented Interfaces:

ResourceReader, ConfiguredService, CatalogStore, ConnectedSource, FederatedSource, RemoteSource, Source, Maskable, Describable

Direct Known Subclasses:

RegistryStoreImpl, TransactionalCswStoreImpl

public abstract class AbstractCswStore
extends AbstractCswSource
implements CatalogStore

Field Summary

Fields

Modifier and Type	Field and Description
protected javax.ws.rs.ext.MessageBodyWriter<CswTransactionRequest>	cswTransactionWriter
protected TransformerManager	schemaTransformerManager

Fields inherited from class org.codice.ddf.spatial.ogc.csw.catalog.common.source.AbstractCswSource

availabilityPollFuture, capabilities, configurationPid, CONNECTION_TIMEOUT_PROPERTY, COORDINATE_ORDER_PROPERTY, CSW_SERVER_ERROR, cswFilterDelegate, cswSourceConfiguration, cswTransformConverter, CSWURL_PROPERTY, DISABLE_CN_CHECK_PROPERTY, EVENT_SERVICE_ADDRESS, factory, filterAdapter, filterBuilder, filterlessSubscriptionId, FORCE_SPATIAL_FILTER_PROPERTY, forceSpatialFilter, getRecordsTypeProvider, ID_PROPERTY, IS_CQL_FORCED_PROPERTY, jaxbElementClassMap, jaxbElementClassNames, METACARD_MAPPINGS_PROPERTY, NO_FORCE_SPATIAL_FILTER, OUTPUT_SCHEMA_PROPERTY, PASSWORD_PROPERTY, POLL_INTERVAL_PROPERTY, QUERY_TYPE_NAME_PROPERTY, QUERY_TYPE_NAMESPACE_PROPERTY, RECEIVE_TIMEOUT_PROPERTY, REGISTER_FOR_EVENTS, SECURITY_ATTRIBUTES_PROPERTY, securityManager, subscribeClientFactory, USE_POS_LIST_PROPERTY, USERNAME_PROPERTY

Constructor Summary

Constructors

Constructor and Description
AbstractCswStore(org.osgi.framework.BundleContext context, CswSourceConfiguration cswSourceConfiguration, com.thoughtworks.xstream.converters.Converter provider, SecureCxfClientFactory factory, EncryptionService encryptionService) Instantiates a CswStore.
AbstractCswStore(EncryptionService encryptionService) Instantiates a CswStore.

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.
javax.ws.rs.ext.MessageBodyWriter<CswTransactionRequest>	getCswTransactionWriter()
protected List<? extends Object>	initProviders(com.thoughtworks.xstream.converters.Converter cswTransformProvider, CswSourceConfiguration cswSourceConfiguration)
void	setCswTransactionWriter(javax.ws.rs.ext.MessageBodyWriter<CswTransactionRequest> cswTransactionWriter)
void	setSchemaTransformerManager(TransformerManager schemaTransformerManager)
UpdateResponse	update(UpdateRequest updateRequest) Updates a list of Metacard records.
protected void	validateOperation()

Methods inherited from class org.codice.ddf.spatial.ogc.csw.catalog.common.source.AbstractCswSource

addSourceMonitor, availabilityChanged, configureCswSource, createResults, destroy, getAdditionalConsumers, getAvailabilityCommand, getCapabilities, getConfigurationPid, getConnectionTimeout, getContentTypes, getCswTransformConverter, getDescription, getForceSpatialFilter, getId, getMetadataTransformerId, getOptions, getOrganization, getParameter, getReceiveTimeout, getResourceReader, getSecurityAttributes, getSupportedSchemes, getSystemSubject, getTitle, getVersion, handleClientException, handleWebApplicationException, init, initSubscribeClientFactory, isAvailable, isAvailable, loadContentTypes, lookupMetadataTransformer, maskId, query, query, refresh, retrieveResource, setAvailabilityTask, setConfigurationPid, setConnectionTimeout, setContext, setCoordinateOrder, setCsw201, setCswTransformConverter, setCswUrl, setDisableCnCheck, setEventServiceAddress, setFilterAdapter, setFilterBuilder, setFilterDelegate, setForceSpatialFilter, setId, setIsCqlForced, setMetacardMappings, setMetacardTypes, setOutputSchema, setPassword, setPollInterval, setQueryTypeName, setQueryTypeNamespace, setReceiveTimeout, setRegisterForEvents, setResourceReader, setSecurityManager, setupAvailabilityPoll, setUsePosList, setUsername, transform

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

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

getContentTypes, getSecurityAttributes, isAvailable, isAvailable, query

Methods inherited from interface ddf.catalog.resource.ResourceReader

getOptions, getSupportedSchemes, retrieveResource

Methods inherited from interface ddf.catalog.util.Describable

getDescription, getId, getOrganization, getTitle, getVersion

Field Detail

schemaTransformerManager

protected TransformerManager schemaTransformerManager

cswTransactionWriter

protected javax.ws.rs.ext.MessageBodyWriter<CswTransactionRequest> cswTransactionWriter

Constructor Detail

AbstractCswStore

public AbstractCswStore(org.osgi.framework.BundleContext context,
                        CswSourceConfiguration cswSourceConfiguration,
                        com.thoughtworks.xstream.converters.Converter provider,
                        SecureCxfClientFactory factory,
                        EncryptionService encryptionService)

Instantiates a CswStore. This constructor is for unit tests

Parameters:

context - The BundleContext from the OSGi Framework

cswSourceConfiguration - the configuration of this source

provider - transform provider to transform results

factory - client factory already configured for this source

AbstractCswStore

public AbstractCswStore(EncryptionService encryptionService)

Instantiates a CswStore.

Method Detail

create

public CreateResponse create(CreateRequest createRequest)
                      throws IngestException

Description copied from interface: CatalogStore

Publishes a list of Metacard objects into the catalog.

Specified by:

create in interface CatalogStore

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

update

public UpdateResponse update(UpdateRequest updateRequest)
                      throws IngestException

Description copied from interface: CatalogStore

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

Specified by:

update in interface CatalogStore

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

delete

public DeleteResponse delete(DeleteRequest deleteRequest)
                      throws IngestException

Description copied from interface: CatalogStore

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

Specified by:

delete in interface CatalogStore

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

initProviders

protected List<? extends Object> initProviders(com.thoughtworks.xstream.converters.Converter cswTransformProvider,
                                               CswSourceConfiguration cswSourceConfiguration)

Overrides:

initProviders in class AbstractCswSource

setSchemaTransformerManager

public void setSchemaTransformerManager(TransformerManager schemaTransformerManager)

getCswTransactionWriter

public javax.ws.rs.ext.MessageBodyWriter<CswTransactionRequest> getCswTransactionWriter()

setCswTransactionWriter

public void setCswTransactionWriter(javax.ws.rs.ext.MessageBodyWriter<CswTransactionRequest> cswTransactionWriter)

validateOperation

protected void validateOperation()