Package io.micronaut.starter.feature.messaging.mqtt

Class MqttHiveMq

java.lang.Object

io.micronaut.starter.feature.testresources.EaseTestingFeature

io.micronaut.starter.feature.messaging.mqtt.MqttHiveMq

All Implemented Interfaces:

io.micronaut.core.naming.Described, io.micronaut.core.naming.Named, io.micronaut.core.order.Ordered, Feature, MessagingFeature, MqttFeature, SharedTestResourceFeature

@Requires(property="micronaut.starter.feature.mqtt.hivemq.enabled",
          value="true",
          defaultValue="true")
@Singleton
public class MqttHiveMq
extends EaseTestingFeature
implements MqttFeature, SharedTestResourceFeature

Field Summary

Fields

Modifier and Type	Field	Description
static final String	NAME

Fields inherited from interface io.micronaut.core.order.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor	Description
MqttHiveMq(TestContainers testContainers, TestResources testResources)

Method Summary

Modifier and Type	Method	Description
void	apply(GeneratorContext generatorContext)	If this method is called for a given feature that means the feature was explicitly selected, included by default as a result of DefaultFeature.shouldApply(io.micronaut.starter.options.Options, java.util.Set), or added explicitly by another feature through FeatureContext.addFeature(Feature).
String	getDescription()
String	getFrameworkDocumentation(GeneratorContext generatorContext)
@NonNull String	getName()	The name of the feature.
String	getThirdPartyDocumentation(GeneratorContext generatorContext)
String	getTitle()

Methods inherited from class io.micronaut.starter.feature.testresources.EaseTestingFeature

processSelectedFeatures

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.micronaut.core.naming.Described

getDescription

Methods inherited from interface io.micronaut.projectgen.core.feature.Feature

getOrder, isCommunity, isPreview, isVisible, processSelectedFeatures, supports

Methods inherited from interface io.micronaut.starter.feature.messaging.MessagingFeature

getCategory

Field Details

NAME

public static final String NAME

See Also:

• Constant Field Values

Constructor Details

MqttHiveMq

public MqttHiveMq(TestContainers testContainers,
 TestResources testResources)

Method Details

getDescription

public String getDescription()

Specified by:

getDescription in interface io.micronaut.core.naming.Described

Specified by:

getDescription in interface Feature

Specified by:

getDescription in interface MqttFeature

getName

@NonNull
public @NonNull String getName()

Description copied from interface: Feature

The name of the feature. It must be unique.

Specified by:

getName in interface Feature

Specified by:

getName in interface io.micronaut.core.naming.Named

Returns:

the name of the feature

getTitle

public String getTitle()

Specified by:

getTitle in interface Feature

Returns:

The title of the feature

apply

public void apply(GeneratorContext generatorContext)

Description copied from interface: Feature

If this method is called for a given feature that means the feature was explicitly selected, included by default as a result of DefaultFeature.shouldApply(io.micronaut.starter.options.Options, java.util.Set), or added explicitly by another feature through FeatureContext.addFeature(Feature). At this point the feature list is set and cannot change. This method can be implemented to modify the generated project. The feature can add templates by executing GeneratorContext.addTemplate(String, io.micronaut.starter.template.Template), modify configuration by modifying GeneratorContext.getConfiguration() or GeneratorContext.getBootstrapConfiguration(), or modify build properties through GeneratorContext.getBuildProperties().

Specified by:

apply in interface Feature

Specified by:

apply in interface MqttFeature

Parameters:

generatorContext - THe generator context

getFrameworkDocumentation

public String getFrameworkDocumentation(GeneratorContext generatorContext)

Specified by:

getFrameworkDocumentation in interface Feature

Specified by:

getFrameworkDocumentation in interface MqttFeature

Parameters:

generatorContext - Generator Context

Returns:

Returns a link to Framework documentation about the feature. eg. https://micronaut-projects.github.io/micronaut-cache/latest/guide/index.html#hazelcast

getThirdPartyDocumentation

public String getThirdPartyDocumentation(GeneratorContext generatorContext)

Specified by:

getThirdPartyDocumentation in interface Feature

Parameters:

generatorContext - Generator Context

Returns:

Returns a link to third party. E.g. https://hazelcast.org