be.yildizgames.module.webserver.WebServerBuilder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of module-webserver-undertow Show documentation
The newest version!
/*
 * This file is part of the Yildiz-Engine project, licenced under the MIT License  (MIT)
 *  Copyright (c) 2024 Grégory Van den Borre
 *  More infos available: https://engine.yildiz-games.be
 *  Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
 *  documentation files (the "Software"), to deal in the Software without restriction, including without limitation
 *  the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to
 *  permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright
 *  notice and this permission notice shall be included in all copies or substantial portions of the  Software.
 *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
 *  WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS
 *  OR COPYRIGHT  HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
 *  OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 *
 */
package be.yildizgames.module.webserver;

/**
 * Build a web server.
 *
 * @author Grégory Van den Borre
 */
public interface WebServerBuilder {

    /**
     * Add a route to the web server.
     *
     * @param path     Path to match, must start with /.
     * @param response Html to send as response when the path is matched.
     * @return this object for chaining.
     */
    WebServerBuilder addRoute(String path, HtmlPageResponse response);

    /**
     * Add a route to the web server.
     *
     * @param path     Path to match, must start with /.
     * @param response Text to send as response when the path is matched.
     * @return this object for chaining.
     */
    WebServerBuilder addRoute(String path, PlainTextResponse response);

    /**
     * Add a route to the web server.
     *
     * @param path     Path to match, must start with /.
     * @param response Yaml to send as response when the path is matched.
     * @return this object for chaining.
     */
    WebServerBuilder addRoute(String path, YamlTextResponse response);

    /**
     * Add a route to the web server.
     *
     * @param path     Path to match, must start with /.
     * @param response File to send as response when the path is matched.
     * @return this object for chaining.
     */
    WebServerBuilder addRoute(String path, FileResponse response);

    /**
     * Build the web server.
     *
     * @return The built web server, never null.
     */
    WebServer build();
}