com.amazonaws.serverless.proxy.jersey

Class JerseyAwsProxyRequestReader

java.lang.Object

com.amazonaws.serverless.proxy.internal.RequestReader<AwsProxyRequest,org.glassfish.jersey.server.ContainerRequest>

com.amazonaws.serverless.proxy.jersey.JerseyAwsProxyRequestReader

public class JerseyAwsProxyRequestReader
extends RequestReader<AwsProxyRequest,org.glassfish.jersey.server.ContainerRequest>

Default implementation of the RequestReader object. This object reads an incoming AwsProxyRequest event and transform it into a Jersey ContainerRequest object. The object sets three custom properties in the request's PropertiesDelegate object: The API Gateway request context, the Map of stage variables, and the Lambda context object. The useStageAsBasePath configuration variable lets you set whether the stage name should be included in the request path passed to the Jersey application handler.

Field Summary

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

API_GATEWAY_CONTEXT_PROPERTY, API_GATEWAY_STAGE_VARS_PROPERTY, LAMBDA_CONTEXT_PROPERTY

Constructor Summary

Constructors

Constructor and Description
JerseyAwsProxyRequestReader()

Method Summary

Modifier and Type	Method and Description
protected java.lang.Class<? extends AwsProxyRequest>	getRequestClass()
org.glassfish.jersey.server.ContainerRequest	readRequest(AwsProxyRequest request, javax.ws.rs.core.SecurityContext securityContext, com.amazonaws.services.lambda.runtime.Context lambdaContext) Reads an request object generated by an AWS_PROXY integration in API Gateway and transforms it into a Jersey ContainerRequest object.
void	setUseStageAsBasePath(boolean useStageAsBasePath) Sets whether the stage name should be used as base path for the Jersey request.

Methods inherited from class java.lang.Object

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

Constructor Detail

JerseyAwsProxyRequestReader

public JerseyAwsProxyRequestReader()

Method Detail

readRequest

public org.glassfish.jersey.server.ContainerRequest readRequest(AwsProxyRequest request,
                                                                javax.ws.rs.core.SecurityContext securityContext,
                                                                com.amazonaws.services.lambda.runtime.Context lambdaContext)
                                                         throws InvalidRequestEventException

Reads an request object generated by an AWS_PROXY integration in API Gateway and transforms it into a Jersey ContainerRequest object.

Specified by:

readRequest in class RequestReader<AwsProxyRequest,org.glassfish.jersey.server.ContainerRequest>

Parameters:

request - The incoming request object

securityContext - A jax-rs SecurityContext object (@see com.amazonaws.serverless.proxy.internal.SecurityContextWriter)

lambdaContext - The AWS Lambda context for the request

Returns:

A populated ContainerRequest object

Throws:

InvalidRequestEventException - When the method fails to parse the incoming request

setUseStageAsBasePath

public void setUseStageAsBasePath(boolean useStageAsBasePath)

Sets whether the stage name should be used as base path for the Jersey request. The default value for this property is false

Parameters:

useStageAsBasePath - True if the stage name should be included in the request path, false otherwise

getRequestClass

protected java.lang.Class<? extends AwsProxyRequest> getRequestClass()

Specified by:

getRequestClass in class RequestReader<AwsProxyRequest,org.glassfish.jersey.server.ContainerRequest>