Page History

...

• Javadoc resource link
  0 info.magnolia.dam.api.AssetProviderRegistry className info.magnolia.dam.api.AssetProviderRegistry renderType asynchronous

  is the main entry point. Given an ItemKey or MediaType it is responsible for:
  
  • Finding the correct AssetProvider.
  • Finding the correct AssetRenderer.

• Javadoc resource link
  0 info.magnolia.dam.api.AssetProvider className info.magnolia.dam.api.AssetProvider renderType asynchronous

  : Exposes Folders and Assets from a particular source. Specifics of the storage of these items are left to implementations. While most provider implementations only use the ItemKey.assetId field of keys passed to the various get methods, the entire key object is passed for consistency and flexibility. This makes it possible to implement, for example, delegating and aggregating providers.

• Javadoc resource link
  0 info.magnolia.dam.api.PathAwareAssetProvider className info.magnolia.dam.api.PathAwareAssetProvider renderType asynchronous

  : Exposes specific operations for AssetProviders that are aware of paths, for example JCR, CMIS, File system etc. Not all providers need or want to implement these features. The term "path" here should be taken "with a pinch of salt". It could, for example, be a single name or a "relative" path if the provider serves assets from a subset of its underlying data source.

• Javadoc resource link
  0 info.magnolia.dam.api.AssetRenderer className info.magnolia.dam.api.AssetRenderer renderType asynchronous

  : Provides AssetRenditions by bridging an asset's data and some type of converter. AssetRenderers can be provided by AssetProviders if the AssetProvider itself (or the underlying system) is capable of managing the conversion/translation, or via a "global" registry. AssetProviderRegistry.getRendererFor(info.magnolia.dam.api.Asset, com.google.common.net.MediaType) provides the entry point. It looks up in provider, then in its own registry, and bridges to other possible conversion mechanisms that are independent of Magnolia DAM.

• Javadoc resource link
  0 info.magnolia.dam.api.Asset className info.magnolia.dam.api.Asset renderType asynchronous

  : An Asset is a digital resource with associated metadata.

• Javadoc resource link
  0 info.magnolia.dam.api.Folder className info.magnolia.dam.api.Folder renderType asynchronous

  : A Folder represents a structural item holding Assets. Depending on the provider, this can be directly mapped to the concept of folders/directories (JCR, FileSystems etc.), and for other types it may map to the concept of albums, playlists, sets, etc.

• Javadoc resource link
  0 info.magnolia.dam.api.Item className info.magnolia.dam.api.Item renderType asynchronous

  : Defines a common interface for Asset and Folder. 

• Javadoc resource link
  0 info.magnolia.dam.api.AssetQuery className info.magnolia.dam.api.AssetQuery renderType asynchronous

  : Represents a query to an AssetProvider. Use new AssetQuery.Builder()...build() to construct instances. 

• Javadoc resource link
  0 info.magnolia.dam.api.AssetRendition className info.magnolia.dam.api.AssetRendition renderType asynchronous

  : An AssetRendition is a "view" on a asset for a specific MediaType . It can be a simple resize of an image, or a document conversion.

...

The DAM JCR API classes reside in the DAM JCR module and implement the DAM API for JCR assets that are stored in the dam workspace and accessible in the Assets app <link>.

JCR classes

• Javadoc resource link
  0 info.magnolia.dam.jcr.JcrAssetProvider className info.magnolia.dam.jcr.JcrAssetProvider renderType asynchronous

  : AssetProvider that delivers assets for the dam workspace. Extends AbstractAssetProvider and implements PathAwareAssetProvider. 

• Javadoc resource link
  0 info.magnolia.dam.jcr.AbstractJcrItem className info.magnolia.dam.jcr.AbstractJcrItem renderType asynchronous

  : JCR implementation of an Item. Extends AbstractItem<JcrAssetProvider>. 

• Javadoc resource link
  0 info.magnolia.dam.jcr.JcrAsset className info.magnolia.dam.jcr.JcrAsset renderType asynchronous

  : JCR implementation of the Asset definition. Extends AbstractJcrItem.

• Javadoc resource link
  0 info.magnolia.dam.jcr.JcrFolder className info.magnolia.dam.jcr.JcrFolder renderType asynchronous

  : JCR implementation of the Folder definition. Extends AbstractJcrItem.

• Javadoc resource link
  0 info.magnolia.dam.jcr.AssetNodeTypes className info.magnolia.dam.jcr.AssetNodeTypes renderType asynchronous

  : Constants and convenience methods for asset node types.
  
  • Asset: Represents the node type mgnl:asset. Fields: caption, comment, copyright, description, language, master, name, provider_type, subject, title, type.
  • AssetResource: Represent the resource node bound to an Asset. Fields: data, extension, filename, height, mimetype, name, ressource_name, size, width.

• Javadoc resource link
  0 info.magnolia.dam.jcr.JcrItemNodeTypePredicate className info.magnolia.dam.jcr.JcrItemNodeTypePredicate renderType asynchronous

  : Predicate filtering assets nodes (folders and assets) based on the following Node.getPrimaryNodeType():
  
  • AssetNodeTypes.Asset.NAME
  • NodeTypes.Folder#NAME.

Extends info.magnolia.jcr.predicate.AbstractPredicate<javax.jcr.Node>.

• Javadoc resource link
  0 info.magnolia.dam.jcr.DamConstants className info.magnolia.dam.jcr.DamConstants renderType asynchronous

  : Defines commonly used constants for the DAM.JCR module. Fields: default_jcr_provider_id, workspace.

...

/**
    * JcrAsset specific implementation that lets you access a property value linked to an asset node.
    * This requires an open session.
        * 
       * @return property value Object if the property exists or null otherwise.
       */

    public Object getProperty(String propertyName) {
        return PropertyUtil.getPropertyValueObject(getNode(), propertyName);

JCR metadata classes

• Javadoc resource link
  0 info.magnolia.dam.jcr.metadata.JcrDublinCore className info.magnolia.dam.jcr.metadata.JcrDublinCore renderType asynchronous

  : JCR implementation of DublinCore. Fields: dc_contributor, dc_coverage, dc_creator, dc_publisher, dc_relation, dc_source, dc_subject, dc_type. Methods: getContributor,  getCoverage, getCreated, getCreator, getDate, getDescription, getFormat, getIdentifier, getLanguage, getModified , getPublisher, getRelation, getRights, getSource, getSubject, getTitle, getType.

• Javadoc resource link
  0 info.magnolia.dam.jcr.metadata.JcrMagnoliaAssetMetadata className info.magnolia.dam.jcr.metadata.JcrMagnoliaAssetMetadata renderType asynchronous

  : Base JCR implementation of the MagnoliaAssetMetadata definition. Methods: getHeight, getWidth

...