Application.java

/**
 * Copyright (c) 2013-2016, The SeedStack authors <http://seedstack.org>
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 */
package org.seedstack.seed;

import org.seedstack.coffig.Coffig;

import java.io.File;

/**
 * This class specifies an interface to the application global object which consists of:
 * <ul>
 * <li>The identity of the application (human readable name, unique identifier and instance identifier),</li>
 * <li>The application storage location,</li>
 * <li>The list of available environments,</li>
 * <li>The name of the current detected environment,</li>
 * <li>The current status of debug mode (enabled or disabled).</li>
 * </ul>
 */
public interface Application {
    /**
     * Get the full human-readable name of the application.
     *
     * @return The name of the application.
     */
    String getName();

    /**
     * Get the organization-wide unique identifier of the application.
     *
     * @return The identifier.
     */
    String getId();

    /**
     * Get the version of the application.
     *
     * @return The application version.
     */
    String getVersion();

    /**
     * Get the application storage location.
     *
     * @param context The storage context.
     * @return The file object denoting application storage directory.
     */
    File getStorageLocation(String context);

    /**
     * @return true if the local storage is enabled, false otherwise.
     */
    boolean isStorageEnabled();

    /**
     * Get the application configuration.
     *
     * @return the {@link Coffig} object of the whole application configuration.
     */
    Coffig getConfiguration();

    /**
     * Get the configuration properties of the specified class.
     *
     * @param aClass the class to get the configuration from.
     * @return the {@link ClassConfiguration} object containing all configuration properties for the class.
     */
    <T> ClassConfiguration<T> getConfiguration(Class<T> aClass);

    /**
     * Substitute any ${...} expression in the given string with the configuration values.
     *
     * @param value the string to substitute.
     * @return the substituted string.
     */
    String substituteWithConfiguration(String value);
}