io.wcm.handler.media.spi.MediaProcessor 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.media.spi;

import io.wcm.handler.media.Media;

import org.osgi.annotation.versioning.ConsumerType;

/**
 * Processes media metadata before or after media resolving.
 * 
 * This interface has to be implemented by a Sling Model class, optional with @Application annotation. The adaptables
 * should be {@link org.apache.sling.api.SlingHttpServletRequest} and {@link org.apache.sling.api.resource.Resource}.
 * 
 */
@ConsumerType
public interface MediaProcessor {

  /**
   * Process media metadata
   * @param media Media metadata
   * @return Processed media metadata (never null)
   */
  Media process(Media media);

}