Package com.google.appengine.api.backends.dev

Interface LocalServerController

All Known Implementing Classes:

BackendServers, BackendServersBase, BackendServersEE8

public interface LocalServerController

Interface for controlling and getting information about backends in the dev-appserver.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	LocalServerController.BackendStateInfo	Class holding information about a single backend and its replicas.
static class	LocalServerController.InstanceStateInfo	Class holding instance information in a way that is useful for display in the backend viewer jsps.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	BACKEND_CONTROLLER_ATTRIBUTE_KEY

Method Summary

Modifier and Type	Method	Description
TreeMap<String,LocalServerController.BackendStateInfo>	getBackendState(String requestHostName)	Returns a map containing all information about current backend state.
void	startBackend(String backend)	Start all instances in STOPPED state of a single backend.
void	stopBackend(String backend)	Stop all instances in RUNNING state of a single backend, reset the internal state of each instance, and set state to STOPPED so that any subsequent requests receive a 500 error code response.

Field Details

BACKEND_CONTROLLER_ATTRIBUTE_KEY

static final String BACKEND_CONTROLLER_ATTRIBUTE_KEY

See Also:

• Constant Field Values

Method Details

getBackendState

TreeMap<String,LocalServerController.BackendStateInfo> getBackendState(String requestHostName)

Returns a map containing all information about current backend state.

Parameters:

requestHostName - The hostname of the request, if null is specified the listen address will be used.

Returns:

Backend name -> backend information mapping for all configured backends.

stopBackend

void stopBackend(String backend)
          throws IllegalStateException,
Exception

Stop all instances in RUNNING state of a single backend, reset the internal state of each instance, and set state to STOPPED so that any subsequent requests receive a 500 error code response.

Parameters:

backend - The backend to stop.

Throws:

IllegalStateException - if the specified backend does not exist.

Exception - if an error occurred that prevented the backend from resetting cleanly.

startBackend

void startBackend(String backend)
           throws IllegalStateException

Start all instances in STOPPED state of a single backend.

Parameters:

backend - The backend to start.

Throws:

IllegalStateException - is the specified backend does not exist.