io.micronaut.function.aws.proxy

Class AbstractLambdaContainerHandler<RequestType,ResponseType,ContainerRequestType,ContainerResponseType>

java.lang.Object

io.micronaut.function.aws.proxy.AbstractLambdaContainerHandler<RequestType,ResponseType,ContainerRequestType,ContainerResponseType>

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 from the container will be written to this model object

ContainerRequestType - The request type for the wrapped Java container

ContainerResponseType - The response or response writer type for the wrapped Java container

Direct Known Subclasses:

MicronautLambdaContainerHandler

public abstract class AbstractLambdaContainerHandler<RequestType,ResponseType,ContainerRequestType,ContainerResponseType>
extends java.lang.Object

Abstract class that declares the basic methods and objects for implementations of LambdaContainerHandler.

Field Summary

Fields

Modifier and Type	Field and Description
protected com.amazonaws.services.lambda.runtime.Context	lambdaContext
static java.lang.String	SERVER_INFO

Constructor Summary

Constructors

Modifier

Constructor and Description

protected

AbstractLambdaContainerHandler(java.lang.Class<RequestType> requestClass, java.lang.Class<ResponseType> responseClass, com.amazonaws.serverless.proxy.RequestReader<RequestType,ContainerRequestType> requestReader, com.amazonaws.serverless.proxy.ResponseWriter<ContainerResponseType,ResponseType> responseWriter, com.amazonaws.serverless.proxy.SecurityContextWriter<RequestType> securityContextWriter, com.amazonaws.serverless.proxy.ExceptionHandler<ResponseType> exceptionHandler) Default constructor.

Method Summary

Modifier and Type	Method and Description
static com.amazonaws.serverless.proxy.model.ContainerConfig	getContainerConfig() Returns the current container configuration object.
protected abstract ContainerResponseType	getContainerResponse(ContainerRequestType request, java.util.concurrent.CountDownLatch latch) Get the container response.
protected abstract void	handleRequest(ContainerRequestType containerRequest, ContainerResponseType containerResponse, com.amazonaws.services.lambda.runtime.Context lambdaContext) Handle the request.
abstract void	initialize() Initialize the container.
protected abstract com.fasterxml.jackson.databind.ObjectMapper	objectMapper() The object mapper.
ResponseType	proxy(RequestType request, com.amazonaws.services.lambda.runtime.Context context) Proxies requests to the underlying container given the incoming Lambda request.
void	proxyStream(java.io.InputStream input, java.io.OutputStream output, com.amazonaws.services.lambda.runtime.Context context) Handles Lambda RequestStreamHandler method.
protected abstract com.fasterxml.jackson.databind.ObjectReader	readerFor(java.lang.Class<RequestType> requestClass) Gets a reader for the given request class.
void	setLogFormatter(com.amazonaws.serverless.proxy.LogFormatter<ContainerRequestType,ContainerResponseType> formatter) Sets the formatter used to log request data in CloudWatch.
void	stripBasePath(java.lang.String basePath) Configures the library to strip a base path from incoming requests before passing them on to the wrapped framework.
protected abstract com.fasterxml.jackson.databind.ObjectWriter	writerFor(java.lang.Class<ResponseType> responseClass) Gets a writer for the given response class.

Methods inherited from class java.lang.Object

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

Field Detail

SERVER_INFO

public static final java.lang.String SERVER_INFO

See Also:

Constant Field Values

lambdaContext

protected com.amazonaws.services.lambda.runtime.Context lambdaContext

Constructor Detail

AbstractLambdaContainerHandler

protected AbstractLambdaContainerHandler(java.lang.Class<RequestType> requestClass,
                                         java.lang.Class<ResponseType> responseClass,
                                         com.amazonaws.serverless.proxy.RequestReader<RequestType,ContainerRequestType> requestReader,
                                         com.amazonaws.serverless.proxy.ResponseWriter<ContainerResponseType,ResponseType> responseWriter,
                                         com.amazonaws.serverless.proxy.SecurityContextWriter<RequestType> securityContextWriter,
                                         com.amazonaws.serverless.proxy.ExceptionHandler<ResponseType> exceptionHandler)

Default constructor.

Parameters:

requestClass - The request class

responseClass - The response class

requestReader - The request reader

responseWriter - The response writer

securityContextWriter - The security context writer

exceptionHandler - The exception handler

Method Detail

objectMapper

protected abstract com.fasterxml.jackson.databind.ObjectMapper objectMapper()

The object mapper.

Returns:

Return the object mapper.

writerFor

protected abstract com.fasterxml.jackson.databind.ObjectWriter writerFor(java.lang.Class<ResponseType> responseClass)

Gets a writer for the given response class.

Parameters:

responseClass - The response class

Returns:

The writer

readerFor

protected abstract com.fasterxml.jackson.databind.ObjectReader readerFor(java.lang.Class<RequestType> requestClass)

Gets a reader for the given request class.

Parameters:

requestClass - The request class

Returns:

The reader

getContainerResponse

protected abstract ContainerResponseType getContainerResponse(ContainerRequestType request,
                                                              java.util.concurrent.CountDownLatch latch)

Get the container response.

Parameters:

request - The request

latch - The count down latch

Returns:

The response

handleRequest

protected abstract void handleRequest(ContainerRequestType containerRequest,
                                      ContainerResponseType containerResponse,
                                      com.amazonaws.services.lambda.runtime.Context lambdaContext)
                               throws java.lang.Exception

Handle the request.

Parameters:

containerRequest - The container request

containerResponse - The response

lambdaContext - The lambda context

Throws:

java.lang.Exception - The exception

initialize

public abstract void initialize()
                         throws com.amazonaws.serverless.exceptions.ContainerInitializationException

Initialize the container.

Throws:

com.amazonaws.serverless.exceptions.ContainerInitializationException - when an error occurs

stripBasePath

public void stripBasePath(java.lang.String basePath)

Configures the library to strip a base path from incoming requests before passing them on to the wrapped framework. This was added in response to issue #34 (https://github.com/awslabs/aws-serverless-java-container/issues/34). When creating a base path mapping for custom domain names in API Gateway we want to be able to strip the base path from the request - the underlying service may not recognize this path.

Parameters:

basePath - The base path to be stripped from the request

setLogFormatter

public void setLogFormatter(com.amazonaws.serverless.proxy.LogFormatter<ContainerRequestType,ContainerResponseType> formatter)

Sets the formatter used to log request data in CloudWatch. By default this is set to use an Apache combined log format based on the servlet request and response object com.amazonaws.serverless.proxy.internal.servlet.ApacheCombinedServletLogFormatter.

Parameters:

formatter - The log formatter object

proxy

public ResponseType proxy(RequestType request,
                          com.amazonaws.services.lambda.runtime.Context context)

Proxies requests to the underlying container given the incoming Lambda request. This method returns a populated return object for the Lambda function.

Parameters:

request - The incoming Lambda request

context - The execution context for the Lambda function

Returns:

A valid response type

proxyStream

public void proxyStream(java.io.InputStream input,
                        java.io.OutputStream output,
                        com.amazonaws.services.lambda.runtime.Context context)
                 throws java.io.IOException

Handles Lambda RequestStreamHandler method. The method uses an ObjectMapper to transform the incoming input stream into the given RequestType and then calls the proxy(Object, Context) method to handle the request. The output from the proxy method is written on the given output stream.

Parameters:

input - Lambda's incoming input stream

output - Lambda's response output stream

context - Lambda's context object

Throws:

java.io.IOException - If an error occurs during the stream processing

getContainerConfig

public static com.amazonaws.serverless.proxy.model.ContainerConfig getContainerConfig()

Returns the current container configuration object.

Returns:

The container configuration object