Package com.google.appengine.tools.development

Class AbstractModule<I extends InstanceHolder>

java.lang.Object

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

Type Parameters:

I - An InstanceHolder type which is available to a Module implementation but not reflected in the Module interface.

All Implemented Interfaces:

Module

Direct Known Subclasses:

BasicModule, ManualModule

public abstract class AbstractModule<I extends InstanceHolder>
extends Object
implements Module

Abstract super class for Module implementations.

Method Summary

Modifier and Type	Method	Description
final void	configure(Map<String,Object> containerConfigProperties)	Configure this Module.
void	createConnection()	Creates the network connections for this Module.
I	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.
I	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.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.google.appengine.tools.development.Module

getInstanceCount

Method Details

getModuleName

public String getModuleName()

Description copied from interface: Module

Returns the module name for this Module.

Specified by:

getModuleName in interface Module

getLocalServerEnvironment

public LocalServerEnvironment getLocalServerEnvironment()

Description copied from interface: Module

Returns the LocalServerEnvironment for the primary instance for this Module.

Specified by:

getLocalServerEnvironment in interface Module

configure

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

Description copied from interface: Module

Configure this Module.

Note Module.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 Module.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.

Specified by:

configure in interface Module

Parameters:

containerConfigProperties - container configuration properties.

Throws:

Exception

createConnection

public void createConnection()
                      throws Exception

Description copied from interface: Module

Creates the network connections for this Module.

Specified by:

createConnection in interface Module

Throws:

Exception

setApiProxyDelegate

public void setApiProxyDelegate(ApiProxy.Delegate<?> apiProxyDelegate)

Description copied from interface: Module

Sets the ApiProxy.Delegate.

Specified by:

setApiProxyDelegate in interface Module

startup

public void startup()
             throws Exception

Description copied from interface: Module

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

Specified by:

startup in interface Module

Throws:

Exception

getHostAndPort

public String getHostAndPort(int instance)

Description copied from interface: Module

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

Specified by:

getHostAndPort in interface Module

Parameters:

instance - The instance number or LocalEnvironment.MAIN_INSTANCE.

getInstanceHolder

public I getInstanceHolder(int instance)

Description copied from interface: Module

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

Specified by:

getInstanceHolder in interface Module

Parameters:

instance - the instance number or LocalEnvironment.MAIN_INSTANCE.

shutdown

public void shutdown()
              throws Exception

Description copied from interface: Module

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

Specified by:

shutdown in interface Module

Throws:

Exception

getMainContainer

public ContainerService getMainContainer()

Description copied from interface: Module

Returns the ContainerService for the primary instance for this Module.

Specified by:

getMainContainer in interface Module

getAndReserveAvailableInstanceHolder

public I 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

startServing

public void startServing()
                  throws Exception

Description copied from interface: Module

Simulates starting the module in production.

Specified by:

startServing in interface Module

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

Throws:

Exception