Package io.micronaut.starter.feature.kotlin

Class Ktor

java.lang.Object

io.micronaut.starter.feature.kotlin.Ktor

All Implemented Interfaces:

io.micronaut.core.naming.Described, io.micronaut.core.naming.Named, io.micronaut.core.order.Ordered, ApplicationFeature, Feature, KotlinSpecificFeature, KotlinApplicationFeature, LanguageSpecificFeature, OneOfFeature, ServerFeature, ThirdPartyServerFeature

@Singleton
public class Ktor
extends Object
implements KotlinApplicationFeature, ThirdPartyServerFeature, KotlinSpecificFeature

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ARTIFACT_ID_KTOR_SERIALIZATION_JACKSON
static final String	ARTIFACT_ID_KTOR_SERVER_CONTENT_NEGOTIATION
static final String	ARTIFACT_ID_KTOR_SERVER_NETTY
static final String	GROUP_ID_IO_KTOR
static final String	NAME

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

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor	Description
Ktor(CoordinateResolver coordinateResolver)

Method Summary

Modifier and Type	Method	Description
protected void	addDependencies(@NonNull GeneratorContext generatorContext)
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(ApplicationType, io.micronaut.starter.options.Options, java.util.Set), or added explicitly by another feature through FeatureContext.addFeature(Feature).
String	getCategory()
String	getDescription()
String	getMicronautDocumentation()
@NonNull String	getName()	The name of the feature.
String	getTitle()
boolean	isVisible()	Some features should not be visible to the user because they are a common parent of other selectable features, or they should always be applied, or any other reason.
@Nullable String	mainClassName(GeneratorContext generatorContext)
void	processSelectedFeatures(FeatureContext featureContext)	If this method is called for a given feature then that feature was explicitly selected or was included by default as a result of DefaultFeature.shouldApply(ApplicationType, io.micronaut.starter.options.Options, java.util.Set).
boolean	supports(ApplicationType applicationType)	This method must be implemented to ensure it is only selectable for the desired application types.

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.starter.feature.Feature

getThirdPartyDocumentation, isCommunity, isPreview

Methods inherited from interface io.micronaut.starter.feature.lang.kotlin.KotlinApplicationFeature

getOrder

Methods inherited from interface io.micronaut.starter.feature.KotlinSpecificFeature

getRequiredLanguage

Methods inherited from interface io.micronaut.starter.feature.server.ServerFeature

getFeatureClass

Field Details

NAME

public static final String NAME

See Also:

• Constant Field Values

GROUP_ID_IO_KTOR

public static final String GROUP_ID_IO_KTOR

See Also:

• Constant Field Values

ARTIFACT_ID_KTOR_SERVER_NETTY

public static final String ARTIFACT_ID_KTOR_SERVER_NETTY

See Also:

• Constant Field Values

ARTIFACT_ID_KTOR_SERIALIZATION_JACKSON

public static final String ARTIFACT_ID_KTOR_SERIALIZATION_JACKSON

See Also:

• Constant Field Values

ARTIFACT_ID_KTOR_SERVER_CONTENT_NEGOTIATION

public static final String ARTIFACT_ID_KTOR_SERVER_CONTENT_NEGOTIATION

See Also:

• Constant Field Values

Constructor Details

Ktor

public Ktor(CoordinateResolver coordinateResolver)

Method Details

supports

public boolean supports(ApplicationType applicationType)

Description copied from interface: Feature

This method must be implemented to ensure it is only selectable for the desired application types. This method is not used for determining if a default feature should be applied.

Specified by:

supports in interface Feature

Specified by:

supports in interface ServerFeature

Parameters:

applicationType - The application type

Returns:

True if the feature can be selected by the user

processSelectedFeatures

public void processSelectedFeatures(FeatureContext featureContext)

Description copied from interface: Feature

If this method is called for a given feature then that feature was explicitly selected or was included by default as a result of DefaultFeature.shouldApply(ApplicationType, io.micronaut.starter.options.Options, java.util.Set). This method can be implemented to allow features to modify the list of features that will apply to the project. The methods FeatureContext.addFeature(Feature) and FeatureContext.exclude(FeaturePredicate) are the primary ways to add and remove features from the context. FeatureContext.isPresent(Class) can be used to determine the existence of other features in order to make decisions.

Specified by:

processSelectedFeatures in interface Feature

Parameters:

featureContext - The feature context

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

getDescription

public String getDescription()

Specified by:

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

Specified by:

getDescription in interface Feature

getTitle

public String getTitle()

Specified by:

getTitle in interface Feature

Returns:

The title of the feature

getCategory

public String getCategory()

Specified by:

getCategory in interface Feature

Specified by:

getCategory in interface ServerFeature

Returns:

The Category to which the feature belongs to.

mainClassName

@Nullable
public @Nullable String mainClassName(GeneratorContext generatorContext)

Specified by:

mainClassName in interface ApplicationFeature

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(ApplicationType, 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 ApplicationFeature

Specified by:

apply in interface Feature

Parameters:

generatorContext - THe generator context

addDependencies

protected void addDependencies(@NonNull
 @NonNull GeneratorContext generatorContext)

isVisible

public boolean isVisible()

Description copied from interface: Feature

Some features should not be visible to the user because they are a common parent of other selectable features, or they should always be applied, or any other reason.

Specified by:

isVisible in interface ApplicationFeature

Specified by:

isVisible in interface Feature

Returns:

True if the feature should able to be selected by the user

getMicronautDocumentation

public String getMicronautDocumentation()

Specified by:

getMicronautDocumentation in interface Feature

Returns:

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