com.adobe.forms.foundation.migration.api.TaskContext Maven / Gradle / Ivy

Go to download
/*************************************************************************
 *
 * ADOBE CONFIDENTIAL
 * __________________
 *
 *  Copyright 2016 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.migration.api;

import aQute.bnd.annotation.ProviderType;
import com.adobe.forms.foundation.transfer.AssetScanInfo;
import org.apache.sling.api.resource.ResourceResolver;

import java.util.List;

/**
 * Context for each migration task
 */
@ProviderType
public interface TaskContext  {
    /**
     * Resource on which migration is to be run
     * Resource can be anything nt:file, nt:folder etc.
     * @return
     */
    String getPath();

    ResourceResolver getResourceResolver();

    /**
     * Provide progress info for migration
     * @param msg
     */
    void info(String msg, Object ... param);

    /**
     * Provide user friendly error msg
     * @param msg
     */
    void error(String msg, Object ... param);

    /**
     * Provide success message if successfully
     * commited a migration
     * @return
     */
    void success(String msg, Object ... param);

    /**
     * Provide warn message
     * @return
     */
    void warn(String msg, Object ... param);

    /**
     * Get arbitrary attribute from the ctx
     * @return
     */
     Object getAttribute(String key);

    /**
     * Set arbitrary Attribute
     * @param key
     * @param value
     */
     void setAttribute(String key, Object value);

    /**
     * Current Selector
     */
    String [] getSelectors();

    /**
     * returns array of child context
     */
    List getChildContexts();

    /**
     * Adding scan report into context.
     * @param assetScanInfo
     */
    void addAssetScanInfo(AssetScanInfo assetScanInfo);
}