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.
/*
* Javalin - https://javalin.io
* Copyright 2017 David Åse
* Licensed under Apache 2.0: https://github.com/tipsy/javalin/blob/master/LICENSE
*/
package io.javalin.apibuilder;
import io.javalin.Handler;
import io.javalin.Javalin;
import io.javalin.security.AccessManager;
import io.javalin.security.Role;
import io.javalin.websocket.WsHandler;
import java.util.ArrayDeque;
import java.util.Deque;
import java.util.HashSet;
import java.util.Set;
import java.util.function.Consumer;
import org.jetbrains.annotations.NotNull;
/**
* Static methods for route declarations in Javalin
*
* @see Javalin#routes(EndpointGroup)
*/
public class ApiBuilder {
private static Javalin staticJavalin;
private static Deque pathDeque = new ArrayDeque<>();
public static void setStaticJavalin(@NotNull Javalin javalin) {
staticJavalin = javalin;
}
public static void clearStaticJavalin() {
staticJavalin = null;
}
/**
* Prefixes all handlers defined in its scope with the specified path.
* All paths are normalized, so you can call both
* path("/path") or path("path") depending on your preference
* The method can only be called inside a {@link Javalin#routes(EndpointGroup)}.
*/
public static void path(@NotNull String path, @NotNull EndpointGroup endpointGroup) {
path = path.startsWith("/") ? path : "/" + path;
pathDeque.addLast(path);
endpointGroup.addEndpoints();
pathDeque.removeLast();
}
private static String prefixPath(@NotNull String path) {
return String.join("", pathDeque) + ((path.startsWith("/") || path.isEmpty()) ? path : "/" + path);
}
private static Javalin staticInstance() {
if (staticJavalin == null) {
throw new IllegalStateException("The static API can only be used within a routes() call.");
}
return staticJavalin;
}
/////////////////////////////////////////////////////////////
// HTTP verbs
/////////////////////////////////////////////////////////////
/**
* Adds a GET request handler for the specified path to the {@link Javalin} instance.
* The method can only be called inside a {@link Javalin#routes(EndpointGroup)}.
*
* @see Handlers in docs
*/
public static void get(@NotNull String path, @NotNull Handler handler) {
staticInstance().get(prefixPath(path), handler);
}
/**
* Adds a GET request handler with the given roles for the specified path to the instance.
* The method can only be called inside a {@link Javalin#routes(EndpointGroup)}.
*
* @see AccessManager
* @see Javalin#accessManager(AccessManager)
* @see Handlers in docs
*/
public static void get(@NotNull String path, @NotNull Handler handler, @NotNull Set permittedRoles) {
staticInstance().get(prefixPath(path), handler, permittedRoles);
}
/**
* Adds a GET request handler for the current path to the {@link Javalin} instance.
* The method can only be called inside a {@link Javalin#routes(EndpointGroup)}.
*
* @see Handlers in docs
*/
public static void get(@NotNull Handler handler) {
staticInstance().get(prefixPath(""), handler);
}
/**
* Adds a GET request handler with the given roles for the current path to the instance.
* The method can only be called inside a {@link Javalin#routes(EndpointGroup)}.
*
* @see AccessManager
* @see Javalin#accessManager(AccessManager)
* @see Handlers in docs
*/
public static void get(@NotNull Handler handler, @NotNull Set permittedRoles) {
staticInstance().get(prefixPath(""), handler, permittedRoles);
}
/**
* Adds a POST request handler for the specified path to the {@link Javalin} instance.
* The method can only be called inside a {@link Javalin#routes(EndpointGroup)}.
*
* @see Handlers in docs
*/
public static void post(@NotNull String path, @NotNull Handler handler) {
staticInstance().post(prefixPath(path), handler);
}
/**
* Adds a POST request handler with the given roles for the specified path to the instance.
* The method can only be called inside a {@link Javalin#routes(EndpointGroup)}.
*
* @see AccessManager
* @see Javalin#accessManager(AccessManager)
* @see Handlers in docs
*/
public static void post(@NotNull String path, @NotNull Handler handler, @NotNull Set permittedRoles) {
staticInstance().post(prefixPath(path), handler, permittedRoles);
}
/**
* Adds a POST request handler for the current path to the {@link Javalin} instance.
* The method can only be called inside a {@link Javalin#routes(EndpointGroup)}.
*
* @see Handlers in docs
*/
public static void post(@NotNull Handler handler) {
staticInstance().post(prefixPath(""), handler);
}
/**
* Adds a POST request handler with the given roles for the current path to the instance.
* The method can only be called inside a {@link Javalin#routes(EndpointGroup)}.
*
* @see AccessManager
* @see Javalin#accessManager(AccessManager)
* @see Handlers in docs
*/
public static void post(@NotNull Handler handler, @NotNull Set permittedRoles) {
staticInstance().post(prefixPath(""), handler, permittedRoles);
}
/**
* Adds a PUT request handler for the specified path to the {@link Javalin} instance.
* The method can only be called inside a {@link Javalin#routes(EndpointGroup)}.
*
* @see Handlers in docs
*/
public static void put(@NotNull String path, @NotNull Handler handler) {
staticInstance().put(prefixPath(path), handler);
}
/**
* Adds a PUT request handler with the given roles for the specified path to the instance.
* The method can only be called inside a {@link Javalin#routes(EndpointGroup)}.
*
* @see AccessManager
* @see Javalin#accessManager(AccessManager)
* @see Handlers in docs
*/
public static void put(@NotNull String path, @NotNull Handler handler, @NotNull Set permittedRoles) {
staticInstance().put(prefixPath(path), handler, permittedRoles);
}
/**
* Adds a PUT request handler for the current path to the {@link Javalin} instance.
* The method can only be called inside a {@link Javalin#routes(EndpointGroup)}.
*
* @see Handlers in docs
*/
public static void put(@NotNull Handler handler) {
staticInstance().put(prefixPath(""), handler);
}
/**
* Adds a PUT request handler with the given roles for the current path to the instance.
* The method can only be called inside a {@link Javalin#routes(EndpointGroup)}.
*
* @see AccessManager
* @see Javalin#accessManager(AccessManager)
* @see Handlers in docs
*/
public static void put(@NotNull Handler handler, @NotNull Set permittedRoles) {
staticInstance().put(prefixPath(""), handler, permittedRoles);
}
/**
* Adds a PATCH request handler for the specified path to the {@link Javalin} instance.
* The method can only be called inside a {@link Javalin#routes(EndpointGroup)}.
*
* @see Handlers in docs
*/
public static void patch(@NotNull String path, @NotNull Handler handler) {
staticInstance().patch(prefixPath(path), handler);
}
/**
* Adds a PATCH request handler with the given roles for the specified path to the instance.
* The method can only be called inside a {@link Javalin#routes(EndpointGroup)}.
*
* @see AccessManager
* @see Javalin#accessManager(AccessManager)
* @see Handlers in docs
*/
public static void patch(@NotNull String path, @NotNull Handler handler, @NotNull Set permittedRoles) {
staticInstance().patch(prefixPath(path), handler, permittedRoles);
}
/**
* Adds a PATCH request handler for the current path to the {@link Javalin} instance.
* The method can only be called inside a {@link Javalin#routes(EndpointGroup)}.
*
* @see Handlers in docs
*/
public static void patch(@NotNull Handler handler) {
staticInstance().patch(prefixPath(""), handler);
}
/**
* Adds a PATCH request handler with the given roles for the current path to the instance.
* The method can only be called inside a {@link Javalin#routes(EndpointGroup)}.
*
* @see AccessManager
* @see Javalin#accessManager(AccessManager)
* @see Handlers in docs
*/
public static void patch(@NotNull Handler handler, @NotNull Set permittedRoles) {
staticInstance().patch(prefixPath(""), handler, permittedRoles);
}
/**
* Adds a DELETE request handler for the specified path to the {@link Javalin} instance.
* The method can only be called inside a {@link Javalin#routes(EndpointGroup)}.
*
* @see Handlers in docs
*/
public static void delete(@NotNull String path, @NotNull Handler handler) {
staticInstance().delete(prefixPath(path), handler);
}
/**
* Adds a DELETE request handler with the given roles for the specified path to the instance.
* The method can only be called inside a {@link Javalin#routes(EndpointGroup)}.
*
* @see AccessManager
* @see Javalin#accessManager(AccessManager)
* @see Handlers in docs
*/
public static void delete(@NotNull String path, @NotNull Handler handler, @NotNull Set permittedRoles) {
staticInstance().delete(prefixPath(path), handler, permittedRoles);
}
/**
* Adds a DELETE request handler for the current path to the {@link Javalin} instance.
* The method can only be called inside a {@link Javalin#routes(EndpointGroup)}.
*
* @see Handlers in docs
*/
public static void delete(@NotNull Handler handler) {
staticInstance().delete(prefixPath(""), handler);
}
/**
* Adds a DELETE request handler with the given roles for the current path to the instance.
* The method can only be called inside a {@link Javalin#routes(EndpointGroup)}.
*
* @see AccessManager
* @see Javalin#accessManager(AccessManager)
* @see Handlers in docs
*/
public static void delete(@NotNull Handler handler, @NotNull Set permittedRoles) {
staticInstance().delete(prefixPath(""), handler, permittedRoles);
}
/**
* Adds a HEAD request handler for the specified path to the {@link Javalin} instance.
* The method can only be called inside a {@link Javalin#routes(EndpointGroup)}.
*
* @see Handlers in docs
*/
public static void head(@NotNull String path, @NotNull Handler handler) {
staticInstance().head(prefixPath(path), handler);
}
/**
* Adds a HEAD request handler with the given roles for the specified path to the instance.
* The method can only be called inside a {@link Javalin#routes(EndpointGroup)}.
*
* @see AccessManager
* @see Javalin#accessManager(AccessManager)
* @see Handlers in docs
*/
public static void head(@NotNull String path, @NotNull Handler handler, @NotNull Set permittedRoles) {
staticInstance().head(prefixPath(path), handler, permittedRoles);
}
/**
* Adds a HEAD request handler for the current path to the {@link Javalin} instance.
* The method can only be called inside a {@link Javalin#routes(EndpointGroup)}.
*
* @see Handlers in docs
*/
public static void head(@NotNull Handler handler) {
staticInstance().head(prefixPath(""), handler);
}
/**
* Adds a HEAD request handler with the given roles for the current path to the instance.
* The method can only be called inside a {@link Javalin#routes(EndpointGroup)}.
*
* @see AccessManager
* @see Javalin#accessManager(AccessManager)
* @see Handlers in docs
*/
public static void head(@NotNull Handler handler, @NotNull Set permittedRoles) {
staticInstance().head(prefixPath(""), handler, permittedRoles);
}
/////////////////////////////////////////////////////////////
// Filters
/////////////////////////////////////////////////////////////
/**
* Adds a BEFORE request handler for the specified path to the {@link Javalin} instance.
* The method can only be called inside a {@link Javalin#routes(EndpointGroup)}.
*
* @see Handlers in docs
*/
public static void before(@NotNull String path, @NotNull Handler handler) {
staticInstance().before(prefixPath(path), handler);
}
/**
* Adds a BEFORE request handler for the current path to the {@link Javalin} instance.
* The method can only be called inside a {@link Javalin#routes(EndpointGroup)}.
*
* @see Handlers in docs
*/
public static void before(@NotNull Handler handler) {
staticInstance().before(prefixPath("/*"), handler);
}
/**
* Adds an AFTER request handler for the specified path to the {@link Javalin} instance.
* The method can only be called inside a {@link Javalin#routes(EndpointGroup)}.
*
* @see Handlers in docs
*/
public static void after(@NotNull String path, @NotNull Handler handler) {
staticInstance().after(prefixPath(path), handler);
}
/**
* Adds a AFTER request handler for the current path to the {@link Javalin} instance.
* The method can only be called inside a {@link Javalin#routes(EndpointGroup)}.
*
* @see Handlers in docs
*/
public static void after(@NotNull Handler handler) {
staticInstance().after(prefixPath("/*"), handler);
}
/////////////////////////////////////////////////////////////
// WebSockets
/////////////////////////////////////////////////////////////
/**
* Adds a WebSocket handler on the specified path.
*
* @see WebSockets in docs
*/
public static void ws(@NotNull String path, @NotNull Consumer ws) {
staticInstance().ws(prefixPath(path), ws);
}
/**
* Adds a WebSocket handler on the current path.
*
* @see WebSockets in docs
*/
public static void ws(@NotNull Consumer ws) {
staticInstance().ws(prefixPath(""), ws);
}
/////////////////////////////////////////////////////////////
// CrudHandler
/////////////////////////////////////////////////////////////
/**
* Adds a CrudHandler handler to the specified path to the instance.
*
* @see CrudHandler
*/
public static void crud(@NotNull String path, @NotNull CrudHandler crudHandler) {
ApiBuilder.crud(path, crudHandler, new HashSet<>());
}
/**
* Adds a CrudHandler handler to the specified path with the given roles to the instance.
*
* @see CrudHandler
*/
public static void crud(@NotNull String path, @NotNull CrudHandler crudHandler, @NotNull Set permittedRoles) {
path = path.startsWith("/") ? path : "/" + path;
if (path.startsWith("/:")) {
throw new IllegalArgumentException("CrudHandler requires a resource base at the beginning of the provided path e.g. '/users/:user-id'");
}
if (!path.contains("/:") || path.lastIndexOf("/") > path.lastIndexOf("/:")) {
throw new IllegalArgumentException("CrudHandler requires a path-parameter at the end of the provided path e.g. '/users/:user-id'");
}
String SEPARATOR = "/:";
String resourceBase = path.substring(0, path.lastIndexOf(SEPARATOR));
String resourceId = path.substring(path.lastIndexOf(SEPARATOR) + SEPARATOR.length());
staticInstance().get(prefixPath(path), ctx -> crudHandler.getOne(ctx, ctx.pathParam(resourceId)), permittedRoles);
staticInstance().get(prefixPath(resourceBase), crudHandler::getAll, permittedRoles);
staticInstance().post(prefixPath(resourceBase), crudHandler::create, permittedRoles);
staticInstance().patch(prefixPath(path), ctx -> crudHandler.update(ctx, ctx.pathParam(resourceId)), permittedRoles);
staticInstance().delete(prefixPath(path), ctx -> crudHandler.delete(ctx, ctx.pathParam(resourceId)), permittedRoles);
}
}
