Package io.micronaut.starter.feature.awslambdacustomruntime

Class AwsLambdaCustomRuntime

java.lang.Object

io.micronaut.starter.feature.awslambdacustomruntime.AwsLambdaCustomRuntime

All Implemented Interfaces:

io.micronaut.core.naming.Described, io.micronaut.core.naming.Named, io.micronaut.core.order.Ordered, Feature, ApplicationFeature, AwsCloudFeature, CloudFeature, FunctionFeature

@Requires(property="micronaut.starter.feature.aws.lambda.custom.runtime.enabled",
          value="true",
          defaultValue="true")
@Singleton
public class AwsLambdaCustomRuntime
extends Object
implements FunctionFeature, ApplicationFeature, AwsCloudFeature

Field Summary

Fields

Modifier and Type	Field	Description
static final Dependency	DEPENDENCY_AWS_FUNCTION_AWS_CUSTOM_RUNTIME
static final String	FEATURE_NAME_AWS_LAMBDA_CUSTOM_RUNTIME
static final String	MAIN_CLASS_NAME

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

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor	Description
AwsLambdaCustomRuntime(jakarta.inject.Provider<AwsLambda> awsLambda, HttpClientJdk httpClientJdk)

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	getCategory()
@NonNull String	getDescription()
String	getFrameworkDocumentation(GeneratorContext generatorContext)
@NonNull String	getName()	The name of the feature.
String	getThirdPartyDocumentation(GeneratorContext generatorContext)
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(io.micronaut.starter.options.Options, java.util.Set).
boolean	shouldGenerateMainClassForRuntime(GeneratorContext generatorContext)

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.micronaut.starter.feature.aws.AwsCloudFeature

getCloud

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

getDescription

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

getOrder, isCommunity, isPreview

Methods inherited from interface io.micronaut.starter.feature.function.FunctionFeature

supports

Field Details

DEPENDENCY_AWS_FUNCTION_AWS_CUSTOM_RUNTIME

public static final Dependency DEPENDENCY_AWS_FUNCTION_AWS_CUSTOM_RUNTIME

MAIN_CLASS_NAME

public static final String MAIN_CLASS_NAME

See Also:

• Constant Field Values

FEATURE_NAME_AWS_LAMBDA_CUSTOM_RUNTIME

public static final String FEATURE_NAME_AWS_LAMBDA_CUSTOM_RUNTIME

See Also:

• Constant Field Values

Constructor Details

AwsLambdaCustomRuntime

public AwsLambdaCustomRuntime(jakarta.inject.Provider<AwsLambda> awsLambda,
 HttpClientJdk httpClientJdk)

Method Details

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(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

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 be able to be selected by the user

getTitle

public String getTitle()

Specified by:

getTitle in interface Feature

Returns:

The title of the feature

getDescription

@NonNull
public @NonNull String getDescription()

Specified by:

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

Specified by:

getDescription in interface 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.

Specified by:

apply in interface ApplicationFeature

Specified by:

apply in interface Feature

Parameters:

generatorContext - THe generator context

shouldGenerateMainClassForRuntime

public boolean shouldGenerateMainClassForRuntime(GeneratorContext generatorContext)

mainClassName

@Nullable
public @Nullable String mainClassName(GeneratorContext generatorContext)

Specified by:

mainClassName in interface ApplicationFeature

getCategory

public String getCategory()

Specified by:

getCategory in interface Feature

Specified by:

getCategory in interface FunctionFeature

Returns:

The Category to which the feature belongs to.

getFrameworkDocumentation

public String getFrameworkDocumentation(GeneratorContext generatorContext)

Specified by:

getFrameworkDocumentation in interface Feature

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