Java 8 has reached end of support and will be deprecated on January 31, 2026. After deprecation, you won't be able to deploy Java 8 applications, even if your organization previously used an organization policy to re-enable deployments of legacy runtimes. Your existing Java 8 applications will continue to run and receive traffic after their deprecation date. We recommend that you migrate to the latest supported version of Java.

DevAppServerFactory

java.lang.Object
- com.google.appengine.tools.development.DevAppServerFactory

```
public class DevAppServerFactory
extends java.lang.Object
```
Creates new DevAppServers which can be used to launch web applications.

Constructor Summary

Constructors
Constructor and Description

DevAppServerFactory()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DevAppServer`	`createDevAppServer(java.io.File appDir, java.io.File webXmlLocation, java.io.File appEngineWebXmlLocation, java.lang.String address, int port, boolean useCustomStreamHandler, boolean installSecurityManager, java.util.Collection<java.net.URL> classpath)` Creates a new `DevAppServer` with a custom classpath for the web app.
`DevAppServer`	`createDevAppServer(java.io.File appDir, java.io.File webXmlLocation, java.io.File appEngineWebXmlLocation, java.lang.String address, int port, boolean useCustomStreamHandler, boolean installSecurityManager, java.util.Collection<java.net.URL> classpath, boolean noJavaAgent)` Creates a new `DevAppServer` with a custom classpath for the web app.
`DevAppServer`	`createDevAppServer(java.io.File appDir, java.io.File webXmlLocation, java.io.File appEngineWebXmlLocation, java.lang.String address, int port, boolean useCustomStreamHandler, boolean installSecurityManager, java.util.Map<java.lang.String,java.lang.Object> containerConfigProperties)` Creates a new `DevAppServer` ready to start serving.
`DevAppServer`	`createDevAppServer(java.io.File appDir, java.io.File webXmlLocation, java.io.File appEngineWebXmlLocation, java.lang.String address, int port, boolean useCustomStreamHandler, boolean installSecurityManager, java.util.Map<java.lang.String,java.lang.Object> containerConfigProperties, boolean noJavaAgent)` Creates a new `DevAppServer` with a custom classpath for the web app.
`DevAppServer`	`createDevAppServer(java.io.File appDir, java.io.File externalResourceDir, java.lang.String address, int port)` Creates a new `DevAppServer` ready to start serving.
`DevAppServer`	`createDevAppServer(java.io.File appDir, java.io.File externalResourceDir, java.lang.String address, int port, boolean noJavaAgent)` Creates a new `DevAppServer` ready to start serving.
`DevAppServer`	`createDevAppServer(java.io.File appDir, java.lang.String address, int port)` Creates a new `DevAppServer` ready to start serving.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - DevAppServerFactory
```
public DevAppServerFactory()
```
- Method Detail
  - createDevAppServer
```
public DevAppServer createDevAppServer(java.io.File appDir,
                                       java.lang.String address,
                                       int port)
```
    Creates a new DevAppServer ready to start serving.
    
    Parameters:
    
    appDir - The top-level directory of the web application to be run
    
    address - Address to bind to
    
    port - Port to bind to
    
    Returns:
    
    a DevAppServer
  - createDevAppServer
```
public DevAppServer createDevAppServer(java.io.File appDir,
                                       java.io.File externalResourceDir,
                                       java.lang.String address,
                                       int port)
```
    Creates a new DevAppServer ready to start serving.
    
    Parameters:
    
    appDir - The top-level directory of the web application to be run
    
    externalResourceDir - If not null, a resource directory external to the appDir. This paramater is now ignored.
    
    address - Address to bind to
    
    port - Port to bind to
    
    Returns:
    
    a DevAppServer
  - createDevAppServer
```
public DevAppServer createDevAppServer(java.io.File appDir,
                                       java.io.File externalResourceDir,
                                       java.lang.String address,
                                       int port,
                                       boolean noJavaAgent)
```
    Creates a new DevAppServer ready to start serving.
    
    Parameters:
    
    appDir - The top-level directory of the web application to be run
    
    externalResourceDir - If not null, a resource directory external to the appDir. This paramater is now ignored.
    
    address - Address to bind to
    
    port - Port to bind to
    
    noJavaAgent - whether to disable detection of the Java agent or not
    
    Returns:
    
    a DevAppServer
  - createDevAppServer
```
public DevAppServer createDevAppServer(java.io.File appDir,
                                       java.io.File webXmlLocation,
                                       java.io.File appEngineWebXmlLocation,
                                       java.lang.String address,
                                       int port,
                                       boolean useCustomStreamHandler,
                                       boolean installSecurityManager,
                                       java.util.Collection<java.net.URL> classpath)
```
    Creates a new DevAppServer with a custom classpath for the web app.
    
    Parameters:
    
    appDir - The top-level directory of the web application to be run
    
    webXmlLocation - The location of a file whose format complies with http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd. If null, defaults to /WEB-INF/web.xml
    
    appEngineWebXmlLocation - The name of the app engine config file. If null, defaults to /WEB-INF/appengine-web.xml.
    
    address - Address to bind to
    
    port - Port to bind to
    
    useCustomStreamHandler - If true, install StreamHandlerFactory. This is "normal" behavior for the dev app server but tests may want to disable this since there are some compatibility issues with our custom handler and Selenium.
    
    installSecurityManager - Whether or not to install the dev appserver security manager. It is strongly recommended you pass true unless there is something in your test environment that prevents you from installing a security manager.
    
    classpath - The classpath of the test and all its dependencies (possibly the entire app).
    
    Returns:
    
    a DevAppServer
  - createDevAppServer
```
public DevAppServer createDevAppServer(java.io.File appDir,
                                       java.io.File webXmlLocation,
                                       java.io.File appEngineWebXmlLocation,
                                       java.lang.String address,
                                       int port,
                                       boolean useCustomStreamHandler,
                                       boolean installSecurityManager,
                                       java.util.Collection<java.net.URL> classpath,
                                       boolean noJavaAgent)
```
    Creates a new DevAppServer with a custom classpath for the web app.
    
    Parameters:
    
    appDir - The top-level directory of the web application to be run
    
    webXmlLocation - The location of a file whose format complies with http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd. If null, defaults to /WEB-INF/web.xml
    
    appEngineWebXmlLocation - The name of the app engine config file. If null, defaults to /WEB-INF/appengine-web.xml.
    
    address - Address to bind to
    
    port - Port to bind to
    
    useCustomStreamHandler - If true, install StreamHandlerFactory. This is "normal" behavior for the dev app server but tests may want to disable this since there are some compatibility issues with our custom handler and Selenium.
    
    installSecurityManager - Whether or not to install the dev appserver security manager. It is strongly recommended you pass true unless there is something in your test environment that prevents you from installing a security manager.
    
    classpath - The classpath of the test and all its dependencies (possibly the entire app).
    
    noJavaAgent - whether to disable detection of the Java agent or not
    
    Returns:
    
    a DevAppServer
  - createDevAppServer
```
public DevAppServer createDevAppServer(java.io.File appDir,
                                       java.io.File webXmlLocation,
                                       java.io.File appEngineWebXmlLocation,
                                       java.lang.String address,
                                       int port,
                                       boolean useCustomStreamHandler,
                                       boolean installSecurityManager,
                                       java.util.Map<java.lang.String,java.lang.Object> containerConfigProperties)
```
    Creates a new DevAppServer ready to start serving.
    
    Parameters:
    
    appDir - The top-level directory of the web application to be run
    
    webXmlLocation - The location of a file whose format complies with http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd. If null, defaults to /WEB-INF/web.xml
    
    appEngineWebXmlLocation - The name of the app engine config file. If null, defaults to /WEB-INF/appengine-web.xml.
    
    address - Address to bind to
    
    port - Port to bind to
    
    useCustomStreamHandler - If true, install StreamHandlerFactory. This is "normal" behavior for the dev app server but tests may want to disable this since there are some compatibility issues with our custom handler and Selenium.
    
    installSecurityManager - Whether or not to install the dev appserver security manager. It is strongly recommended you pass true unless there is something in your test environment that prevents you from installing a security manager.
    
    containerConfigProperties - Map that contains settings that will allow to inject a classpath and to not require a WEB-INF directory. (Only needed for testing).
    
    Returns:
    
    a DevAppServer
  - createDevAppServer
```
public DevAppServer createDevAppServer(java.io.File appDir,
                                       java.io.File webXmlLocation,
                                       java.io.File appEngineWebXmlLocation,
                                       java.lang.String address,
                                       int port,
                                       boolean useCustomStreamHandler,
                                       boolean installSecurityManager,
                                       java.util.Map<java.lang.String,java.lang.Object> containerConfigProperties,
                                       boolean noJavaAgent)
```
    Creates a new DevAppServer with a custom classpath for the web app.
    
    Parameters:
    
    appDir - The top-level directory of the web application to be run
    
    webXmlLocation - The location of a file whose format complies with http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd. If null, defaults to {appDir}/WEB-INF/web.xml
    
    appEngineWebXmlLocation - The name of the app engine config file. If null, defaults to {appDir}/WEB-INF/appengine-web.xml.
    
    address - Address to bind to
    
    port - Port to bind to
    
    useCustomStreamHandler - If true, install StreamHandlerFactory. This is "normal" behavior for the dev app server but tests may want to disable this since there are some compatibility issues with our custom handler and Selenium.
    
    installSecurityManager - Whether or not to install the dev appserver security manager. For the java8 runtime, you do not need a security manager.
    
    containerConfigProperties - Extra container configurations.
    
    noJavaAgent - whether to disable detection of the Java agent or not.
    
    Returns:
    
    a DevAppServer

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025-06-16 UTC.

DevAppServerFactory Stay organized with collections Save and categorize content based on your preferences.

Class DevAppServerFactory

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DevAppServerFactory

Method Detail

createDevAppServer

createDevAppServer

createDevAppServer

createDevAppServer

createDevAppServer

createDevAppServer

createDevAppServer

DevAppServerFactory