Class MiddlewareSpecExtensionsMetaData

java.lang.Object

com.kingsrook.qqq.middleware.javalin.specs.extensions.MiddlewareSpecExtensionsMetaData

All Implemented Interfaces:

MetaDataProducerOutput, QMetaDataObject, QSupplementalInstanceMetaData, TopLevelMetaDataInterface, Serializable

public class MiddlewareSpecExtensionsMetaData
extends Object
implements QSupplementalInstanceMetaData

The instance's registry of UI API extensions: endpoint specs that modules and qbits add to the versioned UI API (`/qqq/v1`). Validated with the QInstance; see docs/UI-API-EXTENSIONS.md.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final Set<String>	CORE_RESERVED_ROOTS	First path segments that belong to core and are never available to an extension.
static final Map<String,String>	ESTABLISHED_PREFIXES	Path prefixes that shipped to clients before the extension point existed, and so keep their URLs rather than moving under `/qbit/{name}`.
static final String	NAME

Constructor Summary

Constructors

Constructor	Description
MiddlewareSpecExtensionsMetaData()

Method Summary

Modifier and Type	Method	Description
Map<String,MiddlewareSpecExtension>	getExtensions()	Getter for extensions
String	getName()
List<AbstractEndpointSpec<?,?,?>>	instantiateAllSpecs()	The specs of every extension, instantiated, in registration order.
static AbstractEndpointSpec<?,?,?>	instantiateSpec(QCodeReference reference)	Instantiate one spec reference.
static String	normalizePathTemplate(String path)	Normalize a path template for comparison: path parameters become `{}` and duplicate / trailing slashes are removed.
static MiddlewareSpecExtensionsMetaData	of(QInstance qInstance)	Get the instance's registry, or null when nothing registered an extension.
static MiddlewareSpecExtensionsMetaData	ofOrWithNew(QInstance qInstance)	Get the instance's registry, adding an empty one if it has none.
void	setExtensions(Map<String,MiddlewareSpecExtension> extensions)	Setter for extensions
void	validate(QInstance qInstance, QInstanceValidator validator)	Validate every extension: name, semver, prefix and specs.
MiddlewareSpecExtensionsMetaData	withExtension(MiddlewareSpecExtension extension)	Register an extension.

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.backend.core.model.metadata.QSupplementalInstanceMetaData

addSelfToInstance, enrich

Field Details

NAME

public static final String NAME

See Also:

• Constant Field Values

ESTABLISHED_PREFIXES

public static final Map<String,String> ESTABLISHED_PREFIXES

Path prefixes that shipped to clients before the extension point existed, and so keep their URLs rather than moving under `/qbit/{name}`. Keys are prefixes; values are the only extension name allowed to use them.

CORE_RESERVED_ROOTS

public static final Set<String> CORE_RESERVED_ROOTS

First path segments that belong to core and are never available to an extension.

Constructor Details

MiddlewareSpecExtensionsMetaData

public MiddlewareSpecExtensionsMetaData()

Method Details

of

public static MiddlewareSpecExtensionsMetaData of(QInstance qInstance)

Get the instance's registry, or null when nothing registered an extension.

ofOrWithNew

public static MiddlewareSpecExtensionsMetaData ofOrWithNew(QInstance qInstance)

Get the instance's registry, adding an empty one if it has none.

getName

public String getName()

Specified by:

getName in interface TopLevelMetaDataInterface

withExtension

public MiddlewareSpecExtensionsMetaData withExtension(MiddlewareSpecExtension extension)

Register an extension. Registering one with the same name again replaces it, so producers may register idempotently.

getExtensions

public Map<String,MiddlewareSpecExtension> getExtensions()

Getter for extensions

setExtensions

public void setExtensions(Map<String,MiddlewareSpecExtension> extensions)

Setter for extensions

instantiateSpec

public static AbstractEndpointSpec<?,?,?> instantiateSpec(QCodeReference reference)
                                                   throws ReflectiveOperationException

Instantiate one spec reference.

Throws:

ReflectiveOperationException

normalizePathTemplate

public static String normalizePathTemplate(String path)

Normalize a path template for comparison: path parameters become `{}` and duplicate / trailing slashes are removed.

validate

public void validate(QInstance qInstance,
 QInstanceValidator validator)

Validate every extension: name, semver, prefix and specs.

Specified by:

validate in interface QSupplementalInstanceMetaData

instantiateAllSpecs

public List<AbstractEndpointSpec<?,?,?>> instantiateAllSpecs()
                                                      throws ReflectiveOperationException

The specs of every extension, instantiated, in registration order.

Throws:

ReflectiveOperationException