WithServer (Play 2.3.2)

Prev Class
Next Class

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

java.lang.Object
- play.test.WithServer

Direct Known Subclasses:

WithBrowser
```
public class WithServer
extends java.lang.Object
```
Provides a server to JUnit tests. Make your test class extend this class and an HTTP server will be started before each test is invoked. You can setup the fake application and port to use by overriding the provideFakeApplication and providePort methods. Within a test, the running application and the TCP port are available through the app and port fields, respectively.

Field Summary

Fields
Modifier and Type Field and Description

protected FakeApplication app

protected int port

protected TestServer testServer

Constructor Summary

Constructors
Constructor and Description

WithServer()

Method Summary

Methods
Modifier and Type	Method and Description
`protected FakeApplication`	`provideFakeApplication()` Override this method to setup the fake application to use.
`protected int`	`providePort()` Override this method to setup the port to use.
`protected void`	`start()` Deprecated. The server is automatically started before each test, you don’t need to call this method explicitly
`protected void`	`start(FakeApplication fakeApplication)` Deprecated. The server is automatically started before each test. You can setup the fake application to use by overriding the provideFakeApplication method.
`protected void`	`start(FakeApplication fakeApplication, int port)` Deprecated. The server is automatically started before each test. You can setup the fake application and port to use by overriding the provideFakeApplication and providePort methods, respectively.
`void`	`startServer()`
`void`	`stopServer()`

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

- Field Detail
  - app
```
protected FakeApplication app
```
  - port
```
protected int port
```
  - testServer
```
protected TestServer testServer
```
- Constructor Detail
  - WithServer
```
public WithServer()
```
- Method Detail
  - provideFakeApplication
```
protected FakeApplication provideFakeApplication()
```
    Override this method to setup the fake application to use.
    
    Returns:
    The fake application used by the server
  - providePort
```
protected int providePort()
```
    Override this method to setup the port to use.
    
    Returns:
    The TCP port used by the server
  - start
```
@Deprecated
protected void start()
```
    Deprecated. The server is automatically started before each test, you don’t need to call this method explicitly
  - start
```
@Deprecated
protected void start(FakeApplication fakeApplication)
```
    Deprecated. The server is automatically started before each test. You can setup the fake application to use by overriding the provideFakeApplication method.
  - start
```
@Deprecated
protected void start(FakeApplication fakeApplication,
                    int port)
```
    Deprecated. The server is automatically started before each test. You can setup the fake application and port to use by overriding the provideFakeApplication and providePort methods, respectively.
  - startServer
```
public void startServer()
```
  - stopServer
```
public void stopServer()
```

Prev Class
Next Class

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method