All Classes and Interfaces

Class	Description
AccessPlugin	An AccessPlugin allows or denies access to the Catalog operation or response.
ArgumentBuilder	This code is experimental.
Associations	This code is experimental.
Attribute	An instance of an AttributeType.
AttributeBuilder	Starts the fluent API to create Filter based on a particular Attribute
AttributeDescriptor	AttributeDescriptor describes an Attribute and associates it with a AttributeType
AttributeInjector	Manages InjectableAttribute services and injects the appropriate AttributeDescriptors into MetacardTypes and into Metacards.
AttributeRegistry	Manages registered attribute types.
AttributeType<T extends Serializable>	The type of an Attribute, indicating the Class
AttributeType.AttributeFormat	Enumeration used to indicate formats of Attributes.
AttributeValidationReport	Describes the outcome of validating a single metacard attribute.
AttributeValidator	A service that validates a single Metacard attribute and provides information if problems exist with the attribute's value.
AttributeValidatorRegistry	Manages registered attribute validators.
BinaryContent	BinaryContent is used to return a format that has been transformed by a Transformer.
BufferedSpatialExpressionBuilder	Continues the fluent API to create a Spatial Filter.
CatalogEndpoint	CatalogEndpoint represents an endpoint that accesses the catalog and wants to advertise itself to the system.
CatalogFramework	The CatalogFramework functions as the routing mechanism between all catalog components.
CatalogProvider	External facing (outside of CatalogFramework) API used to interact with providers of data such as a file system or database.
CatalogStore	This code is experimental.
CatalogTransformerException	The exception thrown when problems transforming a QueryResponse are detected.
ConfiguredService	Describes a service that is created via ConfigurationAdmin.
ConnectedSource	Provides an implementation of Source that represents a remote that is always included in every local and enterprise Query processed.
Constants	The Constants class is used to capture key values that can be re-used throughout DDF.
Contact	This code is experimental.
ContentItem	ContentItem is the POJO representing the information about the content to be stored in the StorageProvider.
ContentMetadataExtractor	Parses content, extracting metadata and adding it to the provided card.
ContentType	Used to return the type and version of the content that is currently stored in a Source.
ContextualExpressionBuilder	Completes building a Filter based on Contextual relevance
Core	This code is experimental.
CreateRequest	Defines a Create Request Object which can be sent to the CatalogFramework.create
CreateResponse	CreateResponse contains response information that should ber returned on a CreateRequest operation.
CreateStorageRequest	Request to store content that is accessible by querying Metacards
CreateStorageResponse	Response associated with creating content associated with a Metacard
DataType	These are the allowed values for the attribute Core#DATATYPE.
DataUsageLimitExceededException	Custom exception class for the Data Usage Plugin that is thrown when a user exceeds their daily data usage limit.
DateTime	This code is experimental.
DefaultAttributeValueRegistry	Manages default attribute values that apply to all metacard types and default attribute values that apply to specific metacard types.
DeleteRequest	A request to delete Metacards from the CatalogProvider
DeleteResponse	The Interface DeleteResponse contains the response information on a DeleteRequest
DeleteStorageRequest	Request to remove content associated with a Metacard
DeleteStorageResponse	Response that holds the @{link List} of deleted ContentItems
DeliveryException	The exception thrown when problems are detected during the delivery of a created, updated, or deleted event.
DeliveryMethod	The DeliveryMethod provides the operation (created, updated, deleted) of how a Metacard can be delivered.
Describable	Deprecated. see Describable
EqualityExpressionBuilder	Completes the fluent API to create a PropertyIsEqualTo Filter .
EventException	The exception thrown to capture problems during the PubSub operations create, update, and delete of subscriptions.
EventProcessor	This interface is used to describe: a method of creating, updating, and deleting subscriptions.
ExpressionBuilder	Continues the fluent API to create Filter based on a particular Attribute
Extracted
FacetAttributeResult	FacetAttributeResult representing a portion of the results of a faceted query.
FacetValueCount	A value and count pairing of a facet response.
Federatable	Interface describing an object that can be federated with other Sources
FederatedSource	Provides an implementation of Source that represents a remote that can be optionally included in federated Query implementations.
FederationException	This exception should be thrown when general federation issues arise.
FederationStrategy	Implementations of this interface federate the specified query to all the Sources in the list, process the Results in a unique way, and then return the results to the client.
FilterAdapter	FilterAdapter visits a Filter and invokes FilterDelegate methods with normalized, typed values.
FilterBuilder	Service interface with which implementations will register in the OSGi Registry for use by components needing to build Filters in an easy way without a dependence on a particular Filter implementation.
FilterDelegate<T>	* FilterDelegate is the target delegate of the FilterAdapter.
FilterResult	Result of performing filtering on a Metacard or Response.
FilterStrategy	A strategy for filtering a Metacard.
Highlight	A Highlight represents a specific range of characters in an attribute that matched a query.
HistorianConfiguration	This interface is used to determine if history has been enabled.
IngestException	The Class IngestException is thrown by a CatalogProvider when an error occurs on an operation.
InjectableAttribute	Describes an 'injectable' attribute (i.e., an AttributeDescriptor that should be injected into specific MetacardTypes or into all MetacardTypes).
InputCollectionTransformer	The InputCollectionTransformer is used to transform an InputStream into a list of Metacards.
InputTransformer	An InputTransformer has the purpose of creating a Metacard from a given InputStream.
InternalIngestException	Ingest exception that should spawn a 5xx error back to the client.
InvalidSubscriptionException	The exception thrown when problems creating a subscription are detected due to invalid data in the Subscription, such as a missing DeliveryMethod.
Location	This code is experimental.
Maskable	Used to specify an item whose ID is to be masked when it reports its ID externally, e.g., in a query response.
Media	This code is experimental.
Metacard	A Metacard is a container for Metadata.
MetacardCreationException	The exception thrown when problems are detected during the creation of a Metacard.
MetacardTransformer	The MetacardTransfomer is used to transform a Metacard to a provided BinaryContent.
MetacardType	This class describes the set of attributes a Metacard can contain.
MetacardTypeRegistry	Registry to maintain MetacardTypes that are supported by the system's Endpoints and Sources.
MetacardTypeUnregistrationException
MetacardValidationReport	Describes the outcome of validating a single Metacard.
MetacardValidator	A service that validates a Metacard and provides information if problems exist with the Metacard data.
MetadataExtractor	Enrich metacard using provided input.
NumericalExpressionBuilder	Completes the fluent API to create Filter based on a numerical value.
NumericalRangeExpressionBuilder
OAuthFederatedSource
OAuthPluginException	Exception thrown when an user doesn't have the appropriate OAuth tokens to federate
OAuthPluginException.ErrorType
Operation
OperationTransaction	Interface describing an operation transaction for the catalog.
OperationTransaction.OperationType	Operation transaction type
Pingable
PluginExecutionException	The PluginExecutionException is used to signal errors during service operations.
PolicyPlugin	A PolicyPlugin is used to build policy information regarding the Catalog action a user is attempting.
PolicyResponse	Response from PolicyPlugin containing policy information for Operation and individual items, such as Metacard or Result
PostCreateStoragePlugin	Services implementing this interface are called immediately after an item is created in the content repository.
PostFederatedQueryPlugin	A PostFederatedQueryPlugin is used to execute functionality after a federated query has been executed.
PostIngestPlugin	Marker interface for services that wish to be called after any CreateResponse, UpdateResponse, or DeleteResponse is about to be returned to an endpoint.
PostQueryPlugin	A PostQueryPlugin is used to execute functionality after a query has been executed.
PostResourcePlugin	The PostResourcePlugin is executed after a getResource operation has completed.
PostUpdateStoragePlugin	Services implementing this interface are called immediately after an item is updated in the content repository.
PreAuthorizationPlugin	The PreAuthorizationPlugin extension point allows for request/response processing before any security rules (policy and access) are implemented at the beginning of the plugin chain.
PreCreateStoragePlugin	Services implementing this interface are called immediately before an item is created in the content repository.
PreDeliveryPlugin	The PreDeliveryPlugin is executed prior to an event being delivered.
PreFederatedLocalProviderQueryPlugin	The PreFederatedLocalProviderQueryPlugin is an abstract class implementing the PreFederatedQueryPlugin.
PreFederatedQueryPlugin	A PreFederatedQueryPlugin is used to execute functionality before a federated query has been executed.
PreIngestPlugin	Executes business logic prior to an ingest operation executing.
PreQueryPlugin	A PreQueryPlugin is used to execute functionality after a query has been executed.
PreResourcePlugin	The PreResourcePlugin executes prior to the getResource operation.
PreSubscriptionPlugin	The Interface PreSubscriptionPlugin provides the capability to execute a plugin prior to a Subscription being created.
PreUpdateStoragePlugin	Services implementing this interface are called immediately before an item is updated in the content repository.
ProcessingDetails
QualifiedMetacardType	Qualified and uniquely identified set of AttributeDescriptors used to specify and describe the valid Attributes on a Metacard.
Query	A Query contains the basic aspects of executing a search.
QueryFilterTransformer	Transforms a QueryRequest containing external attribute names & values into a normalized taxonomy QueryRequest.
QueryFilterTransformerProvider	Provider interface to obtain the appropriate QueryFilterTransformer given qName or typeName
QueryRequest
QueryResponse
QueryResponseTransformer	The QueryResponseTransformer is used to transform a list of Result objects from a SourceResponse.
QueryValidationViolation	Describes a violation of a constraint on query.
QueryValidationViolation.Severity	Describes the severity of a validation violation.
QueryValidator	A QueryRequest may be structurally valid but be semantically incorrect.
ReadStorageRequest	Request to retrieve a file product associated with a Metacard
ReadStorageResponse	Response that contains the ContentItem that was specified in the request URI
RemoteSource	The Interface RemoteSource is used to represent a remote Source.
ReportingMetacardValidator	Validates a Metacard and provides information via a report if problems exist with the Metacard's data.
Request	Marker interface to differentiate Requests from Responses.
RequiredAttributes	List of required attributes for a metacard type.
RequiredAttributesRegistry	Manages required attribute values, which correspond to specific metacard types.
Resource	A Resource represents an item (e.g. image, video, document, etc.) that has been posted for sharing.
ResourceNotFoundException	ResourceNotFoundException is thrown when a ResourceReader is unable to find a Resource.
ResourceNotSupportedException	The ResourceNotSupportedException is thrown by a ResourceReader or CatalogFramework when they do not support a Resource or ResourceRequest.
ResourceReader	A ResourceReader is used to obtain a Resource.
ResourceRequest
ResourceResponse
ResourceWriter	The ResourceWriter is used to store a Resource.
Response<T extends Request>
Result	The Result is used to supplement Metacard fields when a Metacard is returned from a query.
ResultAttributeHighlight	ResultAttributeHighlight represents a specific attribute that matched a query and provides indications of what the specific data the query matched on via a list of highlights.
ResultHighlight	ResultHighlight represents a list of attributes that matched a given query for a particular result as identified by the ID returned from the getResultId method.
Security	This code is experimental.
Source	The Source is used to represent a system that has Metacards in a catalog.
SourceAttributeRestriction	Any Source can optionally implement this interface to provide a set of attributes that it supports querying on.
SourceCache	Used by PostFederatedQueryPlugin and PreFederatedQueryPlugin to determine if a source is the cache.
SourceDescriptor	The Interface SourceDescriptor is used to describe a Source.
SourceInfoRequest	The SourceInfoRequest represents a request to obtain Source information.
SourceInfoResponse	The SourceInfoResponse is used to return Source information on an operation.
SourceMonitor	The Interface SourceMonitor is used as a callback object when the availability of a Source changes.
SourcePlugin	Provides a plugin point for manipulating the framework source responses for getSourceIds and getSourceInfo methods
SourceProcessingDetails	The Interface SourceProcessingDetails is intended to capture the processing details (e.g.
SourceResponse	Query status should come back in the properties.
SourceUnavailableException	This exception should be thrown on a Source-related operation when the source is unavailable.
SourceWarningsFilter	This code is experimental.
SpatialExpressionBuilder	Complete the fluent API to build a spatial Filter
StopProcessingException	Exception representing a situation where a Catalog Plugin has executed successfully but will not allow an operation to continue.
StorageException	Exception thrown when a StorageProvider encounters problems during its execution of CRUD operations.
StorageProvider	Provider of content repository storage.
StorageRequest	Base request interface for storage operations.
StorageResponse<T extends Request>	Base response interface for storage operations.
Subscriber	A Subscriber is used to identify a service that is capable of deleting subscriptions.
Subscription	A Subscription is used for a "subscriber" to subscribe to events based on a particular type of filter.
SubscriptionExistsException	The exception thrown when problems creating a subscription are detected due to a Subscription with the same ID already existing in the OSGi registry.
SubscriptionNotFoundException	The exception thrown when problems updating or deleting a subscription are detected due to the Subscription not being found in the OSGi registry.
TemporalInstantExpressionBuilder	Completes the fluent API to build a temporal Filter using an instant in time (vs a bounded range)
TemporalRangeExpressionBuilder	Finishes the fluent API to create a Temporal Range Filter
TermFacetProperties	TermFacetPropertiesImpl object using the supplied parameters to facet on the provided attributes, returning results sorted by the provided key.
TermFacetProperties.SortFacetsBy
Topic	This code is experimental.
UnsupportedQueryException	UnsupportedQueryException is thrown by a Source when it cannot support a provided QueryRequest
Update	Represents an update of a single Metacard, which has an older (previous) version and a new (current) version.
UpdateRequest	Interface representing a request to update a Metacard.
UpdateResponse	Further specification of Response for an Update request.
UpdateStorageRequest	Request to update the file associated with a Metacard
UpdateStorageResponse	Response containing the updated ContentItems
Validation	This code is experimental.
ValidationException	Thrown to indicate that a validation operation could not be completed.
ValidationViolation	Describes a violation of a constraint on an attribute or metacard.
ValidationViolation.Severity	Describes the severity of a validation violation.
Version	This code is experimental.
XPathBasicBuilder	Builds XPath-based Contextual Filters.
XPathBuilder	Builds XPath Filters