Class ServiceIdentitiesMetaData

java.lang.Object

com.kingsrook.qqq.backend.core.serviceidentity.ServiceIdentitiesMetaData

All Implemented Interfaces:

MetaDataProducerOutput, QMetaDataObject, QSupplementalInstanceMetaData, TopLevelMetaDataInterface, Serializable

public class ServiceIdentitiesMetaData
extends Object
implements QSupplementalInstanceMetaData

The service principals an instance declares (docs/SERVICE-IDENTITY.md). Qbits and hosts add the principals their background work runs as.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ALERT_TYPE_UNAVAILABLE
static final String	HEALTH_CHECK_PREFIX
static final String	NAME
static final Pattern	PRINCIPAL_NAME_PATTERN

Constructor Summary

Constructors

Constructor	Description
ServiceIdentitiesMetaData()

Method Summary

Modifier and Type	Method	Description
static QServicePrincipalMetaData	declare(QInstance qInstance, QServicePrincipalMetaData principal)	Declare a principal on an instance, with the unavailable-principal alert type.
String	getName()
static QServicePrincipalMetaData	getPrincipal(QInstance qInstance, String name)	A declared principal, or null.
Map<String,QServicePrincipalMetaData>	getPrincipals()	Getter for principals
static ServiceIdentitiesMetaData	of(QInstance qInstance)	The instance's service identities meta-data, or null when none declared.
static ServiceIdentitiesMetaData	ofOrWithNew(QInstance qInstance)	The instance's service identities meta-data, adding an empty one if needed.
void	validate(QInstance qInstance, QInstanceValidator validator)
ServiceIdentitiesMetaData	withPrincipal(QServicePrincipalMetaData principal)	Declare a principal.

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_UNAVAILABLE

public static final String ALERT_TYPE_UNAVAILABLE

See Also:

• Constant Field Values

HEALTH_CHECK_PREFIX

public static final String HEALTH_CHECK_PREFIX

See Also:

• Constant Field Values

PRINCIPAL_NAME_PATTERN

public static final Pattern PRINCIPAL_NAME_PATTERN

Constructor Details

ServiceIdentitiesMetaData

public ServiceIdentitiesMetaData()

Method Details

of

public static ServiceIdentitiesMetaData of(QInstance qInstance)

The instance's service identities meta-data, or null when none declared.

ofOrWithNew

public static ServiceIdentitiesMetaData ofOrWithNew(QInstance qInstance)

The instance's service identities meta-data, adding an empty one if needed.

getPrincipal

public static QServicePrincipalMetaData getPrincipal(QInstance qInstance,
 String name)

A declared principal, or null.

getName

public String getName()

Specified by:

getName in interface TopLevelMetaDataInterface

withPrincipal

public ServiceIdentitiesMetaData withPrincipal(QServicePrincipalMetaData principal)

Declare a principal. Declaring the same name twice fails validation.

getPrincipals

public Map<String,QServicePrincipalMetaData> getPrincipals()

Getter for principals

declare

public static QServicePrincipalMetaData declare(QInstance qInstance,
 QServicePrincipalMetaData principal)

Declare a principal on an instance, with the unavailable-principal alert type. The way qbits and hosts add principals.

validate

public void validate(QInstance qInstance,
 QInstanceValidator validator)

Specified by:

validate in interface QSupplementalInstanceMetaData