Package com.amazonaws.serverless.proxy.internal.servlet

Class ServletLambdaContainerHandlerBuilder<RequestType,ResponseType,ContainerRequestType extends jakarta.servlet.http.HttpServletRequest,HandlerType extends AwsLambdaServletContainerHandler<RequestType,ResponseType,ContainerRequestType,AwsHttpServletResponse>,Builder extends ServletLambdaContainerHandlerBuilder<RequestType,ResponseType,ContainerRequestType,HandlerType,Builder>>

java.lang.Object

com.amazonaws.serverless.proxy.internal.servlet.ServletLambdaContainerHandlerBuilder<RequestType,ResponseType,ContainerRequestType,HandlerType,Builder>

Type Parameters:

RequestType - The event object class

ResponseType - The output object class

ContainerRequestType - The container request type. For proxy implementations, this is AwsProxyHttpServletRequest. The response type is hardcoded to AwsHttpServletResponse since it is a generic servlet response implementation.

HandlerType - The type of the handler we are building

Builder - The builder object itself. This is used to allow implementations to re-use the setter method from this abstract class through "curiously recurring generic patterns"

public abstract class ServletLambdaContainerHandlerBuilder<RequestType,ResponseType,ContainerRequestType extends jakarta.servlet.http.HttpServletRequest,HandlerType extends AwsLambdaServletContainerHandler<RequestType,ResponseType,ContainerRequestType,AwsHttpServletResponse>,Builder extends ServletLambdaContainerHandlerBuilder<RequestType,ResponseType,ContainerRequestType,HandlerType,Builder>>
extends Object

Base builder class for AwsLambdaServletContainerHandler. Implmentations can extend this class to have setters for the basic parameters.

Field Summary

Fields

Modifier and Type	Field	Description
protected ExceptionHandler<ResponseType>	exceptionHandler
protected InitializationWrapper	initializationWrapper
protected RequestReader<RequestType,ContainerRequestType>	requestReader
protected Class<RequestType>	requestTypeClass
protected Class<ResponseType>	responseTypeClass
protected ResponseWriter<AwsHttpServletResponse,ResponseType>	responseWriter
protected SecurityContextWriter<RequestType>	securityContextWriter

Constructor Summary

Constructors

Constructor	Description
ServletLambdaContainerHandlerBuilder()

Method Summary

Modifier and Type	Method	Description
Builder	asyncInit()	Deprecated. As of release 2.0.0 this method is deprecated.
Builder	asyncInit(long actualStartTime)	Deprecated. As of release 2.0.0 this method is deprecated.
abstract HandlerType	build()
abstract HandlerType	buildAndInitialize()
protected ExceptionHandler<ResponseType>	defaultExceptionHandler()
Builder	defaultHttpApiV2Proxy()	Sets all of the required fields in the builder to the default settings for a Servlet-compatible framework that wants to support HTTP API's v2 proxy event
Builder	defaultProxy()	Sets all of the required fields in the builder to the default settings for a Servlet-compatible framework that wants to support AWS proxy event and output types.
Builder	exceptionHandler(ExceptionHandler<ResponseType> exceptionHandler)
Builder	initializationWrapper(InitializationWrapper initializationWrapper)	Sets the initialization wrapper to be used by the buildAndInitialize() method to start the framework implementations
Builder	requestReader(RequestReader<RequestType,ContainerRequestType> requestReader)
Builder	requestTypeClass(Class<RequestType> requestType)
Builder	responseTypeClass(Class<ResponseType> responseType)
Builder	responseWriter(ResponseWriter<AwsHttpServletResponse,ResponseType> responseWriter)
Builder	securityContextWriter(SecurityContextWriter<RequestType> securityContextWriter)
protected abstract Builder	self()	Implementations should implement this method to return their type.
protected void	validate()	Validates that all of the required fields are populated.

Methods inherited from class java.lang.Object

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

Field Details

initializationWrapper

protected InitializationWrapper initializationWrapper

requestReader

protected RequestReader<RequestType,ContainerRequestType extends jakarta.servlet.http.HttpServletRequest> requestReader

responseWriter

protected ResponseWriter<AwsHttpServletResponse,ResponseType> responseWriter

securityContextWriter

protected SecurityContextWriter<RequestType> securityContextWriter

exceptionHandler

protected ExceptionHandler<ResponseType> exceptionHandler

requestTypeClass

protected Class<RequestType> requestTypeClass

responseTypeClass

protected Class<ResponseType> responseTypeClass

Constructor Details

ServletLambdaContainerHandlerBuilder

public ServletLambdaContainerHandlerBuilder()

Method Details

validate

protected void validate()
                 throws ContainerInitializationException

Validates that all of the required fields are populated.

Throws:

ContainerInitializationException - If values have not been set on the builder. The message in the exception contains a standard error message MISSING_FIELD_ERROR populated with the list of missing fields.

defaultProxy

public Builder defaultProxy()

Sets all of the required fields in the builder to the default settings for a Servlet-compatible framework that wants to support AWS proxy event and output types.

Returns:

A populated builder

defaultHttpApiV2Proxy

public Builder defaultHttpApiV2Proxy()

Sets all of the required fields in the builder to the default settings for a Servlet-compatible framework that wants to support HTTP API's v2 proxy event

Returns:

A populated builder

defaultExceptionHandler

protected ExceptionHandler<ResponseType> defaultExceptionHandler()

initializationWrapper

public Builder initializationWrapper(InitializationWrapper initializationWrapper)

Sets the initialization wrapper to be used by the buildAndInitialize() method to start the framework implementations

Parameters:

initializationWrapper - An implementation of InitializationWrapper. In most cases, this will be set to InitializationWrapper. The asyncInit(long) method sets this to AsyncInitializationWrapper.

Returns:

This builder object

requestReader

public Builder requestReader(RequestReader<RequestType,ContainerRequestType> requestReader)

responseWriter

public Builder responseWriter(ResponseWriter<AwsHttpServletResponse,ResponseType> responseWriter)

securityContextWriter

public Builder securityContextWriter(SecurityContextWriter<RequestType> securityContextWriter)

exceptionHandler

public Builder exceptionHandler(ExceptionHandler<ResponseType> exceptionHandler)

requestTypeClass

public Builder requestTypeClass(Class<RequestType> requestType)

responseTypeClass

public Builder responseTypeClass(Class<ResponseType> responseType)

asyncInit

@Deprecated
public Builder asyncInit(long actualStartTime)

Deprecated.

As of release 2.0.0 this method is deprecated. Initializer is always async if running in on-demand.

Uses an async initializer with the given start time to calculate the 10 seconds timeout.

Parameters:

actualStartTime - An epoch in milliseconds that should be used to calculate the 10 seconds timeout since the start of the application

Returns:

A builder configured to use the async initializer

asyncInit

public Builder asyncInit()

Deprecated.

As of release 2.0.0 this method is deprecated. Initializer is always async if running in on-demand.

Uses a new AsyncInitializationWrapper with the no-parameter constructor that takes the actual JVM start time

Returns:

A builder configured to use an async initializer

self

protected abstract Builder self()

Implementations should implement this method to return their type. All of the builder methods in this abstract class use this method to return the correct builder type.

Returns:

The current builder.

build

public abstract HandlerType build()
                           throws ContainerInitializationException

Throws:

ContainerInitializationException

buildAndInitialize

public abstract HandlerType buildAndInitialize()
                                        throws ContainerInitializationException

Throws:

ContainerInitializationException