com.adobe.forms.foundation.cloudconfig.ICloudConfigurationResourceProvider Maven / Gradle / Ivy

Go to download
/*************************************************************************
 *
 * ADOBE CONFIDENTIAL
 * ___________________
 *
 *  Copyright 2018 Adobe Systems Incorporated
 *  All Rights Reserved.
 *
 * NOTICE:  All information contained herein is, and remains
 * the property of Adobe Systems Incorporated and its suppliers,
 * if any.  The intellectual and technical concepts contained
 * herein are proprietary to Adobe Systems Incorporated and its
 * suppliers and are protected by trade secret or copyright law.
 * Dissemination of this information or reproduction of this material
 * is strictly forbidden unless prior written permission is obtained
 * from Adobe Systems Incorporated.
 **************************************************************************/
package com.adobe.forms.foundation.cloudconfig;

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

import javax.annotation.Nonnull;
import java.util.Iterator;

/**
 * Created by nitigupt on 1/10/2018.
 */

/**
 * Interface defining the generic cloud configuration provider for forms
 * @pad.exclude Excluded from published API
 * All interfaces and classes in cloud-config are internal
 */
public interface ICloudConfigurationResourceProvider {

    /**
     * Gives the iterator over Cloud Configuration resources from /conf, /libs, /apps and /etc/cloudservices
     * using fd-cloudservice user
     * @param groups   Array of strings denoting the group of cloudservice (eg. fdm, echosign, typekit, recaptcha)
     * @return An Iterator of {@link Resource} objects of cloud configurations
     */
    @Nonnull Iterator getAllCloudConfigs(@Nonnull ResourceResolver resourceResolver, @Nonnull String[]groups);
}