ratpack.server

Interface RatpackServer

public interface RatpackServer

A Ratpack server.

Method Summary

Methods

Modifier and Type	Method and Description
String	getBindHost() The actual host/ip that the application is bound to.
int	getBindPort() The actual port that the application is bound to.
LaunchConfig	getLaunchConfig() The (read only) configuration that was used to launch this server.
String	getScheme() The URL scheme the server uses.
boolean	isRunning() Returns true if the server is running.
void	start() Starts the server, returning as soon as the server is up and ready to receive requests.
void	stop() Stops the server, returning as soon as the server has stopped receiving requests.

Method Detail

getLaunchConfig

LaunchConfig getLaunchConfig()

The (read only) configuration that was used to launch this server.

Returns:

the (read only) configuration that was used to launch this server.

getScheme

String getScheme()

The URL scheme the server uses.

Returns:

Either http or https depending on whether the server is using SSL or not.

getBindPort

int getBindPort()

The actual port that the application is bound to.

Returns:

The actual port that the application is bound to, or -1 if the server is not running.

getBindHost

String getBindHost()

The actual host/ip that the application is bound to.

Returns:

The actual host/ip that the application is bound to, or null if this server is not running.

isRunning

boolean isRunning()

Returns true if the server is running.

Returns:

true if the server is running.

start

void start()
           throws Exception

Starts the server, returning as soon as the server is up and ready to receive requests.

This will create new threads that are not daemonized.

Throws:

Exception - if the server could not be started

stop

void stop()
          throws Exception

Stops the server, returning as soon as the server has stopped receiving requests.

Throws:

Exception - if the server could not be stopped cleanly