io.wcm.handler.mediasource.dam.impl.DamAsset Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of io.wcm.handler.media Show documentation
Media resolving, processing and markup generation.
There is a newer version: 2.3.0
/*
 * #%L
 * wcm.io
 * %%
 * Copyright (C) 2014 wcm.io
 * %%
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 * #L%
 */
package io.wcm.handler.mediasource.dam.impl;

import io.wcm.handler.media.Asset;
import io.wcm.handler.media.CropDimension;
import io.wcm.handler.media.Media;
import io.wcm.handler.media.MediaArgs;
import io.wcm.handler.media.Rendition;

import org.apache.commons.lang3.StringUtils;
import org.apache.sling.api.adapter.Adaptable;
import org.apache.sling.api.adapter.SlingAdaptable;
import org.apache.sling.api.resource.Resource;
import org.apache.sling.api.resource.ValueMap;
import org.apache.sling.api.wrappers.ValueMapDecorator;

import com.day.cq.dam.api.DamConstants;

/**
 * {@link Asset} implementation for DAM assets.
 */
public final class DamAsset extends SlingAdaptable implements Asset {

  private final Adaptable adaptable;
  private final com.day.cq.dam.api.Asset damAsset;
  private final CropDimension cropDimension;
  private final MediaArgs defaultMediaArgs;
  private final ValueMap properties;

  /**
   * @param damAsset DAM asset
   * @param media Media metadata
   */
  public DamAsset(com.day.cq.dam.api.Asset damAsset, Media media, Adaptable adaptable) {
    this.damAsset = damAsset;
    this.cropDimension = media.getCropDimension();
    this.defaultMediaArgs = media.getMediaRequest().getMediaArgs();
    this.properties = new ValueMapDecorator(damAsset.getMetadata());
    this.adaptable = adaptable;
  }

  @Override
  public String getTitle() {
    // default title is the asset name
    String title = this.damAsset.getName();

    Object titleObj = this.properties.get(DamConstants.DC_TITLE);
    if (titleObj != null) {
      // it might happen that the adobe xmp lib creates an array, e.g. if the asset file already has a title attribute
      if (titleObj instanceof Object[]) {
        Object[] titleArray = (Object[])titleObj;
        if (titleArray.length > 0) {
          title = StringUtils.defaultString(titleArray[0].toString(), title);
        }
      }
      else {
        title = titleObj.toString();
      }
    }

    return title;
  }

  @Override
  public String getAltText() {
    return StringUtils.defaultString(this.defaultMediaArgs.getAltText(), getTitle());
  }

  @Override
  public String getDescription() {
    return this.properties.get(DamConstants.DC_DESCRIPTION, String.class);
  }

  @Override
  public String getPath() {
    return this.damAsset.getPath();
  }

  @Override
  public ValueMap getProperties() {
    return this.properties;
  }

  @Override
  public Rendition getDefaultRendition() {
    return getRendition(this.defaultMediaArgs);
  }

  @Override
  public Rendition getRendition(MediaArgs mediaArgs) {
    Rendition rendition = getDamRendition(mediaArgs);

    // check if rendition is valid - otherwise return null
    if (StringUtils.isEmpty(rendition.getUrl())) {
      rendition = null;
    }

    return rendition;
  }

  @Override
  public Rendition getImageRendition(MediaArgs mediaArgs) {
    Rendition rendition = getRendition(mediaArgs);
    if (rendition != null && rendition.isImage()) {
      return rendition;
    }
    else {
      return null;
    }
  }

  @Override
  public Rendition getFlashRendition(MediaArgs mediaArgs) {
    Rendition rendition = getRendition(mediaArgs);
    if (rendition != null && rendition.isFlash()) {
      return rendition;
    }
    else {
      return null;
    }
  }

  @Override
  public Rendition getDownloadRendition(MediaArgs mediaArgs) {
    Rendition rendition = getRendition(mediaArgs);
    if (rendition != null && rendition.isDownload()) {
      return rendition;
    }
    else {
      return null;
    }
  }

  /**
   * Get DAM rendition instance.
   * @param mediaArgs Media args
   * @return DAM rendition instance (may be invalid rendition)
   */
  protected Rendition getDamRendition(MediaArgs mediaArgs) {
    return new DamRendition(this.damAsset, this.cropDimension, mediaArgs, adaptable);
  }

  @Override
  @SuppressWarnings("unchecked")
  public  AdapterType adaptTo(Class type) {
    if (type == com.day.cq.dam.api.Asset.class) {
      return (AdapterType)this.damAsset;
    }
    if (type == Resource.class) {
      return (AdapterType)this.damAsset.adaptTo(Resource.class);
    }
    return super.adaptTo(type);
  }

}