Context.java

package org.intellimate.izou.system;

import org.apache.logging.log4j.spi.ExtendedLogger;
import org.intellimate.izou.security.storage.SecureStorage;
import org.intellimate.izou.security.storage.SecureStorageImpl;
import org.intellimate.izou.system.context.*;
import org.intellimate.izou.system.context.System;
import ro.fortsoft.pf4j.AddonAccessible;

/**
 * The Izou context is a means for all addOns to get general information they might need. Every addOn its own context
 * and can use it to reach certain Izou components. It controls what an addOn has access to and what it does not have
 * access to.
 * <br>
 * For instance, the addOn should have access to a logger (created in Izou for the addOn), but it should not have
 * access to classes like the AddOnManager, which loads all addOns at the start. Hence the logger is included in the
 * context, but the addOn manager is not. Anything that is not included in the context, and addOn does not have access to.
 * So in short, the context exists to give addOns access to higher Izou components while still denying access to other
 * components.
 */
@AddonAccessible
public interface Context {
    /**
     * Returns the API used for interaction with Events.
     *
     * @return Events
     */
    Events getEvents();

    /**
     * Returns the API used for interaction with Resource.
     *
     * @return Resource
     */
    Resources getResources();

    /**
     * Returns the API used for interaction with Files.
     *
     * @return Files
     */
    Files getFiles();

    /**
     * Returns the API used to log.
     *
     * @return Logger
     */
    ExtendedLogger getLogger();

    /**
     * Returns the API used to manage the ThreadPool.
     *
     * @return ThreadPool
     */
    ThreadPool getThreadPool();

    /**
     * Returns the API to manage the Activators.
     *
     * @return Activator
     */
    Activators getActivators();

    /**
     * Returns the API used to manage the OutputPlugins, OutputExtensions and OutputControllers.
     *
     * @return Output
     */
    Output getOutput();

    /**
     * Retruns the API used to interact with Izou.
     *
     * @return System.
     */
    System getSystem();

    /**
     * Gets the API to manage the addOns.
     *
     * @return AddOns.
     */
    AddOns getAddOns();

    /**
     * Gets the Secure Storage object of Izou. {@link SecureStorageImpl} allows addOns to safely store data so that other
     * addOns cannot access it. However while the data is encrypted, there is no guarantee that the end user cannot
     * decrypt the data and access it. So be careful to not store any sensitive information here
     *
     * @return the Secure Storage object of Izou
     */
    static SecureStorage getSecureStorage() {
        return SecureStorageImpl.getInstance();
    }
}