• Home
• org.joeyb.undercarriage
• spark
• 1.3.3
• source code
• SparkApplication.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

org.joeyb.undercarriage.spark.SparkApplication Maven / Gradle / Ivy

package org.joeyb.undercarriage.spark;

import org.joeyb.undercarriage.core.Application;
import org.joeyb.undercarriage.spark.config.SparkConfigSection;

import spark.Service;

/**
 * {@code SparkApplication} is the base interface for all Spark-based applications. It defines the Spark-specific
 * application lifecycle phases and provides access to the underlying Spark {@link Service} instance.
 *
 * @param  the app's config type
 */
public interface SparkApplication extends Application {

    /**
     * Returns the app's actual port. The port is only known after the app has been started since a configured value of
     * 0 will cause the server to bind to a random available port.
     *
     * @throws IllegalStateException if the app has not been started
     */
    int port();

    /**
     * Returns the app's underlying Spark {@link Service} instance. It's important for consumers to be aware that Spark
     * is set up to automatically start the underlying web server as soon as a route is added, so the route
     * configuration should all be done during the application's {@link Application#start()} lifecycle phase.
     */
    Service service();
}