com.google.api.server.spi

Class BackendService

java.lang.Object

com.google.api.server.spi.BackendService

public class BackendService
extends java.lang.Object

The reserved API backend service used for Google's own purposes.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BackendService.Properties Resource object for general backend properties.

Constructor Summary

Constructors

Constructor and Description
BackendService(java.lang.String minorVersion, SystemService systemService, BackendProperties backendProperties)
BackendService(SystemService systemService)

Method Summary

Modifier and Type	Method and Description
java.util.Collection<java.lang.String>	getApiConfigs(java.lang.String expectedAppRevision) Reads all WEB-INF/*.api files and return their contents in a list of strings.
BackendService.Properties	getProperties() Used to retrieve general properties of the backend such as expected project id.
void	logMessages(com.google.api.server.spi.BackendService.MessageEntry[] messages) Writes an array of messages to local log, each specified at its own level.
static void	reloadApiConfigs() Initiates a request to reload the current application's API configs.

Methods inherited from class java.lang.Object

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

Constructor Detail

BackendService

public BackendService(SystemService systemService)

BackendService

public BackendService(java.lang.String minorVersion,
                      SystemService systemService,
                      BackendProperties backendProperties)

Method Detail

getApiConfigs

public java.util.Collection<java.lang.String> getApiConfigs(java.lang.String expectedAppRevision)
                                                     throws InternalServerErrorException,
                                                            BadRequestException

Reads all WEB-INF/*.api files and return their contents in a list of strings.

Parameters:

expectedAppRevision - App revision client expects to see

Throws:

InternalServerErrorException

BadRequestException

reloadApiConfigs

public static void reloadApiConfigs()
                             throws ServiceUnavailableException,
                                    NotFoundException

Initiates a request to reload the current application's API configs. Does not work in local development.

Throws:

ServiceUnavailableException

NotFoundException

logMessages

public void logMessages(com.google.api.server.spi.BackendService.MessageEntry[] messages)

Writes an array of messages to local log, each specified at its own level.

getProperties

public BackendService.Properties getProperties()

Used to retrieve general properties of the backend such as expected project id.