io.neba.api.spi.ResourceModelPostProcessor Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of io.neba.neba-api Show documentation

Contains all annotations, tag libraries and lifecycle callback interfaces of NEBA. All packages of this API bundle are exported. Change to the API that are not byte code compatible only occur in major revisions.

There is a newer version: 5.2.3

Show newest version

/*
  Copyright 2013 the original author or authors.
  
  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.
 */

package io.neba.api.spi;

import org.apache.sling.api.resource.Resource;

import javax.annotation.CheckForNull;
import javax.annotation.Nonnull;

/**
 * Lifecycle callback for
 * {@link io.neba.api.annotations.ResourceModel resource models}.
 * 

 * {@link #processAfterMapping(Object, Resource, ResourceModelFactory)} is invoked after
 * the model was created and injected and all
 * resource properties are mapped. All lifecycle callbacks where already
 * called at this point.
 * 
 * OSGi services providing this interface are automatically detected by the core
 * and are applied to all resource models. There are no guarantees concerning the
 * order in which these post processors are invoked. If a specific order is
 * required, implementing a {@link ResourceModelPostProcessor} that delegates to
 * other post processors in the desired order is advised.
 *
 * @author Olaf Otto
 * @since 1.0.0
 */
public interface ResourceModelPostProcessor {
    /**
     * Lifecycle callback invoked after the resource properties are mapped onto
     * the {@link io.neba.api.annotations.ResourceModel}.
     *
     * @param resourceModel is never null.
     * @param resource      is never null.
     * @param factory       is never null.
     * @return a new resource model overriding the provided resourceModel, or
     * null if the resource model is not to be changed.
     */
    @CheckForNull
     T processAfterMapping(@Nonnull T resourceModel, @Nonnull Resource resource, @Nonnull ResourceModelFactory factory);
}