Package com.google.appengine.tools.development

Class BasicModule

java.lang.Object

com.google.appengine.tools.development.AbstractModule<com.google.appengine.tools.development.ManualInstanceHolder>

com.google.appengine.tools.development.BasicModule

All Implemented Interfaces:

Module

public class BasicModule
extends AbstractModule<com.google.appengine.tools.development.ManualInstanceHolder>

Basic Module implementation. Very similar to ManualModule, but will create 1 or 2 instances based on maxInstances. Does not attempt to implement autoscaling since we do not do that in dynamic modules either. Will create 2 instances and balance load between the two if maxInstances is >= 2, this should help with testing shared state between instances.

Method Summary

Modifier and Type	Method	Description
LocalServerEnvironment	doConfigure(ApplicationConfigurationManager.ModuleConfigurationHandle moduleConfigurationHandle, String serverInfo, File externalResourceDir, String address, Map<String,Object> containerConfigProperties, DevAppServer devAppServer)
com.google.appengine.tools.development.ManualInstanceHolder	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.
int	getInstanceCount()	Returns the number of instances for this module.
void	startServing()	Simulates starting the module in production.
void	stopServing()	Simulates stopping the module in production.

Methods inherited from class com.google.appengine.tools.development.AbstractModule

configure, createConnection, getHostAndPort, getInstanceHolder, getLocalServerEnvironment, getMainContainer, getModuleName, setApiProxyDelegate, shutdown, startup

Methods inherited from class java.lang.Object

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

Method Details

doConfigure

public LocalServerEnvironment doConfigure(ApplicationConfigurationManager.ModuleConfigurationHandle moduleConfigurationHandle,
 String serverInfo,
 File externalResourceDir,
 String address,
 Map<String,Object> containerConfigProperties,
 DevAppServer devAppServer)
                                   throws Exception

Throws:

Exception

getInstanceCount

public int getInstanceCount()

Description copied from interface: Module

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

getAndReserveAvailableInstanceHolder

public com.google.appengine.tools.development.ManualInstanceHolder getAndReserveAvailableInstanceHolder()

Description copied from interface: Module

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.

Specified by:

getAndReserveAvailableInstanceHolder in interface Module

Overrides:

getAndReserveAvailableInstanceHolder in class AbstractModule<com.google.appengine.tools.development.ManualInstanceHolder>

startServing

public void startServing()
                  throws Exception

Description copied from interface: Module

Simulates starting the module in production.

Specified by:

startServing in interface Module

Overrides:

startServing in class AbstractModule<com.google.appengine.tools.development.ManualInstanceHolder>

Throws:

Exception

stopServing

public void stopServing()
                 throws Exception

Description copied from interface: Module

Simulates stopping the module in production.

Specified by:

stopServing in interface Module

Overrides:

stopServing in class AbstractModule<com.google.appengine.tools.development.ManualInstanceHolder>

Throws:

Exception