Class ProcessBasedRouter

java.lang.Object

com.kingsrook.qqq.middleware.javalin.routeproviders.ProcessBasedRouter

All Implemented Interfaces:

QJavalinRouteProviderInterface

public class ProcessBasedRouter
extends Object
implements QJavalinRouteProviderInterface

Route provider that executes QQQ processes in response to HTTP requests. This provider bridges Javalin HTTP routes to QQQ's process execution engine, allowing processes to be exposed as REST endpoints. Request data (path params, query params, body, headers) is passed into the process via ProcessBasedRouterPayload, and process output is used to construct the HTTP response. Supports: - Multiple HTTP methods (GET, POST, PUT, DELETE, etc.) - Custom authentication via RouteAuthenticatorInterface - Custom request/response handling via RouteProviderContextHandlerInterface - Path parameters, query parameters, form data, and request bodies Usage Example:

 new ProcessBasedRouter("/api/orders/{orderId}", "processOrderRequest")
    .withRouteAuthenticator(new QCodeReference(ApiAuthenticator.class))
    .withMethods(List.of("GET", "POST"))
 

Constructor Summary

Constructors

Constructor	Description
ProcessBasedRouter(JavalinRouteProviderMetaData routeProvider)	Constructor that builds router from meta-data configuration.
ProcessBasedRouter(String hostedPath, String processName)	Constructor for process-based route with default GET method.
ProcessBasedRouter(String hostedPath, String processName, List<String> methods)	Constructor for process-based route with specified HTTP methods.

Method Summary

Modifier and Type	Method	Description
QCodeReference	getContextHandler()	Getter for contextHandler
io.javalin.apibuilder.EndpointGroup	getJavalinEndpointGroup()	Get the Javalin endpoint group configuration for this route.
QCodeReference	getRouteAuthenticator()	Getter for routeAuthenticator
void	setContextHandler(QCodeReference contextHandler)	Setter for contextHandler
void	setQInstance(QInstance qInstance)	Set the QInstance for this route provider.
void	setRouteAuthenticator(QCodeReference routeAuthenticator)	Setter for routeAuthenticator
ProcessBasedRouter	withContextHandler(QCodeReference contextHandler)	Fluent setter for contextHandler
ProcessBasedRouter	withRouteAuthenticator(QCodeReference routeAuthenticator)	Fluent setter for routeAuthenticator

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.kingsrook.qqq.middleware.javalin.QJavalinRouteProviderInterface

acceptJavalinConfig, acceptJavalinService

Constructor Details

ProcessBasedRouter

public ProcessBasedRouter(String hostedPath,
 String processName)

Constructor for process-based route with default GET method.

Parameters:

hostedPath - the URL path where this route will be hosted

processName - the name of the QQQ process to execute

ProcessBasedRouter

public ProcessBasedRouter(JavalinRouteProviderMetaData routeProvider)

Constructor that builds router from meta-data configuration.

Parameters:

routeProvider - meta-data containing route configuration

ProcessBasedRouter

public ProcessBasedRouter(String hostedPath,
 String processName,
 List<String> methods)

Constructor for process-based route with specified HTTP methods.

Parameters:

hostedPath - the URL path where this route will be hosted (e.g., "/api/orders/{id}")

processName - the name of the QQQ process to execute for this route

methods - list of HTTP methods to support (GET, POST, PUT, DELETE, PATCH); defaults to GET if null

Method Details

setQInstance

public void setQInstance(QInstance qInstance)

Set the QInstance for this route provider. Called by the framework during initialization to provide access to the QQQ instance configuration.

Specified by:

setQInstance in interface QJavalinRouteProviderInterface

Parameters:

qInstance - the QInstance containing meta-data and configuration

getJavalinEndpointGroup

public io.javalin.apibuilder.EndpointGroup getJavalinEndpointGroup()

Get the Javalin endpoint group configuration for this route. Creates route registrations for all configured HTTP methods, mapping them to the handleRequest method that executes the QQQ process.

Specified by:

getJavalinEndpointGroup in interface QJavalinRouteProviderInterface

Returns:

EndpointGroup containing route registrations

Throws:

IllegalArgumentException - if an unrecognized HTTP method is specified

getRouteAuthenticator

public QCodeReference getRouteAuthenticator()

Getter for routeAuthenticator

See Also:

• withRouteAuthenticator(QCodeReference)

setRouteAuthenticator

public void setRouteAuthenticator(QCodeReference routeAuthenticator)

Setter for routeAuthenticator

See Also:

• withRouteAuthenticator(QCodeReference)

withRouteAuthenticator

public ProcessBasedRouter withRouteAuthenticator(QCodeReference routeAuthenticator)

Fluent setter for routeAuthenticator

Parameters:

routeAuthenticator - code reference to the route authenticator implementation

Returns:

this

getContextHandler

public QCodeReference getContextHandler()

Getter for contextHandler

See Also:

• withContextHandler(QCodeReference)

setContextHandler

public void setContextHandler(QCodeReference contextHandler)

Setter for contextHandler

See Also:

• withContextHandler(QCodeReference)

withContextHandler

public ProcessBasedRouter withContextHandler(QCodeReference contextHandler)

Fluent setter for contextHandler

Parameters:

contextHandler - code reference to the context handler implementation

Returns:

this