Package info.magnolia.dam.api

Interface Summary

Interface	Description
Asset	An asset is a digital resource with associated metadata.
AssetProvider	An AssetProvider exposes Folders and Assets from a particular source.
AssetProviderRegistry	Entry point to retrieve AssetProviders.
AssetQuery	Represents a query to an AssetProvider.
AssetRenderer	An AssetRenderer provides AssetRenditions by bridging an Asset's data and some type of converter.
AssetRendition	An AssetRendition is a "view" on a asset, for a specific MimeType.
Folder	A Folder represents a structural item holding Assets.
Item	Defines a common interface for Asset and Folder.
PathAwareAssetProvider	Expose specific operations for AssetProviders which are aware of paths.
RenditionAwareAssetProvider	Expose specific operations for AssetProviders which are capable of generating renditions.

Class Summary

Class	Description
AbstractAssetProvider	Convenient abstract base class for implementations.
AbstractItem<T extends AssetProvider>	Common superclass for any dam Item.
AssetDecorator	TODO : do we need this ? If so, maybe call it AssetWrapper to be consistent.
AssetQuery.Builder	A builder for AssetQuery which provides a fluent API.
ItemKey	A "composite key": in the dam, every Asset and Folder are identified by its provider's ID and its provider-specific ID (i.e the ID with which the provider can uniquely identify the asset itself).

Enum Summary

Enum	Description
AssetProviderCapability	Features optional implemented/provided by AssetProvider.

Exception Summary

Exception	Description
AssetProvider.AssetNotFoundException	Thrown when the given ItemKey can't be found.
AssetProvider.IllegalItemKeyException	Thrown when the given ItemKey isn't usable by the provider.
AssetProviderRegistry.NoSuchAssetProviderException	Thrown when no AssetProvider can be found for the given ItemKey or String id.
AssetProviderRegistry.NoSuchAssetRendererException	Thrown when no AssetRenderer can be found for the given Asset to be converted to the given MediaType.
DamException	An abstract exception class that all DAM exceptions can extend.
PathAwareAssetProvider.PathNotFoundException	Thrown when no Item can be found at the given path.
RenditionAwareAssetProvider.AssetRenditionException	Thrown when rendition couldn't be generated.