com.google.api.server.spi

Class ServletInitializationParameters.Builder

java.lang.Object

com.google.api.server.spi.ServletInitializationParameters.Builder

Enclosing class:

ServletInitializationParameters

public abstract static class ServletInitializationParameters.Builder
extends java.lang.Object

A builder for ServletInitializationParameters.

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
ServletInitializationParameters.Builder	addServiceClass(java.lang.Class<?> serviceClass) Adds an endpoint service class to serve.
ServletInitializationParameters.Builder	addServiceClasses(java.lang.Iterable<? extends java.lang.Class<?>> serviceClasses) Adds some endpoint service classes to serve.
ServletInitializationParameters	build()
abstract ServletInitializationParameters.Builder	setAddContentLength(boolean addContentLength) Sets if the content length header should be set.
abstract ServletInitializationParameters.Builder	setClientIdWhitelistEnabled(boolean clientIdWhitelist) Sets if the client ID whitelist is enabled, defaulting to true.
abstract ServletInitializationParameters.Builder	setExceptionCompatibilityEnabled(boolean exceptionCompatibility) Sets if v1.0 style exceptions should be returned to users.
abstract ServletInitializationParameters.Builder	setIllegalArgumentBackendError(boolean illegalArgumentBackendError) Sets if an IllegalArgumentException should be treated as a backend error (500) instead of a user error (400).
abstract ServletInitializationParameters.Builder	setPrettyPrintEnabled(boolean prettyPrint) Sets if pretty printing should be enabled for responses by default.
ServletInitializationParameters.Builder	setRestricted(boolean servletRestricted) Deprecated. Retained for API compatibility
abstract ServletInitializationParameters.Builder	setServiceClasses(com.google.common.collect.ImmutableSet<java.lang.Class<?>> clazzes) Sets the complete list of endpoint service classes to serve.
abstract ServletInitializationParameters.Builder	setServletRestricted(boolean servletRestricted) 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

Builder

public Builder()

Method Detail

addServiceClass

public ServletInitializationParameters.Builder addServiceClass(java.lang.Class<?> serviceClass)

Adds an endpoint service class to serve.

addServiceClasses

public ServletInitializationParameters.Builder addServiceClasses(java.lang.Iterable<? extends java.lang.Class<?>> serviceClasses)

Adds some endpoint service classes to serve.

setServiceClasses

public abstract ServletInitializationParameters.Builder setServiceClasses(com.google.common.collect.ImmutableSet<java.lang.Class<?>> clazzes)

Sets the complete list of endpoint service classes to serve.

setServletRestricted

@Deprecated
public abstract ServletInitializationParameters.Builder setServletRestricted(boolean servletRestricted)

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

Sets if the servlet is restricted. Defaults to true.

setRestricted

@Deprecated
public ServletInitializationParameters.Builder setRestricted(boolean servletRestricted)

Deprecated. Retained for API compatibility

Sets if the servlet is restricted. Retained for API compatibility.

setClientIdWhitelistEnabled

public abstract ServletInitializationParameters.Builder setClientIdWhitelistEnabled(boolean clientIdWhitelist)

Sets if the client ID whitelist is enabled, defaulting to true.

setIllegalArgumentBackendError

public abstract ServletInitializationParameters.Builder setIllegalArgumentBackendError(boolean illegalArgumentBackendError)

Sets if an IllegalArgumentException should be treated as a backend error (500) instead of a user error (400). Defaults to false.

setExceptionCompatibilityEnabled

public abstract ServletInitializationParameters.Builder setExceptionCompatibilityEnabled(boolean exceptionCompatibility)

Sets 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. Defaults to true.

setPrettyPrintEnabled

public abstract ServletInitializationParameters.Builder setPrettyPrintEnabled(boolean prettyPrint)

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

setAddContentLength

public abstract ServletInitializationParameters.Builder setAddContentLength(boolean addContentLength)

Sets if the content length header should be set. Defaults to false.

build

public ServletInitializationParameters build()