Class JavalinRouteProviderMetaData

java.lang.Object

com.kingsrook.qqq.middleware.javalin.metadata.JavalinRouteProviderMetaData

All Implemented Interfaces:

QMetaDataObject, Serializable

public class JavalinRouteProviderMetaData
extends Object
implements QMetaDataObject

Meta-data to define a Javalin route provider configuration. This class configures how routes are provided and served in the Javalin middleware layer. It supports multiple types of route providers including: - Process-based routes (executing QQQ processes via HTTP endpoints) - Static file serving (hosting files from the file system or JAR) - Single Page Application (SPA) hosting with deep linking support - Isolated SPA hosting with separate route prefixes and static files Route providers can be configured with authentication, context handlers, and before/after handlers for request processing customization.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
JavalinRouteProviderMetaData()	Constructor

Method Summary

Modifier and Type	Method	Description
List<QCodeReference>	getAfterHandlers()	Getter for afterHandlers
List<QCodeReference>	getBeforeHandlers()	Getter for beforeHandlers
QCodeReference	getContextHandler()	Getter for contextHandler
boolean	getEnableDeepLinking()	Getter for enableDeepLinking
List<String>	getExcludedPaths()	Getter for excludedPaths
String	getFileSystemPath()	Getter for fileSystemPath
String	getHostedPath()	Getter for hostedPath
boolean	getLoadFromJar()	Getter for loadFromJar
List<String>	getMethods()	Getter for methods
String	getName()	Getter for name
String	getProcessName()	Getter for processName
QCodeReference	getRouteAuthenticator()	Getter for routeAuthenticator
String	getSpaIndexFile()	Getter for spaIndexFile
String	getSpaPath()	Getter for spaPath
String	getSpaRootFile()	Getter for spaRootFile
String	getSpaRootPath()	Getter for spaRootPath
String	getStaticFilesPath()	Getter for staticFilesPath
void	setAfterHandlers(List<QCodeReference> afterHandlers)	Setter for afterHandlers
void	setBeforeHandlers(List<QCodeReference> beforeHandlers)	Setter for beforeHandlers
void	setContextHandler(QCodeReference contextHandler)	Setter for contextHandler
void	setEnableDeepLinking(boolean enableDeepLinking)	Setter for enableDeepLinking
void	setExcludedPaths(List<String> excludedPaths)	Setter for excludedPaths
void	setFileSystemPath(String fileSystemPath)	Setter for fileSystemPath
void	setHostedPath(String hostedPath)	Setter for hostedPath
void	setLoadFromJar(boolean loadFromJar)	Setter for loadFromJar
void	setMethods(List<String> methods)	Setter for methods
void	setName(String name)	Setter for name
void	setProcessName(String processName)	Setter for processName
void	setRouteAuthenticator(QCodeReference routeAuthenticator)	Setter for routeAuthenticator
void	setSpaIndexFile(String spaIndexFile)	Setter for spaIndexFile
void	setSpaPath(String spaPath)	Setter for spaPath
void	setSpaRootFile(String spaRootFile)	Setter for spaRootFile
void	setSpaRootPath(String spaRootPath)	Setter for spaRootPath
void	setStaticFilesPath(String staticFilesPath)	Setter for staticFilesPath
void	validate(QInstance qInstance, QInstanceValidator validator)	Validate this route provider configuration against the QInstance.
JavalinRouteProviderMetaData	withAfterHandlers(List<QCodeReference> afterHandlers)	Fluent setter for afterHandlers
JavalinRouteProviderMetaData	withBeforeHandlers(List<QCodeReference> beforeHandlers)	Fluent setter for beforeHandlers
JavalinRouteProviderMetaData	withContextHandler(QCodeReference contextHandler)	Fluent setter for contextHandler
JavalinRouteProviderMetaData	withEnableDeepLinking(boolean enableDeepLinking)	Fluent setter for enableDeepLinking
JavalinRouteProviderMetaData	withExcludedPaths(List<String> excludedPaths)	Fluent setter for excludedPaths
JavalinRouteProviderMetaData	withFileSystemPath(String fileSystemPath)	Fluent setter for fileSystemPath
JavalinRouteProviderMetaData	withHostedPath(String hostedPath)	Fluent setter for hostedPath
JavalinRouteProviderMetaData	withLoadFromJar(boolean loadFromJar)	Fluent setter for loadFromJar
JavalinRouteProviderMetaData	withMethods(List<String> methods)	Fluent setter for methods
JavalinRouteProviderMetaData	withName(String name)	Fluent setter for name
JavalinRouteProviderMetaData	withProcessName(String processName)	Fluent setter for processName
JavalinRouteProviderMetaData	withRouteAuthenticator(QCodeReference routeAuthenticator)	Fluent setter for routeAuthenticator
JavalinRouteProviderMetaData	withSpaIndexFile(String spaIndexFile)	Fluent setter for spaIndexFile
JavalinRouteProviderMetaData	withSpaPath(String spaPath)	Fluent setter for spaPath
JavalinRouteProviderMetaData	withSpaRootFile(String spaRootFile)	Fluent setter for spaRootFile
JavalinRouteProviderMetaData	withSpaRootPath(String spaRootPath)	Fluent setter for spaRootPath
JavalinRouteProviderMetaData	withStaticFilesPath(String staticFilesPath)	Fluent setter for staticFilesPath

Methods inherited from class java.lang.Object

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

Constructor Details

JavalinRouteProviderMetaData

public JavalinRouteProviderMetaData()

Constructor

Method Details

getHostedPath

public String getHostedPath()

Getter for hostedPath

See Also:

• withHostedPath(String)

setHostedPath

public void setHostedPath(String hostedPath)

Setter for hostedPath

See Also:

• withHostedPath(String)

withHostedPath

public JavalinRouteProviderMetaData withHostedPath(String hostedPath)

Fluent setter for hostedPath

Parameters:

hostedPath - The URL path where this route will be hosted

Returns:

this

getFileSystemPath

public String getFileSystemPath()

Getter for fileSystemPath

See Also:

• withFileSystemPath(String)

setFileSystemPath

public void setFileSystemPath(String fileSystemPath)

Setter for fileSystemPath

See Also:

• withFileSystemPath(String)

withFileSystemPath

public JavalinRouteProviderMetaData withFileSystemPath(String fileSystemPath)

Fluent setter for fileSystemPath

Parameters:

fileSystemPath - The file system path where static files are located

Returns:

this

getSpaRootPath

public String getSpaRootPath()

Getter for spaRootPath

See Also:

• withSpaRootPath(String)

setSpaRootPath

public void setSpaRootPath(String spaRootPath)

Setter for spaRootPath

See Also:

• withSpaRootPath(String)

withSpaRootPath

public JavalinRouteProviderMetaData withSpaRootPath(String spaRootPath)

Fluent setter for spaRootPath

Parameters:

spaRootPath - The root path for the SPA

Returns:

this

getSpaRootFile

public String getSpaRootFile()

Getter for spaRootFile

See Also:

• withSpaRootFile(String)

setSpaRootFile

public void setSpaRootFile(String spaRootFile)

Setter for spaRootFile

See Also:

• withSpaRootFile(String)

withSpaRootFile

public JavalinRouteProviderMetaData withSpaRootFile(String spaRootFile)

Fluent setter for spaRootFile

Parameters:

spaRootFile - The root file for the SPA (typically index.html)

Returns:

this

getProcessName

public String getProcessName()

Getter for processName

See Also:

• withProcessName(String)

setProcessName

public void setProcessName(String processName)

Setter for processName

See Also:

• withProcessName(String)

withProcessName

public JavalinRouteProviderMetaData withProcessName(String processName)

Fluent setter for processName

Parameters:

processName - The name of the process to be executed by this route

Returns:

this

getMethods

public List<String> getMethods()

Getter for methods

See Also:

• withMethods(List)

setMethods

public void setMethods(List<String> methods)

Setter for methods

See Also:

• withMethods(List)

withMethods

public JavalinRouteProviderMetaData withMethods(List<String> methods)

Fluent setter for methods

Parameters:

methods - List of HTTP methods this route should handle (e.g., GET, POST)

Returns:

this

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 JavalinRouteProviderMetaData withRouteAuthenticator(QCodeReference routeAuthenticator)

Fluent setter for routeAuthenticator

Parameters:

routeAuthenticator - Code reference to the authenticator for this route

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 JavalinRouteProviderMetaData withContextHandler(QCodeReference contextHandler)

Fluent setter for contextHandler

Parameters:

contextHandler - Code reference to the context handler for this route

Returns:

this

getName

public String getName()

Getter for name

See Also:

• withName(String)

setName

public void setName(String name)

Setter for name

See Also:

• withName(String)

withName

public JavalinRouteProviderMetaData withName(String name)

Fluent setter for name

Parameters:

name - The unique name for this route provider

Returns:

this

getSpaPath

public String getSpaPath()

Getter for spaPath

See Also:

• withSpaPath(String)

setSpaPath

public void setSpaPath(String spaPath)

Setter for spaPath

See Also:

• withSpaPath(String)

withSpaPath

public JavalinRouteProviderMetaData withSpaPath(String spaPath)

Fluent setter for spaPath

Parameters:

spaPath - The URL path where the SPA will be served

Returns:

this

getStaticFilesPath

public String getStaticFilesPath()

Getter for staticFilesPath

See Also:

• withStaticFilesPath(String)

setStaticFilesPath

public void setStaticFilesPath(String staticFilesPath)

Setter for staticFilesPath

See Also:

• withStaticFilesPath(String)

withStaticFilesPath

public JavalinRouteProviderMetaData withStaticFilesPath(String staticFilesPath)

Fluent setter for staticFilesPath

Parameters:

staticFilesPath - The path where static files are located for the SPA

Returns:

this

getSpaIndexFile

public String getSpaIndexFile()

Getter for spaIndexFile

See Also:

• withSpaIndexFile(String)

setSpaIndexFile

public void setSpaIndexFile(String spaIndexFile)

Setter for spaIndexFile

See Also:

• withSpaIndexFile(String)

withSpaIndexFile

public JavalinRouteProviderMetaData withSpaIndexFile(String spaIndexFile)

Fluent setter for spaIndexFile

Parameters:

spaIndexFile - The index file name for the SPA (e.g., index.html)

Returns:

this

getExcludedPaths

public List<String> getExcludedPaths()

Getter for excludedPaths

See Also:

• withExcludedPaths(List)

setExcludedPaths

public void setExcludedPaths(List<String> excludedPaths)

Setter for excludedPaths

See Also:

• withExcludedPaths(List)

withExcludedPaths

public JavalinRouteProviderMetaData withExcludedPaths(List<String> excludedPaths)

Fluent setter for excludedPaths

Parameters:

excludedPaths - List of URL paths to exclude from SPA routing

Returns:

this

getEnableDeepLinking

public boolean getEnableDeepLinking()

Getter for enableDeepLinking

See Also:

• withEnableDeepLinking(boolean)

setEnableDeepLinking

public void setEnableDeepLinking(boolean enableDeepLinking)

Setter for enableDeepLinking

See Also:

• withEnableDeepLinking(boolean)

withEnableDeepLinking

public JavalinRouteProviderMetaData withEnableDeepLinking(boolean enableDeepLinking)

Fluent setter for enableDeepLinking

Parameters:

enableDeepLinking - Whether to enable deep linking for the SPA (default true)

Returns:

this

getLoadFromJar

public boolean getLoadFromJar()

Getter for loadFromJar

See Also:

• withLoadFromJar(boolean)

setLoadFromJar

public void setLoadFromJar(boolean loadFromJar)

Setter for loadFromJar

See Also:

• withLoadFromJar(boolean)

withLoadFromJar

public JavalinRouteProviderMetaData withLoadFromJar(boolean loadFromJar)

Fluent setter for loadFromJar

Parameters:

loadFromJar - Whether to load SPA files from JAR resources (default false)

Returns:

this

getBeforeHandlers

public List<QCodeReference> getBeforeHandlers()

Getter for beforeHandlers

See Also:

• withBeforeHandlers(List)

setBeforeHandlers

public void setBeforeHandlers(List<QCodeReference> beforeHandlers)

Setter for beforeHandlers

See Also:

• withBeforeHandlers(List)

withBeforeHandlers

public JavalinRouteProviderMetaData withBeforeHandlers(List<QCodeReference> beforeHandlers)

Fluent setter for beforeHandlers

Parameters:

beforeHandlers - List of code references to handlers executed before the route

Returns:

this

getAfterHandlers

public List<QCodeReference> getAfterHandlers()

Getter for afterHandlers

See Also:

• withAfterHandlers(List)

setAfterHandlers

public void setAfterHandlers(List<QCodeReference> afterHandlers)

Setter for afterHandlers

See Also:

• withAfterHandlers(List)

withAfterHandlers

public JavalinRouteProviderMetaData withAfterHandlers(List<QCodeReference> afterHandlers)

Fluent setter for afterHandlers

Parameters:

afterHandlers - List of code references to handlers executed after the route

Returns:

this

validate

public void validate(QInstance qInstance,
 QInstanceValidator validator)

Validate this route provider configuration against the QInstance. Ensures that: - Referenced process names exist in the QInstance - Route authenticator code references are valid - Context handler code references are valid - Before and after handler code references are valid - IsolatedSpaRouteProvider fields are properly configured when used

Parameters:

qInstance - the QInstance to validate against

validator - the validator to record validation errors