Package com.google.appengine.tools.development

Interface Module

All Known Implementing Classes:

AbstractModule, BasicModule, ManualModule

public interface Module

Holder for both configuration and runtime information for a single DevAppServer module and all its instances.

Method Summary

Modifier and Type	Method	Description
void	configure(Map<String,Object> containerConfigProperties)	Configure this Module.
void	createConnection()	Creates the network connections for this Module.
InstanceHolder	getAndReserveAvailableInstanceHolder()	Acquires a serving permit and returns an InstanceHolder for an instance which is available to handle a request or returns null if there is no such instance.
String	getHostAndPort(int instance)	Returns the host and port for the requested instance or null if the instance does not exist.
int	getInstanceCount()	Returns the number of instances for this module.
InstanceHolder	getInstanceHolder(int instance)	Returns the requested InstanceHolder or null if the instance does not exist.
LocalServerEnvironment	getLocalServerEnvironment()	Returns the LocalServerEnvironment for the primary instance for this Module.
ContainerService	getMainContainer()	Returns the ContainerService for the primary instance for this Module.
String	getModuleName()	Returns the module name for this Module.
void	setApiProxyDelegate(ApiProxy.Delegate<?> apiProxyDelegate)	Sets the ApiProxy.Delegate.
void	shutdown()	Stops all the instances for this Module.
void	startServing()	Simulates starting the module in production.
void	startup()	Starts all the instances for this Module.
void	stopServing()	Simulates stopping the module in production.

Method Details

configure

void configure(Map<String,Object> containerConfigProperties)
        throws Exception

Configure this Module.

Note configure(java.util.Map<java.lang.String, java.lang.Object>) fits into the DevAppServer startup sequence. The user may adjust DevAppServer.setServiceProperties(java.util.Map<java.lang.String, java.lang.String>) values after construction and before calling DevAppServer.start() which calls configure(java.util.Map<java.lang.String, java.lang.Object>). To retain compatibility operations that make use of these user specified settings such as port selection must not not be performed during construction.

Parameters:

containerConfigProperties - container configuration properties.

Throws:

Exception

setApiProxyDelegate

void setApiProxyDelegate(ApiProxy.Delegate<?> apiProxyDelegate)

Sets the ApiProxy.Delegate.

createConnection

void createConnection()
               throws Exception

Creates the network connections for this Module.

Throws:

Exception

startup

void startup()
      throws Exception

Starts all the instances for this Module. Once this returns the Module can handle HTTP requests.

Throws:

Exception

shutdown

void shutdown()
       throws Exception

Stops all the instances for this Module. Once this returns the Module cannot handle HTTP requests.

Throws:

Exception

stopServing

void stopServing()
          throws Exception

Simulates stopping the module in production.

Throws:

UnsupportedOperationException - if this is not a manual module.

Exception

startServing

void startServing()
           throws Exception

Simulates starting the module in production.

Throws:

UnsupportedOperationException - if this is not a manual module.

Exception

getModuleName

String getModuleName()

Returns the module name for this Module.

getMainContainer

ContainerService getMainContainer()

Returns the ContainerService for the primary instance for this Module.

getLocalServerEnvironment

LocalServerEnvironment getLocalServerEnvironment()

Returns the LocalServerEnvironment for the primary instance for this Module.

getHostAndPort

String getHostAndPort(int instance)

Returns the host and port for the requested instance or null if the instance does not exist.

Parameters:

instance - The instance number or LocalEnvironment.MAIN_INSTANCE.

getInstanceHolder

InstanceHolder getInstanceHolder(int instance)

Returns the requested InstanceHolder or null if the instance does not exist.

Parameters:

instance - the instance number or LocalEnvironment.MAIN_INSTANCE.

getInstanceCount

int getInstanceCount()

Returns the number of instances for this module. This will return 0 for an AutomaticModule.

getAndReserveAvailableInstanceHolder

InstanceHolder getAndReserveAvailableInstanceHolder()

Acquires a serving permit and returns an InstanceHolder for an instance which is available to handle a request or returns null if there is no such instance.

throws UnsupportedOperationException unless this is a ManualModule.