com.day.cq.replication.ConfigManager Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of aem-sdk-api Show documentation

The Adobe Experience Manager SDK

There is a newer version: 2024.11.18751.20241128T090041Z-241100

/*************************************************************************
 * ADOBE CONFIDENTIAL
 * ___________________
 *
 * Copyright 2011 Adobe
 * All Rights Reserved.
 *
 * NOTICE: All information contained herein is, and remains
 * the property of Adobe and its suppliers, if any. The intellectual
 * and technical concepts contained herein are proprietary to Adobe
 * and its suppliers and are protected by all applicable intellectual
 * property laws, including trade secret and copyright laws.
 * Dissemination of this information or reproduction of this material
 * is strictly forbidden unless prior written permission is obtained
 * from Adobe.
 **************************************************************************/

package com.day.cq.replication;

import java.util.Map;

/**
 * ConfigManager...
 */
public interface ConfigManager {

    /**
     * Returns a map of all agent configuration groups.
     * @return a map where the key is the configuration group path
     */
    Map getConfigGroups();

    /**
     * Returns a map of all agent configurations of all run modes.
     * @return a map where the key is the configuration id
     */
    Map getConfigurations();


    /**
     * Registers a listener to receive configuration event changes
     * @param listener the listener
     */
    void registerListener(ConfigEventListener listener);

    /**
     * Unregisters a previously registered listener.
     * @param listener the listener
     */
    void unregisterListener(ConfigEventListener listener);

    /**
     * Interface for configuration event listeners.
     */
    interface ConfigEventListener {

        /**
         * Invoked when a configuration event happened.
         * @param evt the event
         */
        void onConfigEvent(ConfigEvent evt);

    }

    /**
     * Interface for configuration event
     */
    interface ConfigEvent {

        /**
         * The event type
         */
        enum Type {

            /**
             * A new configuration was added
             */
            ADDED,

            /**
             * A configuration was updated
             */
            UPDATED,

            /**
             * A configuration was removed
             */
            REMOVED
        }

        /**
         * Returns the event type
         * @return the type
         */
        Type getType();

        /**
         * Returns the id of the configuration that changed
         * @return the id.
         */
        String getId();
    }

}