com.google.api.server.spi

Class ServletInitializationParameters

java.lang.Object

com.google.api.server.spi.ServletInitializationParameters

public 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.

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() Returns a new ServletInitializationParameters.Builder for this class.
static ServletInitializationParameters	fromServletConfig(javax.servlet.ServletConfig config, java.lang.ClassLoader classLoader) Constructs a new instance from the provided ServletConfig and ClassLoader.
com.google.common.collect.ImmutableSet<java.lang.Class<?>>	getServiceClasses() Returns the endpoint service classes to serve.
boolean	isClientIdWhitelistEnabled() Returns true if client ID whitelisting is enabled.
boolean	isExceptionCompatibilityEnabled() Returns true if v1.0 style exceptions should be returned to users.
boolean	isIllegalArgumentBackendError() Returns true if an IllegalArgumentException should be returned as a backend error (500) instead of a user error (400).
boolean	isServletRestricted() Returns true if the SPI servlet is restricted.

Methods inherited from class java.lang.Object

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

Method Detail

builder

public static ServletInitializationParameters.Builder builder()

Returns a new ServletInitializationParameters.Builder for this class.

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

getServiceClasses

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

Returns the endpoint service classes to serve.

isServletRestricted

public boolean isServletRestricted()

Returns true if the SPI servlet is restricted.

isClientIdWhitelistEnabled

public boolean isClientIdWhitelistEnabled()

Returns true if client ID whitelisting is enabled.

isIllegalArgumentBackendError

public boolean isIllegalArgumentBackendError()

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

isExceptionCompatibilityEnabled

public boolean isExceptionCompatibilityEnabled()

Returns true 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.

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.