Class AlertsInstanceMetaData

java.lang.Object

com.kingsrook.qqq.backend.core.alerts.AlertsInstanceMetaData

All Implemented Interfaces:

MetaDataProducerOutput, QMetaDataObject, QSupplementalInstanceMetaData, TopLevelMetaDataInterface, Serializable

public class AlertsInstanceMetaData
extends Object
implements QSupplementalInstanceMetaData

Instance-level alerts meta-data: the sink that QAlerts sends signals to (default: LoggingAlertSink) and every declared QAlertTypeMetaData. It is supplemental meta-data, so any module or qbit can add to it.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final Pattern	ALERT_TYPE_NAME_PATTERN	alert type names: lowercase, dotted, at least two segments.
static final String	NAME

Constructor Summary

Constructors

Constructor	Description
AlertsInstanceMetaData()

Method Summary

Modifier and Type	Method	Description
QAlertTypeMetaData	getAlertType(String name)	Find a declared type by name, or null.
Map<String,QAlertTypeMetaData>	getAlertTypes()	Getter for alertTypes
String	getName()
QCodeReference	getSink()	Getter for sink
static AlertsInstanceMetaData	of(QInstance qInstance)	Get the instance's alerts meta-data, or null when nothing added it.
static AlertsInstanceMetaData	ofOrWithNew(QInstance qInstance)	Get the instance's alerts meta-data, adding an empty one if it has none.
void	validate(QInstance qInstance, QInstanceValidator validator)	Names must be unique and well-formed, subject tables must exist, a visibility permission must not be blank, heartbeat default monitors need an interval, and the sink must implement AlertSinkInterface.
AlertsInstanceMetaData	withAlertType(QAlertTypeMetaData alertType)	Declare an alert type.
AlertsInstanceMetaData	withSink(QCodeReference sink)	Fluent setter for sink - an AlertSinkInterface implementation.

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

ALERT_TYPE_NAME_PATTERN

public static final Pattern ALERT_TYPE_NAME_PATTERN

alert type names: lowercase, dotted, at least two segments.

Constructor Details

AlertsInstanceMetaData

public AlertsInstanceMetaData()

Method Details

of

public static AlertsInstanceMetaData of(QInstance qInstance)

Get the instance's alerts meta-data, or null when nothing added it.

ofOrWithNew

public static AlertsInstanceMetaData ofOrWithNew(QInstance qInstance)

Get the instance's alerts meta-data, adding an empty one if it has none.

getName

public String getName()

Specified by:

getName in interface TopLevelMetaDataInterface

getSink

public QCodeReference getSink()

Getter for sink

withSink

public AlertsInstanceMetaData withSink(QCodeReference sink)

Fluent setter for sink - an AlertSinkInterface implementation. An alerts implementation sets this; producers never do.

getAlertTypes

public Map<String,QAlertTypeMetaData> getAlertTypes()

Getter for alertTypes

getAlertType

public QAlertTypeMetaData getAlertType(String name)

Find a declared type by name, or null.

withAlertType

public AlertsInstanceMetaData withAlertType(QAlertTypeMetaData alertType)

Declare an alert type. Adding the same object again is a no-op; adding a different type with a name already taken is a validation error.

validate

public void validate(QInstance qInstance,
 QInstanceValidator validator)

Names must be unique and well-formed, subject tables must exist, a visibility permission must not be blank, heartbeat default monitors need an interval, and the sink must implement AlertSinkInterface.

Specified by:

validate in interface QSupplementalInstanceMetaData