com.google.apphosting.runtime

Interface ServletEngineAdapter

All Known Implementing Classes:

JettyServletEngineAdapter

public interface ServletEngineAdapter

This interface abstracts away the details of starting up and shutting down a servlet engine, as well as adapting between the concrete classes that implement the Java Servlet API and the Prometheus Untrusted Process API.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ServletEngineAdapter.Config Options to configure a Jetty HTTP server, forwarding servlet requests to the GAE Java runtime.

Method Summary

Modifier and Type	Method and Description
void	addAppVersion(AppVersion appVersion) Register the specified application version for future calls to serviceRequest.
void	deleteAppVersion(AppVersion appVersion) Remove the specified application version and free up any resources associated with it.
void	serviceRequest(com.google.apphosting.base.protos.RuntimePb.UPRequest upRequest, MutableUpResponse upResponse) Executes the HTTP request specified by upRequest and writes the response to upResponse.
void	setSessionStoreFactory(SessionStoreFactory factory) Sets the SessionStoreFactory that will be used to create the list of SessionStores to which the HTTP Session will be stored, if sessions are enabled.
void	start(String serverInfo, ServletEngineAdapter.Config runtimeOptions) Performs whatever setup is necessary for this servlet container.
void	stop() Perform any shutdown procedures necessary for this servlet container.

Method Detail

start

void start(String serverInfo,
           ServletEngineAdapter.Config runtimeOptions)

Performs whatever setup is necessary for this servlet container. This method waits for setup to complete before returning.

Parameters:

serverInfo - The string that should be returned by ServletContext.getServerInfo().

runtimeOptions - Extra options, currently used for the Jetty HTTP adapter only.

stop

void stop()

Perform any shutdown procedures necessary for this servlet container. This method should return once the shutdown has been completed.

addAppVersion

void addAppVersion(AppVersion appVersion)
            throws FileNotFoundException

Register the specified application version for future calls to serviceRequest.

Throws:

FileNotFoundException - If any of the specified files could not be located.

deleteAppVersion

void deleteAppVersion(AppVersion appVersion)

Remove the specified application version and free up any resources associated with it.

serviceRequest

void serviceRequest(com.google.apphosting.base.protos.RuntimePb.UPRequest upRequest,
                    MutableUpResponse upResponse)
             throws javax.servlet.ServletException,
                    IOException

Executes the HTTP request specified by upRequest and writes the response to upResponse.

Finds, and if necessary, instantiates and initializes the appropriate servlet, invokes it, and copies the response into upResponse.

Throws:

IOException - If any error related to the request buffer was detected.

javax.servlet.ServletException

setSessionStoreFactory

void setSessionStoreFactory(SessionStoreFactory factory)

Sets the SessionStoreFactory that will be used to create the list of SessionStores to which the HTTP Session will be stored, if sessions are enabled. This method must be invoked after start(java.lang.String, com.google.apphosting.runtime.ServletEngineAdapter.Config).