io.micronaut.function.aws.runtime

Class AbstractMicronautLambdaRuntime<RequestType,ResponseType,HandlerRequestType,HandlerResponseType>

java.lang.Object

io.micronaut.function.aws.runtime.AbstractMicronautLambdaRuntime<RequestType,ResponseType,HandlerRequestType,HandlerResponseType>

Type Parameters:

RequestType - The expected request object. This is the model class that the event JSON is de-serialized to

ResponseType - The expected Lambda function response object. Responses will be written to this model object

HandlerRequestType - The request type for RequestHandler.

HandlerResponseType - The response type for the RequestHandler.

All Implemented Interfaces:

io.micronaut.context.ApplicationContextProvider, AwsLambdaRuntimeApi

Direct Known Subclasses:

MicronautLambdaRuntime

public abstract class AbstractMicronautLambdaRuntime<RequestType,ResponseType,HandlerRequestType,HandlerResponseType>
extends java.lang.Object
implements io.micronaut.context.ApplicationContextProvider, AwsLambdaRuntimeApi

Class that can be used as a entry point for a AWS Lambda custom runtime.

Since:

2.0.0

Author:

sdelamo

See Also:

Custom AWS Lambda runtimes.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.Object	handler
protected java.lang.Class<HandlerRequestType>	handlerRequestType
protected java.lang.Class<HandlerResponseType>	handlerResponseType
protected java.lang.Class<RequestType>	requestType
protected java.lang.Class<ResponseType>	responseType

Fields inherited from interface io.micronaut.function.aws.runtime.AwsLambdaRuntimeApi

ERROR_TEMPLATE, INIT_ERROR_URI, INVOCATION_TEMPLATE, LAMBDA_RUNTIME_FUNCTION_ERROR_TYPE, NEXT_INVOCATION_URI, PATH_REQUEST_ID

Constructor Summary

Constructors

Constructor and Description
AbstractMicronautLambdaRuntime() Constructor.

Method Summary

Modifier and Type	Method and Description
io.micronaut.context.ApplicationContextBuilder	createApplicationContextBuilderWithArgs(java.lang.String... args)
protected java.lang.Object	createEnvironmentHandler()
protected java.lang.Object	createHandler(java.lang.String... args)
protected HandlerRequestType	createHandlerRequest(RequestType request)
protected com.amazonaws.services.lambda.runtime.RequestHandler<HandlerRequestType,HandlerResponseType>	createRequestHandler(java.lang.String... args)
protected com.amazonaws.services.lambda.runtime.RequestStreamHandler	createRequestStreamHandler(java.lang.String... args)
protected ResponseType	createResponse(HandlerResponseType handlerResponse)
io.micronaut.context.ApplicationContext	getApplicationContext()
protected java.lang.String	getEnv(java.lang.String name)
protected io.micronaut.logging.LogLevel	getLogLevel()
protected void	log(io.micronaut.logging.LogLevel level, java.lang.String msg)
protected void	logn(io.micronaut.logging.LogLevel level, java.lang.Object... messageParts)
protected void	logn(io.micronaut.logging.LogLevel logLevel, java.lang.String msg) Log with a line break.
protected java.util.Optional<java.lang.Class>	parseHandlerClass(java.lang.String handler)
protected void	propagateTraceId(io.micronaut.http.HttpHeaders headers) Get the X-Ray tracing header from the Lambda-Runtime-Trace-Id header in the API response.
protected void	reportInitializationError(java.net.URL runtimeApiURL, java.lang.Throwable e) Reports Initialization error to the Runtime API.
protected com.amazonaws.services.lambda.runtime.events.APIGatewayProxyResponseEvent	respond(io.micronaut.http.HttpStatus status, java.lang.String body, java.lang.String contentType)
void	run(java.lang.String... args) Starts the runtime API event loop.
protected java.lang.String	serializeAsJsonString(java.lang.Object value)
protected boolean	shouldLog(io.micronaut.logging.LogLevel level)
protected void	startRuntimeApiEventLoop(java.net.URL runtimeApiURL, java.util.function.Predicate<java.net.URL> loopUntil, java.lang.String... args) Starts the runtime API event loop.
protected void	validateHandler()
protected <T> T	valueFromContent(java.lang.String content, java.lang.Class<T> valueType)

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.micronaut.function.aws.runtime.AwsLambdaRuntimeApi

errorUri, initializationErrorRequest, invocationErrorRequest, invocationResponseRequest, responseUri

Field Detail

handler

protected java.lang.Object handler

requestType

protected final java.lang.Class<RequestType> requestType

responseType

protected final java.lang.Class<ResponseType> responseType

handlerRequestType

protected final java.lang.Class<HandlerRequestType> handlerRequestType

handlerResponseType

protected final java.lang.Class<HandlerResponseType> handlerResponseType

Constructor Detail

AbstractMicronautLambdaRuntime

public AbstractMicronautLambdaRuntime()

Constructor.

Method Detail

run

public void run(java.lang.String... args)
         throws java.net.MalformedURLException

Starts the runtime API event loop.

Parameters:

args - Command line arguments

Throws:

java.net.MalformedURLException - if the lambda endpoint URL is malformed

validateHandler

protected void validateHandler()
                        throws io.micronaut.context.exceptions.ConfigurationException

Throws:

io.micronaut.context.exceptions.ConfigurationException - if the handler is not of type RequestHandler or RequestStreamHandler

getApplicationContext

public io.micronaut.context.ApplicationContext getApplicationContext()

Specified by:

getApplicationContext in interface io.micronaut.context.ApplicationContextProvider

createApplicationContextBuilderWithArgs

public io.micronaut.context.ApplicationContextBuilder createApplicationContextBuilderWithArgs(java.lang.String... args)

Parameters:

args - command line arguments

Returns:

An ApplicationContextBuilder with the command line arguments as a property source and the environment set to lambda

createRequestHandler

@Nullable
protected com.amazonaws.services.lambda.runtime.RequestHandler<HandlerRequestType,HandlerResponseType> createRequestHandler(java.lang.String... args)

Parameters:

args - Command Line Args

Returns:

a RequestHandler or null.

createRequestStreamHandler

@Nullable
protected com.amazonaws.services.lambda.runtime.RequestStreamHandler createRequestStreamHandler(java.lang.String... args)

Parameters:

args - Command Line Args

Returns:

a RequestStreamHandler or null.

createHandler

@Nullable
protected java.lang.Object createHandler(java.lang.String... args)

Parameters:

args - Command Line Args

Returns:

if createHandler(String...) or createRequestStreamHandler(String...) are implemented, it returns the handler returned by those methods. If they are not, it attempts to instantiate the class referenced by the environment variable ReservedRuntimeEnvironmentVariables.HANDLER via Introspection. Otherwise, it returns null.

createEnvironmentHandler

@Nullable
protected java.lang.Object createEnvironmentHandler()

Returns:

A Handler by instantiating the class referenced by the environment variable ReservedRuntimeEnvironmentVariables.HANDLER via Introspection. Otherwise, it returns null.

parseHandlerClass

protected java.util.Optional<java.lang.Class> parseHandlerClass(@NonNull
                                                                java.lang.String handler)

Parameters:

handler - handler in format file.method, where file is the name of the file without an extension, and method is the name of a method or function that's defined in the file.

Returns:

Empty or an Optional with the referenced class.

createResponse

@Nullable
protected ResponseType createResponse(HandlerResponseType handlerResponse)

Parameters:

handlerResponse - Handler response object

Returns:

If the handlerResponseType and the responseType are identical just returns the supplied object. However, if the response type is of type APIGatewayProxyResponseEvent it attempts to serialized the handler response as a JSON String and set it in the response body. If the object cannot be serialized, a 400 response is returned

respond

protected com.amazonaws.services.lambda.runtime.events.APIGatewayProxyResponseEvent respond(io.micronaut.http.HttpStatus status,
                                                                                            java.lang.String body,
                                                                                            java.lang.String contentType)

Parameters:

status - HTTP Status of the response

body - Body of the response

contentType - HTTP Header Content-Type value

Returns:

a APIGatewayProxyResponseEvent populated with the supplied status, body and content type

createHandlerRequest

@Nullable
protected HandlerRequestType createHandlerRequest(RequestType request)
                                                     throws com.fasterxml.jackson.core.JsonProcessingException,
                                                            com.fasterxml.jackson.databind.JsonMappingException

Parameters:

request - Request obtained from the Runtime API

Returns:

if the request and the handler type are the same, just return the request, if the request is of type APIGatewayProxyRequestEvent it attempts to build an object of type HandlerRequestType with the body of the request, else returns null

Throws:

com.fasterxml.jackson.core.JsonProcessingException - if underlying request body contains invalid content

com.fasterxml.jackson.databind.JsonMappingException - if the request body JSON structure does not match structure expected for result type (or has other mismatch issues)

startRuntimeApiEventLoop

protected void startRuntimeApiEventLoop(@NonNull
                                        java.net.URL runtimeApiURL,
                                        @NonNull
                                        java.util.function.Predicate<java.net.URL> loopUntil,
                                        java.lang.String... args)

Starts the runtime API event loop.

Parameters:

runtimeApiURL - The runtime API URL.

loopUntil - A predicate that allows controlling when the event loop should exit

args - Command Line arguments

propagateTraceId

protected void propagateTraceId(io.micronaut.http.HttpHeaders headers)

Get the X-Ray tracing header from the Lambda-Runtime-Trace-Id header in the API response. Set the _X_AMZN_TRACE_ID environment variable with the same value for the X-Ray SDK to use.

Parameters:

headers - next API Response HTTP Headers

reportInitializationError

protected void reportInitializationError(java.net.URL runtimeApiURL,
                                         java.lang.Throwable e)

Reports Initialization error to the Runtime API.

Parameters:

runtimeApiURL - Runtime API URL

e - Exception thrown

serializeAsJsonString

@Nullable
protected java.lang.String serializeAsJsonString(java.lang.Object value)

Parameters:

value - Object to be serialized

Returns:

A JSON String of the supplied object

valueFromContent

@Nullable
protected <T> T valueFromContent(java.lang.String content,
                                           java.lang.Class<T> valueType)
                                    throws com.fasterxml.jackson.core.JsonProcessingException,
                                           com.fasterxml.jackson.databind.JsonMappingException

Type Parameters:

T - Type to be read into

Parameters:

content - JSON String

valueType - Class Type to be read into

Returns:

a new Class build from the JSON String

Throws:

com.fasterxml.jackson.core.JsonProcessingException - if underlying input contains invalid content

com.fasterxml.jackson.databind.JsonMappingException - if the input JSON structure does not match structure expected for result type (or has other mismatch issues)

getEnv

protected java.lang.String getEnv(java.lang.String name)

Parameters:

name - the name of the environment variable

Returns:

the string value of the variable, or null if the variable is not defined

log

protected void log(io.micronaut.logging.LogLevel level,
                   java.lang.String msg)

Parameters:

level - Log Level

msg - Message to log

getLogLevel

protected io.micronaut.logging.LogLevel getLogLevel()

Returns:

LogLevel for the custom runtime.

logn

protected void logn(io.micronaut.logging.LogLevel logLevel,
                    java.lang.String msg)

Log with a line break.

Parameters:

logLevel - Log level

msg - Message to log

logn

protected void logn(io.micronaut.logging.LogLevel level,
                    java.lang.Object... messageParts)

Parameters:

level - Log Level

messageParts - One or more message parts to concatenate and log if enabled

shouldLog

protected boolean shouldLog(io.micronaut.logging.LogLevel level)

Parameters:

level - Log level

Returns:

where it should log or not