io.wcm.handler.media.ui.ResourceMedia.java Source code

Introduction

Here is the source code for io.wcm.handler.media.ui.ResourceMedia.java

Source

/*
 * #%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.media.ui;

import javax.annotation.PostConstruct;

import org.apache.commons.lang3.StringUtils;
import org.apache.sling.api.SlingHttpServletRequest;
import org.apache.sling.api.resource.Resource;
import org.apache.sling.models.annotations.Model;
import org.apache.sling.models.annotations.injectorspecific.RequestAttribute;
import org.apache.sling.models.annotations.injectorspecific.Self;
import org.apache.sling.models.annotations.injectorspecific.SlingObject;

import io.wcm.handler.media.Media;
import io.wcm.handler.media.MediaBuilder;
import io.wcm.handler.media.MediaHandler;

/**
 * Generic resource-based media model.
 * <p>
 * Optional use parameters when referencing model from Sightly template:
 * </p>
 * <ul>
 * <li><code>mediaFormat</code>: Media format name to restrict the allowed media items</li>
 * <li><code>cssClass</code>: CSS classes to be applied on the generated media element (most cases img element)</li>
 * </ul>
 */
@Model(adaptables = SlingHttpServletRequest.class)
public class ResourceMedia {

    @RequestAttribute(optional = true)
    private String mediaFormat;

    @RequestAttribute(optional = true)
    private String cssClass;

    @Self
    private MediaHandler mediaHandler;
    @SlingObject
    private Resource resource;

    private Media media;

    @PostConstruct
    private void activate() {
        MediaBuilder builder = mediaHandler.get(resource);

        if (StringUtils.isNotEmpty(mediaFormat)) {
            builder.mediaFormatName(mediaFormat);
        }

        media = builder.build();

        if (media.isValid() && StringUtils.isNotEmpty(cssClass)) {
            media.getElement().addCssClass(cssClass);
        }
    }

    /**
     * Returns a {@link Media} object with the metadata of the resolved media.
     * Result is never null, check for validness with the {@link Media#isValid()} method.
     * @return Media
     */
    public Media getMetadata() {
        return media;
    }

    /**
     * Returns true if the media was resolved successful.
     * @return Media is valid
     */
    public boolean isValid() {
        return media.isValid();
    }

    /**
     * Returns the XHTML markup for the resolved media object.
     * This is in most cases an img element, but may also contain other arbitrary markup.
     * @return Media markup
     */
    public String getMarkup() {
        return media.getMarkup();
    }

}