io.muserver.Routes Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of mu-server Show documentation
A simple but powerful web server framework
The newest version!
package io.muserver;

import io.muserver.rest.PathMatch;
import io.muserver.rest.UriPattern;

/**
 * A helper class to create a handler for a specific URL. See{@link MuServerBuilder#addHandler(Method, String, RouteHandler)}
 * for a simple way to add a routed handler to a server.
 */
public class Routes {

    /**
     * Creates a new handler that will only be called if it matches the given route info.
     * @param method The method to match, or null to accept any method.
     * @param uriTemplate A URL template. Supports plain URLs like /abc or paths
     *                   with named parameters such as /abc/{id} or named parameters
     *                    with regexes such as /abc/{id : [0-9]+} where the named
     *                    parameter values can be accessed with the pathParams
     *                    parameter in the route handler.
     * @param muHandler The handler to invoke if the method and URI matches.
     * @return Returns a {@link MuHandler} that is only called if the request URI and method matches.
     * @see MuServerBuilder#addHandler(Method, String, RouteHandler)
     */
	public static MuHandler route(Method method, String uriTemplate, RouteHandler muHandler) {
        UriPattern uriPattern = UriPattern.uriTemplateToRegex(uriTemplate);

        return new MuHandler() {
            @Override
            public boolean handle(MuRequest request, MuResponse response) throws Exception {
                boolean methodMatches = method == null || method.equals(request.method());
                if (methodMatches) {
                    PathMatch matcher = uriPattern.matcher(request.relativePath());
                    if (matcher.fullyMatches()) {
                        muHandler.handle(request, response, matcher.params());
                        return true;
                    }
                }
                return false;
            }

            @Override
            public String toString() {
                return "RouteHandler{" +
                    "method='" + (method == null ? "Any" : method.name()) + '\'' +
                    ", path='" + uriTemplate + '\'' +
                    '}';
            }
        };
	}

	private Routes() {}
}