Package com.amazonaws.serverless.proxy.spring

Class SpringBootLambdaContainerHandler<RequestType,ResponseType>

java.lang.Object

com.amazonaws.serverless.proxy.internal.LambdaContainerHandler<RequestType,ResponseType,ContainerRequestType,ContainerResponseType>

com.amazonaws.serverless.proxy.internal.servlet.AwsLambdaServletContainerHandler<RequestType,ResponseType,jakarta.servlet.http.HttpServletRequest,AwsHttpServletResponse>

com.amazonaws.serverless.proxy.spring.SpringBootLambdaContainerHandler<RequestType,ResponseType>

Type Parameters:

RequestType - The incoming event type

ResponseType - The expected return type

All Implemented Interfaces:

InitializableLambdaContainerHandler

public class SpringBootLambdaContainerHandler<RequestType,ResponseType>
extends AwsLambdaServletContainerHandler<RequestType,ResponseType,jakarta.servlet.http.HttpServletRequest,AwsHttpServletResponse>

SpringBoot implementation of the `LambdaContainerHandler` abstract class. This class uses the `LambdaSpringApplicationInitializer` object behind the scenes to proxy requests. The default implementation leverages the `AwsProxyHttpServletRequest` and `AwsHttpServletResponse` implemented in the `aws-serverless-java-container-core` package. Important: Make sure to add LambdaFlushResponseListener in your SpringBootServletInitializer subclass configure().

Nested Class Summary

Nested classes/interfaces inherited from class com.amazonaws.serverless.proxy.internal.servlet.AwsLambdaServletContainerHandler

AwsLambdaServletContainerHandler.StartupHandler

Field Summary

Fields inherited from class com.amazonaws.serverless.proxy.internal.servlet.AwsLambdaServletContainerHandler

servletContext, startupHandler

Fields inherited from class com.amazonaws.serverless.proxy.internal.LambdaContainerHandler

lambdaContext, SERVER_INFO

Constructor Summary

Constructors

Constructor

Description

SpringBootLambdaContainerHandler(Class<RequestType> requestTypeClass, Class<ResponseType> responseTypeClass, RequestReader<RequestType,jakarta.servlet.http.HttpServletRequest> requestReader, ResponseWriter<AwsHttpServletResponse,ResponseType> responseWriter, SecurityContextWriter<RequestType> securityContextWriter, ExceptionHandler<ResponseType> exceptionHandler, Class<?> springBootInitializer, InitializationWrapper init, org.springframework.boot.WebApplicationType applicationType)

Creates a new container handler with the given reader and writer objects

Method Summary

Modifier and Type	Method	Description
void	activateSpringProfiles(String... profiles)
static SpringBootLambdaContainerHandler<AwsProxyRequest,AwsProxyResponse>	getAwsProxyHandler(Class<?> springBootInitializer, String... profiles)	Creates a default SpringLambdaContainerHandler initialized with the `AwsProxyRequest` and `AwsProxyResponse` objects and the given Spring profiles
protected AwsHttpServletResponse	getContainerResponse(jakarta.servlet.http.HttpServletRequest request, CountDownLatch latch)
static SpringBootLambdaContainerHandler<HttpApiV2ProxyRequest,AwsProxyResponse>	getHttpApiV2ProxyHandler(Class<?> springBootInitializer, String... profiles)	Creates a default SpringLambdaContainerHandler initialized with the `AwsProxyRequest` and `HttpApiV2ProxyRequest` objects and the given Spring profiles
static SpringBootLambdaContainerHandler	getInstance()	We need to rely on the static instance of this for SpringBoot because we need it to access the ServletContext.
protected void	handleRequest(jakarta.servlet.http.HttpServletRequest containerRequest, AwsHttpServletResponse containerResponse, com.amazonaws.services.lambda.runtime.Context lambdaContext)
void	initialize()

Methods inherited from class com.amazonaws.serverless.proxy.internal.servlet.AwsLambdaServletContainerHandler

doFilter, getFilterChain, getServletContext, onStartup, setServletContext

Methods inherited from class com.amazonaws.serverless.proxy.internal.LambdaContainerHandler

getContainerConfig, getInitializationWrapper, getObjectMapper, proxy, proxyStream, setInitializationWrapper, setLogFormatter, stripBasePath

Methods inherited from class java.lang.Object

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

Constructor Details

SpringBootLambdaContainerHandler

public SpringBootLambdaContainerHandler(Class<RequestType> requestTypeClass,
 Class<ResponseType> responseTypeClass,
 RequestReader<RequestType,jakarta.servlet.http.HttpServletRequest> requestReader,
 ResponseWriter<AwsHttpServletResponse,ResponseType> responseWriter,
 SecurityContextWriter<RequestType> securityContextWriter,
 ExceptionHandler<ResponseType> exceptionHandler,
 Class<?> springBootInitializer,
 InitializationWrapper init,
 org.springframework.boot.WebApplicationType applicationType)

Creates a new container handler with the given reader and writer objects

Parameters:

requestTypeClass - The class for the incoming Lambda event

responseTypeClass - The class for the Lambda function output

requestReader - An implementation of `RequestReader`

responseWriter - An implementation of `ResponseWriter`

securityContextWriter - An implementation of `SecurityContextWriter`

exceptionHandler - An implementation of `ExceptionHandler`

springBootInitializer - SpringBootServletInitializer class

init - The initialization Wrapper that will be used to start Spring Boot

applicationType - The Spring Web Application Type

Method Details

getInstance

public static SpringBootLambdaContainerHandler getInstance()

We need to rely on the static instance of this for SpringBoot because we need it to access the ServletContext. Normally, SpringBoot would initialize its own embedded container through the SpringApplication.run() method. However, in our case we need to rely on the pre-initialized handler and need to fetch information from it for our mock ServerlessReactiveServletEmbeddedServerFactory.

Returns:

The initialized instance

getAwsProxyHandler

public static SpringBootLambdaContainerHandler<AwsProxyRequest,AwsProxyResponse> getAwsProxyHandler(Class<?> springBootInitializer,
 String... profiles)
                                                                                             throws ContainerInitializationException

Creates a default SpringLambdaContainerHandler initialized with the `AwsProxyRequest` and `AwsProxyResponse` objects and the given Spring profiles

Parameters:

springBootInitializer - SpringBootServletInitializer class

profiles - A list of Spring profiles to activate

Returns:

An initialized instance of the `SpringLambdaContainerHandler`

Throws:

ContainerInitializationException - If an error occurs while initializing the Spring framework

getHttpApiV2ProxyHandler

public static SpringBootLambdaContainerHandler<HttpApiV2ProxyRequest,AwsProxyResponse> getHttpApiV2ProxyHandler(Class<?> springBootInitializer,
 String... profiles)
                                                                                                         throws ContainerInitializationException

Creates a default SpringLambdaContainerHandler initialized with the `AwsProxyRequest` and `HttpApiV2ProxyRequest` objects and the given Spring profiles

Parameters:

springBootInitializer - SpringBootServletInitializer class

profiles - A list of Spring profiles to activate

Returns:

An initialized instance of the `SpringLambdaContainerHandler`

Throws:

ContainerInitializationException - If an error occurs while initializing the Spring framework

activateSpringProfiles

public void activateSpringProfiles(String... profiles)

getContainerResponse

protected AwsHttpServletResponse getContainerResponse(jakarta.servlet.http.HttpServletRequest request,
 CountDownLatch latch)

Specified by:

getContainerResponse in class LambdaContainerHandler<RequestType,ResponseType,jakarta.servlet.http.HttpServletRequest,AwsHttpServletResponse>

handleRequest

protected void handleRequest(jakarta.servlet.http.HttpServletRequest containerRequest,
 AwsHttpServletResponse containerResponse,
 com.amazonaws.services.lambda.runtime.Context lambdaContext)
                      throws Exception

Specified by:

handleRequest in class LambdaContainerHandler<RequestType,ResponseType,jakarta.servlet.http.HttpServletRequest,AwsHttpServletResponse>

Throws:

Exception

initialize

public void initialize()
                throws ContainerInitializationException

Specified by:

initialize in interface InitializableLambdaContainerHandler

Overrides:

initialize in class AwsLambdaServletContainerHandler<RequestType,ResponseType,jakarta.servlet.http.HttpServletRequest,AwsHttpServletResponse>

Throws:

ContainerInitializationException