ninja.standalone.Console Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of ninja-core Show documentation
There is a newer version: 7.0.0
/**
 * Copyright (C) the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package ninja.standalone;

import com.google.inject.Injector;
import java.util.Map;
import java.util.Optional;
import ninja.utils.NinjaMode;
import ninja.utils.NinjaPropertiesImpl;

/**
 *
 * @author jjlauer
 */
public interface Console {

    /**
     * Configures the standalone to prepare for being started.
     * @return This standalone
     * @throws Exception Thrown if an exception occurs during configuration
     */
    T configure() throws Exception;

    T externalConfigurationPath(String externalConfigurationPath);

    Optional getExternalConfigurationPath();

    /**
     * Gets the Guice injector that booted the Ninja application. This value
     * is only accessible after start() is successfully called.
     * @return The guice injector
     * @throws IllegalStateException Thrown if attempting to access this variable
     *      before start() is successfully called.
     */
    Injector getInjector();

    String getName();

    NinjaMode getNinjaMode();

    /**
     * Gets the NinjaProperties that were used to configure Ninja. This value
     * is only accessible after configure() is successfully called.
     * @return The NinjaProperties implementation
     * @throws IllegalStateException Thrown if attempting to access this variable
     *      before configure() is successfully called.
     */
    NinjaPropertiesImpl getNinjaProperties();

    T name(String name);

    T ninjaMode(NinjaMode ninjaMode);
    
    /**
     * Override Guice module bindings as described 
     * here: https://google.github.io/guice/api-docs/3.0/javadoc/com/google/inject/util/Modules.html
     * 
     * @param module Any bindings in this bindings will override all other bindings.
     *               This is very useful in tests.
     * @return this instance for chaining
     */
    T overrideModule(com.google.inject.Module module);
    
    /**
     * Override specific properties programmatically.
     * 
     * @param properties Any properties in this map will override properties in any configuration file.
     *                   This is very useful in tests.
     * @return this instance for chaining
     */
    T overrideProperties(Map properties);

    /**
     * Shutdown Ninja and underlying server as safely as possible (tries not
     * to cause exceptions to be thrown).
     * @return This standalone
     */
    T shutdown();

    /**
     * Configures (if not yet done), boots Ninja application and starts the
     * underlying server.
     * @return This standalone
     * @throws Exception Thrown if an exception occurs during Ninja boot or
     *      server start
     */
    T start() throws Exception;
    
}