play.server

Class Server

java.lang.Object

play.server.Server

public class Server
extends java.lang.Object

A Play server.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Server.Builder Configures and builds an embedded server.
static class	Server.Protocol Specifies the protocols supported by the server.

Constructor Summary

Constructors

Constructor and Description
Server(play.core.server.Server server)

Method Summary

Modifier and Type	Method and Description
static Server	forRouter(java.util.function.Function<play.api.BuiltInComponents,Router> block) Create a server for the given router.
static Server	forRouter(int port, java.util.function.Function<play.api.BuiltInComponents,Router> block) Create a server for the given router.
static Server	forRouter(Mode mode, java.util.function.Function<play.api.BuiltInComponents,Router> block) Create a server for the given router.
static Server	forRouter(Mode mode, int port, java.util.function.Function<play.api.BuiltInComponents,Router> block) Create a server for the router returned by the given block.
static Server	forRouter(Router router) Deprecated. As of 2.6.0. Use forRouter(Function)
static Server	forRouter(Router router, int port) Deprecated. As of 2.6.0. Use forRouter(int, Function)
static Server	forRouter(Router router, Mode mode) Deprecated. As of 2.6.0. Use forRouter(Mode, Function)
static Server	forRouter(Router router, Mode mode, int port) Deprecated. As of 2.6.0. Use forRouter(Mode, int, Function)
int	httpPort() Get the HTTP port the server is running on.
int	httpsPort() Get the HTTPS port the server is running on.
java.net.InetSocketAddress	mainAddress() Get the address the server is running on.
void	stop() Stop the server.
play.core.server.Server	underlying()

Methods inherited from class java.lang.Object

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

Constructor Detail

Server

public Server(play.core.server.Server server)

Method Detail

underlying

public play.core.server.Server underlying()

Returns:

the underlying server.

stop

public void stop()

Stop the server.

httpPort

public int httpPort()

Get the HTTP port the server is running on.

Returns:

the port number.

Throws:

java.lang.IllegalStateException - if it is not running on the HTTP protocol

httpsPort

public int httpsPort()

Get the HTTPS port the server is running on.

Returns:

the port number.

Throws:

java.lang.IllegalStateException - if it is not running on the HTTPS protocol.

mainAddress

public java.net.InetSocketAddress mainAddress()

Get the address the server is running on.

Returns:

the address

forRouter

@Deprecated
public static Server forRouter(Router router)

Deprecated. As of 2.6.0. Use forRouter(Function)

Create a server for the given router.

The server will be running on a randomly selected ephemeral port, which can be checked using the httpPort property.

The server will be running in TEST mode.

Parameters:

router - The router for the server to serve.

Returns:

The running server.

forRouter

public static Server forRouter(java.util.function.Function<play.api.BuiltInComponents,Router> block)

Create a server for the given router.

The server will be running on a randomly selected ephemeral port, which can be checked using the httpPort property.

The server will be running in TEST mode.

Parameters:

block - The block that creates the router.

Returns:

The running server.

forRouter

@Deprecated
public static Server forRouter(Router router,
                                           Mode mode)

Deprecated. As of 2.6.0. Use forRouter(Mode, Function)

Create a server for the given router.

The server will be running on a randomly selected ephemeral port, which can be checked using the httpPort property.

Parameters:

router - The router for the server to serve.

mode - The mode the server will run on.

Returns:

The running server.

forRouter

public static Server forRouter(Mode mode,
                               java.util.function.Function<play.api.BuiltInComponents,Router> block)

Create a server for the given router.

The server will be running on a randomly selected ephemeral port, which can be checked using the httpPort property.

The server will be running in TEST mode.

Parameters:

mode - The mode the server will run on.

block - The block that creates the router.

Returns:

The running server.

forRouter

@Deprecated
public static Server forRouter(Router router,
                                           int port)

Deprecated. As of 2.6.0. Use forRouter(int, Function)

Create a server for the given router.

The server will be running in TEST mode.

Parameters:

router - The router for the server to serve.

port - The port the server will run on.

Returns:

The running server.

forRouter

public static Server forRouter(int port,
                               java.util.function.Function<play.api.BuiltInComponents,Router> block)

Create a server for the given router.

The server will be running on a randomly selected ephemeral port, which can be checked using the httpPort property.

The server will be running in TEST mode.

Parameters:

port - The port the server will run on.

block - The block that creates the router.

Returns:

The running server.

forRouter

@Deprecated
public static Server forRouter(Router router,
                                           Mode mode,
                                           int port)

Deprecated. As of 2.6.0. Use forRouter(Mode, int, Function)

Create a server for the given router.

Parameters:

router - The router for the server to serve.

mode - The mode the server will run on.

port - The port the server will run on.

Returns:

The running server.

forRouter

public static Server forRouter(Mode mode,
                               int port,
                               java.util.function.Function<play.api.BuiltInComponents,Router> block)

Create a server for the router returned by the given block.

Parameters:

block - The block which creates a router.

mode - The mode the server will run on.

port - The port the server will run on.

Returns:

The running server.