com.amazonaws.serverless.proxy.spring

Class SpringLambdaContainerHandler<RequestType,ResponseType>

java.lang.Object

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

com.amazonaws.serverless.proxy.internal.servlet.AwsLambdaServletContainerHandler<RequestType,ResponseType,AwsProxyHttpServletRequest,AwsHttpServletResponse>

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

Type Parameters:

RequestType - The incoming event type

ResponseType - The expected return type

public class SpringLambdaContainerHandler<RequestType,ResponseType>
extends AwsLambdaServletContainerHandler<RequestType,ResponseType,AwsProxyHttpServletRequest,AwsHttpServletResponse>

Spring 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.

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 and Description

SpringLambdaContainerHandler(java.lang.Class<RequestType> requestTypeClass, java.lang.Class<ResponseType> responseTypeClass, RequestReader<RequestType,AwsProxyHttpServletRequest> requestReader, ResponseWriter<AwsHttpServletResponse,ResponseType> responseWriter, SecurityContextWriter<RequestType> securityContextWriter, ExceptionHandler<ResponseType> exceptionHandler, org.springframework.web.context.ConfigurableWebApplicationContext applicationContext) Creates a new container handler with the given reader and writer objects

Method Summary

Modifier and Type	Method and Description
void	activateSpringProfiles(java.lang.String... profiles) Activates the given Spring profiles in the application.
LambdaSpringApplicationInitializer	getApplicationInitializer() Returns the custom web application initializer used by the object.
static SpringLambdaContainerHandler<AwsProxyRequest,AwsProxyResponse>	getAwsProxyHandler(java.lang.Class... config) Creates a default SpringLambdaContainerHandler initialized with the `AwsProxyRequest` and `AwsProxyResponse` objects
static SpringLambdaContainerHandler<AwsProxyRequest,AwsProxyResponse>	getAwsProxyHandler(org.springframework.web.context.ConfigurableWebApplicationContext applicationContext) Creates a default SpringLambdaContainerHandler initialized with the `AwsProxyRequest` and `AwsProxyResponse` objects
static SpringLambdaContainerHandler<AwsProxyRequest,AwsProxyResponse>	getAwsProxyHandler(org.springframework.web.context.ConfigurableWebApplicationContext applicationContext, java.lang.String... profiles) Creates a default SpringLambdaContainerHandler initialized with the `AwsProxyRequest` and `AwsProxyResponse` objects and sets the given profiles as active
protected AwsHttpServletResponse	getContainerResponse(AwsProxyHttpServletRequest request, java.util.concurrent.CountDownLatch latch)
protected void	handleRequest(AwsProxyHttpServletRequest containerRequest, AwsHttpServletResponse containerResponse, com.amazonaws.services.lambda.runtime.Context lambdaContext)
void	initialize()
void	setRefreshContext(boolean refreshContext) Asks the custom web application initializer to refresh the Spring context.

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

doFilter, forward, getFilterChain, getServletContext, include, onStartup, setServletContext

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

getContainerConfig, getObjectMapper, proxy, proxyStream, setLogFormatter, stripBasePath

Methods inherited from class java.lang.Object

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

Constructor Detail

SpringLambdaContainerHandler

public SpringLambdaContainerHandler(java.lang.Class<RequestType> requestTypeClass,
                                    java.lang.Class<ResponseType> responseTypeClass,
                                    RequestReader<RequestType,AwsProxyHttpServletRequest> requestReader,
                                    ResponseWriter<AwsHttpServletResponse,ResponseType> responseWriter,
                                    SecurityContextWriter<RequestType> securityContextWriter,
                                    ExceptionHandler<ResponseType> exceptionHandler,
                                    org.springframework.web.context.ConfigurableWebApplicationContext applicationContext)
                             throws ContainerInitializationException

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

Parameters:

requestTypeClass - The class for the incoming Lambda event

requestReader - An implementation of `RequestReader`

responseWriter - An implementation of `ResponseWriter`

securityContextWriter - An implementation of `SecurityContextWriter`

exceptionHandler - An implementation of `ExceptionHandler`

Throws:

ContainerInitializationException

Method Detail

getAwsProxyHandler

public static SpringLambdaContainerHandler<AwsProxyRequest,AwsProxyResponse> getAwsProxyHandler(java.lang.Class... config)
                                                                                         throws ContainerInitializationException

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

Parameters:

config - A set of classes annotated with the Spring @Configuration annotation

Returns:

An initialized instance of the `SpringLambdaContainerHandler`

Throws:

ContainerInitializationException

getAwsProxyHandler

public static SpringLambdaContainerHandler<AwsProxyRequest,AwsProxyResponse> getAwsProxyHandler(org.springframework.web.context.ConfigurableWebApplicationContext applicationContext)
                                                                                         throws ContainerInitializationException

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

Parameters:

applicationContext - A custom ConfigurableWebApplicationContext to be used

Returns:

An initialized instance of the `SpringLambdaContainerHandler`

Throws:

ContainerInitializationException

getAwsProxyHandler

public static SpringLambdaContainerHandler<AwsProxyRequest,AwsProxyResponse> getAwsProxyHandler(org.springframework.web.context.ConfigurableWebApplicationContext applicationContext,
                                                                                                java.lang.String... profiles)
                                                                                         throws ContainerInitializationException

Creates a default SpringLambdaContainerHandler initialized with the `AwsProxyRequest` and `AwsProxyResponse` objects and sets the given profiles as active

Parameters:

applicationContext - A custom ConfigurableWebApplicationContext to be used

profiles - The spring profiles to activate

Returns:

An initialized instance of the `SpringLambdaContainerHandler`

Throws:

ContainerInitializationException

setRefreshContext

public void setRefreshContext(boolean refreshContext)

Asks the custom web application initializer to refresh the Spring context.

Parameters:

refreshContext - true if the context should be refreshed

getApplicationInitializer

public LambdaSpringApplicationInitializer getApplicationInitializer()

Returns the custom web application initializer used by the object. The custom application initializer gives you access to the dispatcher servlet.

Returns:

The instance of the custom WebApplicationInitializer

getContainerResponse

protected AwsHttpServletResponse getContainerResponse(AwsProxyHttpServletRequest request,
                                                      java.util.concurrent.CountDownLatch latch)

Specified by:

getContainerResponse in class LambdaContainerHandler<RequestType,ResponseType,AwsProxyHttpServletRequest,AwsHttpServletResponse>

activateSpringProfiles

public void activateSpringProfiles(java.lang.String... profiles)
                            throws ContainerInitializationException

Activates the given Spring profiles in the application. This method will cause the context to be refreshed. To use a single Spring profile, use the static method getAwsProxyHandler(ConfigurableWebApplicationContext, String...)

Parameters:

profiles - A number of spring profiles

Throws:

ContainerInitializationException - if the initializer is not set yet.

handleRequest

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

Specified by:

handleRequest in class LambdaContainerHandler<RequestType,ResponseType,AwsProxyHttpServletRequest,AwsHttpServletResponse>

Throws:

java.lang.Exception

initialize

public void initialize()
                throws ContainerInitializationException

Specified by:

initialize in class LambdaContainerHandler<RequestType,ResponseType,AwsProxyHttpServletRequest,AwsHttpServletResponse>

Throws:

ContainerInitializationException