com.amazonaws.serverless.proxy.internal.servlet

Class AwsLambdaServletContainerHandler<RequestType,ResponseType,ContainerRequestType extends javax.servlet.http.HttpServletRequest,ContainerResponseType extends javax.servlet.http.HttpServletResponse>

java.lang.Object

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

com.amazonaws.serverless.proxy.internal.servlet.AwsLambdaServletContainerHandler<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

public abstract class AwsLambdaServletContainerHandler<RequestType,ResponseType,ContainerRequestType extends javax.servlet.http.HttpServletRequest,ContainerResponseType extends javax.servlet.http.HttpServletResponse>
extends LambdaContainerHandler<RequestType,ResponseType,ContainerRequestType,ContainerResponseType>

Abstract extension of the code LambdaContainerHandler object that adds protected variables for the ServletContext and FilterChainManager. This object should be extended by the framework-specific implementations that want to support the servlet 3.1 specs. Because Lambda only allows one event per container at a time, this object also acts as the RequestDispatcher

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	AwsLambdaServletContainerHandler.StartupHandler

Field Summary

Fields

Modifier and Type	Field and Description
protected javax.servlet.ServletContext	servletContext
protected AwsLambdaServletContainerHandler.StartupHandler	startupHandler

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

lambdaContext, SERVER_INFO

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AwsLambdaServletContainerHandler(java.lang.Class<RequestType> requestTypeClass, java.lang.Class<ResponseType> responseTypeClass, RequestReader<RequestType,ContainerRequestType> requestReader, ResponseWriter<ContainerResponseType,ResponseType> responseWriter, SecurityContextWriter<RequestType> securityContextWriter, ExceptionHandler<ResponseType> exceptionHandler)

Method Summary

Modifier and Type	Method and Description
protected void	doFilter(ContainerRequestType request, ContainerResponseType response, javax.servlet.Servlet servlet) Applies the filter chain in the request lifecycle
void	forward(ContainerRequestType servletRequest, ContainerResponseType servletResponse) Fowards a request to the existing framework container.
protected javax.servlet.FilterChain	getFilterChain(ContainerRequestType req, javax.servlet.Servlet servlet)
javax.servlet.ServletContext	getServletContext() Returns the current ServletContext.
void	include(ContainerRequestType servletRequest, ContainerResponseType servletResponse) Includes a request to the existing framework container.
void	onStartup(AwsLambdaServletContainerHandler.StartupHandler h) You can use the onStartup to intercept the ServletContext as the Spring application is initialized and inject custom values.
protected void	setServletContext(javax.servlet.ServletContext context) Sets the ServletContext in the handler and initialized a new FilterChainManager

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

getContainerConfig, getContainerResponse, getObjectMapper, handleRequest, initialize, proxy, proxyStream, setLogFormatter, stripBasePath

Methods inherited from class java.lang.Object

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

Field Detail

startupHandler

protected AwsLambdaServletContainerHandler.StartupHandler startupHandler

servletContext

protected javax.servlet.ServletContext servletContext

Constructor Detail

AwsLambdaServletContainerHandler

protected AwsLambdaServletContainerHandler(java.lang.Class<RequestType> requestTypeClass,
                                           java.lang.Class<ResponseType> responseTypeClass,
                                           RequestReader<RequestType,ContainerRequestType> requestReader,
                                           ResponseWriter<ContainerResponseType,ResponseType> responseWriter,
                                           SecurityContextWriter<RequestType> securityContextWriter,
                                           ExceptionHandler<ResponseType> exceptionHandler)

Method Detail

forward

public void forward(ContainerRequestType servletRequest,
                    ContainerResponseType servletResponse)
             throws javax.servlet.ServletException,
                    java.io.IOException

Fowards a request to the existing framework container. This is called by the AwsProxyRequestDispatcher object

Parameters:

servletRequest - The modified request object with the new request path

servletResponse - The original servlet response

Throws:

javax.servlet.ServletException

java.io.IOException

include

public void include(ContainerRequestType servletRequest,
                    ContainerResponseType servletResponse)
             throws javax.servlet.ServletException,
                    java.io.IOException

Includes a request to the existing framework container. This is called by the AwsProxyRequestDispatcher object

Parameters:

servletRequest - The modified request object with the new request path

servletResponse - The original servlet response

Throws:

javax.servlet.ServletException

java.io.IOException

onStartup

public void onStartup(AwsLambdaServletContainerHandler.StartupHandler h)

You can use the onStartup to intercept the ServletContext as the Spring application is initialized and inject custom values. The StartupHandler is called after the onStartup method of the LambdaSpringApplicationinitializer implementation. For example, you can use this method to add custom filters to the servlet context:

 
      handler = SpringLambdaContainerHandler.getAwsProxyHandler(EchoSpringAppConfig.class);
      handler.onStartup(c -> {
      // the "c" parameter to this function is the initialized servlet context
      c.addFilter("CustomHeaderFilter", CustomHeaderFilter.class);
      });
 
 

Parameters:

h - A lambda expression that implements the StartupHandler functional interface

getServletContext

public javax.servlet.ServletContext getServletContext()

Returns the current ServletContext. If the framework implementation does not set the value for servlet context this method will return null.

Returns:

The initialized servlet context if the framework-specific implementation requires one, otherwise null

setServletContext

protected void setServletContext(javax.servlet.ServletContext context)

Sets the ServletContext in the handler and initialized a new FilterChainManager

Parameters:

context - An initialized ServletContext

getFilterChain

protected javax.servlet.FilterChain getFilterChain(ContainerRequestType req,
                                                   javax.servlet.Servlet servlet)

doFilter

protected void doFilter(ContainerRequestType request,
                        ContainerResponseType response,
                        javax.servlet.Servlet servlet)
                 throws java.io.IOException,
                        javax.servlet.ServletException

Applies the filter chain in the request lifecycle

Parameters:

request - The Request object. This must be an implementation of HttpServletRequest

response - The response object. This must be an implementation of HttpServletResponse

servlet - Servlet at the end of the chain (optional).

Throws:

java.io.IOException

javax.servlet.ServletException