com.adobe.acs.commons.models.injectors.annotation.AemObject Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of acs-aem-commons-bundle Show documentation

Main ACS AEM Commons OSGi Bundle. Includes commons utilities.

There is a newer version: 6.9.4

Show newest version

/*
 * ACS AEM Commons
 *
 * Copyright (C) 2013 - 2023 Adobe
 *
 * 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 com.adobe.acs.commons.models.injectors.annotation;

import static java.lang.annotation.ElementType.FIELD;
import static java.lang.annotation.ElementType.METHOD;
import static java.lang.annotation.ElementType.PARAMETER;
import static java.lang.annotation.RetentionPolicy.RUNTIME;

import java.lang.annotation.Retention;
import java.lang.annotation.Target;

import org.apache.sling.models.annotations.Source;
import org.apache.sling.models.annotations.injectorspecific.InjectionStrategy;
import org.apache.sling.models.spi.injectorspecific.InjectAnnotation;

/**
 *
 * Sling Models Injector which injects the Adobe AEM objects defined in
 * <cq:defineObjects/>.
 * 
 * the following objects can be injected:
 * 

 *  resource the current resource
 * 
 resourceResolver the current resource resolver
 *
 * 
 componentContext component context of this request
 *
 * 
 pageManager page manager
 * 
 currentPage containing page addressed by the request
 * 
 resourcePage containing page of the addressed resource
 *
 * 
 designer the designer
 * 
 currentDesign design of the addressed resource
 * 
 resourceDesign design of the addressed resource
 *
 * 
 currentStyle style addressed by the request
 * 
 session the current session
 * 
 xssApi cross site scripting provider for the current request
 * 
 *
 * Note: This can only be used together with Sling Models API bundle in version 1.2.0
 */
@Target({ METHOD, FIELD, PARAMETER })
@Retention(RUNTIME)
@InjectAnnotation
@Source(AemObject.SOURCE)
public @interface AemObject {

    /**
     * Source value used for this annotation.
     * @see Source
     */
    String SOURCE = "define-objects";
    /**
     * if set to REQUIRED injection is mandatory, if set to OPTIONAL injection is optional, in case of DEFAULT
     * the standard annotations ({@link org.apache.sling.models.annotations.Optional}, {@link org.apache.sling.models.annotations.Required}) are used.
     * If even those are not available the default injection strategy defined on the {@link org.apache.sling.models.annotations.Model} applies.
     * Default value = DEFAULT.
     */
    InjectionStrategy injectionStrategy() default InjectionStrategy.DEFAULT;

}