Class SupplementalInstanceMetaData

java.lang.Object

com.kingsrook.qqq.middleware.javalin.specs.v1.responses.components.SupplementalInstanceMetaData

All Implemented Interfaces:

ToSchema

public class SupplementalInstanceMetaData
extends Object
implements ToSchema

Instance-level settings from supplemental modules, for a frontend. This is an explicit allow-list: supplemental instance meta-data objects can carry server configuration (route providers, file-system paths, authenticator classes, etc), so they are never serialized as a whole. Each published setting is copied here, by name, from the module that owns it (read generically, as those modules are not dependencies of this one). Published: - materialDashboard: the processes to add to every query and view screen; - materialDashboardTheme: the application theme (MaterialDashboardThemeMetaData), limited to the visual properties named in THEME_PROPERTY_NAMES (QRun-IO/qqq#719); - assistant: present (as an object) when the instance has supplemental meta-data named "assistant" (registered by the qbit-assistant QBit when it is enabled), so a frontend only probes the assistant's routes when they exist. Its content is available=true plus the string, number and boolean values of the object's optional getFrontendSettings() map, and nothing else.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ASSISTANT_NAME
static final String	MATERIAL_DASHBOARD_NAME
static final String	MATERIAL_DASHBOARD_THEME_NAME
static final List<String>	THEME_PROPERTY_NAMES	////////////////////////////////////////////////////////////////////////////

Constructor Summary

Constructors

Constructor	Description
SupplementalInstanceMetaData()

Method Summary

Modifier and Type	Method	Description
Map<String,Object>	getAssistant()	Getter for assistant
MaterialDashboardInstanceSettings	getMaterialDashboard()	Getter for materialDashboard
Map<String,Object>	getMaterialDashboardTheme()	Getter for materialDashboardTheme
static SupplementalInstanceMetaData	of(MetaDataOutput metaDataOutput)	Build the published supplemental meta-data from a meta-data action's output, or null when the instance has none of the supplemental meta-data that is published (so the property is omitted).
void	setAssistant(Map<String,Object> assistant)	Setter for assistant
void	setMaterialDashboard(MaterialDashboardInstanceSettings materialDashboard)	Setter for materialDashboard
void	setMaterialDashboardTheme(Map<String,Object> materialDashboardTheme)	Setter for materialDashboardTheme
SupplementalInstanceMetaData	withAssistant(Map<String,Object> assistant)	Fluent setter for assistant
SupplementalInstanceMetaData	withMaterialDashboard(MaterialDashboardInstanceSettings materialDashboard)	Fluent setter for materialDashboard
SupplementalInstanceMetaData	withMaterialDashboardTheme(Map<String,Object> materialDashboardTheme)	Fluent setter for materialDashboardTheme

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.schemabuilder.ToSchema

toSchema

Field Details

MATERIAL_DASHBOARD_NAME

public static final String MATERIAL_DASHBOARD_NAME

See Also:

• Constant Field Values

MATERIAL_DASHBOARD_THEME_NAME

public static final String MATERIAL_DASHBOARD_THEME_NAME

See Also:

• Constant Field Values

ASSISTANT_NAME

public static final String ASSISTANT_NAME

See Also:

• Constant Field Values

THEME_PROPERTY_NAMES

public static final List<String> THEME_PROPERTY_NAMES

////////////////////////////////////////////////////////////////////////////

Constructor Details

SupplementalInstanceMetaData

public SupplementalInstanceMetaData()

Method Details

of

public static SupplementalInstanceMetaData of(MetaDataOutput metaDataOutput)

Build the published supplemental meta-data from a meta-data action's output, or null when the instance has none of the supplemental meta-data that is published (so the property is omitted).

getMaterialDashboard

public MaterialDashboardInstanceSettings getMaterialDashboard()

Getter for materialDashboard

setMaterialDashboard

public void setMaterialDashboard(MaterialDashboardInstanceSettings materialDashboard)

Setter for materialDashboard

withMaterialDashboard

public SupplementalInstanceMetaData withMaterialDashboard(MaterialDashboardInstanceSettings materialDashboard)

Fluent setter for materialDashboard

getMaterialDashboardTheme

public Map<String,Object> getMaterialDashboardTheme()

Getter for materialDashboardTheme

setMaterialDashboardTheme

public void setMaterialDashboardTheme(Map<String,Object> materialDashboardTheme)

Setter for materialDashboardTheme

withMaterialDashboardTheme

public SupplementalInstanceMetaData withMaterialDashboardTheme(Map<String,Object> materialDashboardTheme)

Fluent setter for materialDashboardTheme

getAssistant

public Map<String,Object> getAssistant()

Getter for assistant

setAssistant

public void setAssistant(Map<String,Object> assistant)

Setter for assistant

withAssistant

public SupplementalInstanceMetaData withAssistant(Map<String,Object> assistant)

Fluent setter for assistant