com.google.api.server.spi

Class ServletInitializationParameters

java.lang.Object

com.google.api.server.spi.ServletInitializationParameters

public abstract class ServletInitializationParameters
extends java.lang.Object

Initialization parameters supported by the EndpointsServlet.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ServletInitializationParameters.Builder A builder for ServletInitializationParameters.

Constructor Summary

Constructors

Constructor and Description
ServletInitializationParameters()

Method Summary

Modifier and Type	Method and Description
com.google.common.collect.ImmutableMap<java.lang.String,java.lang.String>	asMap() Returns the parameters as a Map of parameter name to String value.
static ServletInitializationParameters.Builder	builder()
static ServletInitializationParameters	fromServletConfig(javax.servlet.ServletConfig config, java.lang.ClassLoader classLoader) Constructs a new instance from the provided ServletConfig and ClassLoader.
abstract com.google.common.collect.ImmutableSet<java.lang.Class<?>>	getServiceClasses() Returns the endpoint service classes to serve.
abstract boolean	isAddContentLength() Returns if the Content-Length header should be set on response.
abstract boolean	isClientIdWhitelistEnabled() Returns if client ID whitelisting is enabled.
abstract boolean	isExceptionCompatibilityEnabled() Returns if v1.0 style exceptions should be returned to users.
abstract boolean	isIllegalArgumentBackendError() Returns if an IllegalArgumentException should be returned as a backend error (500 level) instead of a user error (400 level).
abstract boolean	isPrettyPrintEnabled() Returns if pretty printing should be enabled for responses by default.
abstract boolean	isServletRestricted() Deprecated. No longer serves any purpose and will be removed in a future release

Methods inherited from class java.lang.Object

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

Constructor Detail

ServletInitializationParameters

public ServletInitializationParameters()

Method Detail

getServiceClasses

public abstract com.google.common.collect.ImmutableSet<java.lang.Class<?>> getServiceClasses()

Returns the endpoint service classes to serve.

isServletRestricted

@Deprecated
public abstract boolean isServletRestricted()

Deprecated. No longer serves any purpose and will be removed in a future release

Returns if the SPI servlet is restricted.

isClientIdWhitelistEnabled

public abstract boolean isClientIdWhitelistEnabled()

Returns if client ID whitelisting is enabled.

isIllegalArgumentBackendError

public abstract boolean isIllegalArgumentBackendError()

Returns if an IllegalArgumentException should be returned as a backend error (500 level) instead of a user error (400 level).

isExceptionCompatibilityEnabled

public abstract boolean isExceptionCompatibilityEnabled()

Returns if v1.0 style exceptions should be returned to users. In v1.0, certain codes are not permissible, and other codes are translated to other status codes.

isPrettyPrintEnabled

public abstract boolean isPrettyPrintEnabled()

Returns if pretty printing should be enabled for responses by default. Defaults to true.

isAddContentLength

public abstract boolean isAddContentLength()

Returns if the Content-Length header should be set on response. Should be disabled when running on App Engine, as Content-Length header is discarded by front-end servers. If enabled, has a small negative impact on CPU usage and latency.

builder

public static ServletInitializationParameters.Builder builder()

fromServletConfig

public static ServletInitializationParameters fromServletConfig(javax.servlet.ServletConfig config,
                                                                java.lang.ClassLoader classLoader)
                                                         throws javax.servlet.ServletException

Constructs a new instance from the provided ServletConfig and ClassLoader.

Throws:

javax.servlet.ServletException

asMap

public com.google.common.collect.ImmutableMap<java.lang.String,java.lang.String> asMap()

Returns the parameters as a Map of parameter name to String value.