com.amazonaws.serverless.proxy.internal.model

Class ContainerConfig

java.lang.Object

com.amazonaws.serverless.proxy.internal.model.ContainerConfig

public class ContainerConfig
extends java.lang.Object

Configuration parameters for the framework

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_URI_ENCODING

Constructor Summary

Constructors

Constructor and Description
ContainerConfig()

Method Summary

Modifier and Type	Method and Description
static ContainerConfig	defaultConfig()
java.lang.String	getServiceBasePath()
java.lang.String	getUriEncoding()
boolean	isConsolidateSetCookieHeaders()
boolean	isStripBasePath()
void	setConsolidateSetCookieHeaders(boolean consolidateSetCookieHeaders) Tells the library to consolidate multiple Set-Cookie headers into a single Set-Cookie header with multiple, comma-separated values.
void	setServiceBasePath(java.lang.String serviceBasePath) Configures a base path that can be strippped from the request path before passing it to the frameowkr-specific implementation.
void	setStripBasePath(boolean stripBasePath) Whether this framework should strip the base path mapping specified with the setServiceBasePath(String) method from a request before passing it to the framework-specific implementations
void	setUriEncoding(java.lang.String uriEncoding) Sets the charset used to URLEncode and Decode request paths.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_URI_ENCODING

public static final java.lang.String DEFAULT_URI_ENCODING

See Also:

Constant Field Values

Constructor Detail

ContainerConfig

public ContainerConfig()

Method Detail

defaultConfig

public static ContainerConfig defaultConfig()

getServiceBasePath

public java.lang.String getServiceBasePath()

setServiceBasePath

public void setServiceBasePath(java.lang.String serviceBasePath)

Configures a base path that can be strippped from the request path before passing it to the frameowkr-specific implementation. This can be used to remove API Gateway's base path mappings from the request.

Parameters:

serviceBasePath - The base path mapping to be removed.

isStripBasePath

public boolean isStripBasePath()

setStripBasePath

public void setStripBasePath(boolean stripBasePath)

Whether this framework should strip the base path mapping specified with the setServiceBasePath(String) method from a request before passing it to the framework-specific implementations

Parameters:

stripBasePath -

getUriEncoding

public java.lang.String getUriEncoding()

setUriEncoding

public void setUriEncoding(java.lang.String uriEncoding)

Sets the charset used to URLEncode and Decode request paths.

Parameters:

uriEncoding - The charset. By default this is set to UTF-8

isConsolidateSetCookieHeaders

public boolean isConsolidateSetCookieHeaders()

setConsolidateSetCookieHeaders

public void setConsolidateSetCookieHeaders(boolean consolidateSetCookieHeaders)

Tells the library to consolidate multiple Set-Cookie headers into a single Set-Cookie header with multiple, comma-separated values. This is allowed by the RFC 2109 (https://tools.ietf.org/html/rfc2109). However, since not all clients support this, we consider it optional. When this value is set to true the framework will consolidate all Set-Cookie headers into a single header, when it's set to false, the framework will only return the first Set-Cookie header specified in a response. Because API Gateway needs header keys to be unique, we give an option to configure this.

Parameters:

consolidateSetCookieHeaders - Whether to consolidate the cookie headers or not.