Package dev.relism.flash.extension

Class FlashRegistrar<SELF extends FlashRegistrar<SELF>>

java.lang.Object

dev.relism.flash.extension.FlashRegistrar<SELF>

Type Parameters:

SELF - concrete registrar type — enables fluent chaining without casting

Direct Known Subclasses:

FlashApp, FlashScope

public abstract class FlashRegistrar<SELF extends FlashRegistrar<SELF>>
extends Object

Common route-registration surface shared by FlashApp and FlashScope.

All route methods register immediately — no deferred .with() call. Middleware is passed as a varargs third argument:

 app.get("/ping",    (req, res) -> "pong")
 app.get("/secured", (req, res) -> user(), oidc.protect())
 app.get("/admin",   handler, oidc.requireRole("admin"), rateLimiter)
 

FlashExtension.routes(dev.relism.flash.extension.FlashRegistrar<?>, dev.relism.flash.extension.FlashContext) receives a FlashRegistrar<?> for route registration. Extension installation (install()) is only available on FlashApp — scoped install is intentionally unsupported.

Constructor Summary

Constructors

Constructor	Description
FlashRegistrar()

Method Summary

Modifier and Type	Method	Description
protected abstract void	addMiddleware(Middleware mw)	Registers a middleware in this registrar's own scope (global or scope-level).
protected abstract void	addRoute(HttpMethod method, String path, RequestHandler handler, List<Middleware> mw)	Adds a route immediately to this registrar's deferred compilation list.
protected abstract void	addWsRoute(String path, WebSocketEndpoint endpoint)
final SELF	connect(String path, SimpleHandler.FunctionalHandler h, Middleware... mw)
abstract FlashContext	ctx()	Returns the FlashContext for this registrar.
final SELF	delete(String path, SimpleHandler.FunctionalHandler h, Middleware... mw)
final SELF	get(String path, SimpleHandler.FunctionalHandler h, Middleware... mw)
final SELF	head(String path, SimpleHandler.FunctionalHandler h, Middleware... mw)
protected static RequestHandler	instantiate(Class<?> cls)
protected static WebSocketEndpoint	instantiateWs(Class<?> cls)
final SELF	options(String path, SimpleHandler.FunctionalHandler h, Middleware... mw)
final SELF	patch(String path, SimpleHandler.FunctionalHandler h, Middleware... mw)
final SELF	post(String path, SimpleHandler.FunctionalHandler h, Middleware... mw)
final SELF	purge(String path, SimpleHandler.FunctionalHandler h, Middleware... mw)
final SELF	put(String path, SimpleHandler.FunctionalHandler h, Middleware... mw)
final SELF	scan(String packageName)	Scans packageName for RequestHandler subclasses with a routing annotation (@Route or @GET, @POST, …).
final SELF	trace(String path, SimpleHandler.FunctionalHandler h, Middleware... mw)
final SELF	use(Middleware... middlewares)	Adds middlewares to this registrar's own scope.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

FlashRegistrar

public FlashRegistrar()

Method Details

get

public final SELF get(String path,
 SimpleHandler.FunctionalHandler h,
 Middleware... mw)

post

public final SELF post(String path,
 SimpleHandler.FunctionalHandler h,
 Middleware... mw)

put

public final SELF put(String path,
 SimpleHandler.FunctionalHandler h,
 Middleware... mw)

delete

public final SELF delete(String path,
 SimpleHandler.FunctionalHandler h,
 Middleware... mw)

patch

public final SELF patch(String path,
 SimpleHandler.FunctionalHandler h,
 Middleware... mw)

options

public final SELF options(String path,
 SimpleHandler.FunctionalHandler h,
 Middleware... mw)

head

public final SELF head(String path,
 SimpleHandler.FunctionalHandler h,
 Middleware... mw)

trace

public final SELF trace(String path,
 SimpleHandler.FunctionalHandler h,
 Middleware... mw)

connect

public final SELF connect(String path,
 SimpleHandler.FunctionalHandler h,
 Middleware... mw)

purge

public final SELF purge(String path,
 SimpleHandler.FunctionalHandler h,
 Middleware... mw)

use

public final SELF use(Middleware... middlewares)

Adds middlewares to this registrar's own scope. On FlashApp: applied to every route on the app. On FlashScope: applied to every route in this scope only. Order-independent: middleware is resolved at FlashApp.start().

scan

public final SELF scan(String packageName)

Scans packageName for RequestHandler subclasses with a routing annotation (@Route or @GET, @POST, …). Each match is constructed with its public no-arg constructor and registered immediately.

Throws:

InitializationException - if the package is empty, not found, or any handler class fails to load or instantiate

ctx

public abstract FlashContext ctx()

Returns the FlashContext for this registrar.

addRoute

protected abstract void addRoute(HttpMethod method,
 String path,
 RequestHandler handler,
 List<Middleware> mw)

Adds a route immediately to this registrar's deferred compilation list. Subclasses may prepend a namespace prefix and inject scope middlewares before storing.

addWsRoute

protected abstract void addWsRoute(String path,
 WebSocketEndpoint endpoint)

addMiddleware

protected abstract void addMiddleware(Middleware mw)

Registers a middleware in this registrar's own scope (global or scope-level).

instantiate

protected static RequestHandler instantiate(Class<?> cls)

instantiateWs

protected static WebSocketEndpoint instantiateWs(Class<?> cls)