Package com.google.appengine.api.backends

Interface BackendService

@Deprecated
public interface BackendService

Deprecated.

BackendService allows you to retrieve information about backend servers. Backend servers are long running addressable servers that can be used for applications that need to keep persistent state in ram between requests.

This API is deprecated and has been replaced by ModulesService. Please update your code as soon as possible. See the modules documentation for more information: https://developers.google.com/appengine/docs/java/modules/converting

This API allows you to retrieve information about the backend handling the current request. It also allows you to to get the address of a specific backend instance in such a way that a local server is used during development and a production server is used in production.

Field Summary

Fields

Modifier and Type	Field	Description
static String	BACKEND_ID_ENV_ATTRIBUTE	Deprecated. Environment attribute key where the backend name is stored.
static String	DEVAPPSERVER_PORTMAPPING_KEY	Deprecated.
static String	INSTANCE_ID_ENV_ATTRIBUTE	Deprecated. Environment attribute key where the instance id is stored.
static String	REQUEST_HEADER_BACKEND_REDIRECT	Deprecated.
static String	REQUEST_HEADER_INSTANCE_REDIRECT	Deprecated.

Method Summary

Modifier and Type	Method	Description
String	getBackendAddress(String backend)	Deprecated. Get the address of a specific backend in such a way that a local server is used during development and a production server is used in production.
String	getBackendAddress(String backend, int instance)	Deprecated. Get the address of a specific backend instance in such a way that a local instance is used during development and a production server instance is used in production.
String	getCurrentBackend()	Deprecated. Get the name of the backend handling the current request.
int	getCurrentInstance()	Deprecated. Get the instance handling the current request.

Field Detail

REQUEST_HEADER_BACKEND_REDIRECT

static final String REQUEST_HEADER_BACKEND_REDIRECT

Deprecated.

See Also:

Constant Field Values

REQUEST_HEADER_INSTANCE_REDIRECT

static final String REQUEST_HEADER_INSTANCE_REDIRECT

Deprecated.

See Also:

Constant Field Values

INSTANCE_ID_ENV_ATTRIBUTE

static final String INSTANCE_ID_ENV_ATTRIBUTE

Deprecated.

Environment attribute key where the instance id is stored.

See Also:

getCurrentInstance(), Constant Field Values

BACKEND_ID_ENV_ATTRIBUTE

static final String BACKEND_ID_ENV_ATTRIBUTE

Deprecated.

Environment attribute key where the backend name is stored.

See Also:

getCurrentBackend(), Constant Field Values

DEVAPPSERVER_PORTMAPPING_KEY

static final String DEVAPPSERVER_PORTMAPPING_KEY

Deprecated.

See Also:

Constant Field Values

Method Detail

getCurrentBackend

String getCurrentBackend()

Deprecated.

Get the name of the backend handling the current request.

Returns:

The name of the backend or null if the request is not handled by a backend.

getCurrentInstance

int getCurrentInstance()

Deprecated.

Get the instance handling the current request.

Returns:

The instance id or -1 if the request is not handled by a backend.

getBackendAddress

String getBackendAddress(String backend)

Deprecated.

Get the address of a specific backend in such a way that a local server is used during development and a production server is used in production.

Parameters:

backend - The name of the backend

Returns:

The address of the backend

getBackendAddress

String getBackendAddress(String backend,
                         int instance)

Deprecated.

Get the address of a specific backend instance in such a way that a local instance is used during development and a production server instance is used in production.

Parameters:

backend - The name of the backend

instance - The instance id

Returns:

The address of the backend instance