io.helixservice.core.server

Interface Server

All Superinterfaces:

ComponentRegistry

All Known Implementing Classes:

HelixServer

public interface Server
extends ComponentRegistry

Helix Server Interface

Method Summary

Modifier and Type	Method and Description
List<Feature>	getFeatures() Get a list of features started
ServerState	getServerState() Get the Server's current state
Optional<io.vertx.core.Vertx>	getVertx() Get the Vert.x instance, available after the bootstrap features have started.
Thread	restart() Restart the Helix Server, asynchronously
Thread	start() Start the Helix Server, asynchronously
Thread	stop(boolean immediate) Start the Helix Server, asynchronously

Methods inherited from interface io.helixservice.core.component.ComponentRegistry

findByType, findByType, getRegistrationMap

Method Detail

getVertx

Optional<io.vertx.core.Vertx> getVertx()

Get the Vert.x instance, available after the bootstrap features have started.

Returns:

The Vert.x instance, which will be present during lifecycle callbacks to core features.

getServerState

ServerState getServerState()

Get the Server's current state

Returns:

The server's current state

getFeatures

List<Feature> getFeatures()

Get a list of features started

Returns:

The list of features installed, or null if the server is stopped

start

Thread start()

Start the Helix Server, asynchronously

Returns:

A thread which is running the start operation

Throws:

IllegalStateException - if the server is not in the stopped state

restart

Thread restart()

Restart the Helix Server, asynchronously

This shuts down all the features, waits for the in-flight requests to complete, then starts the server again. Restarting the server includes re-creating all features.

Returns:

A thread which is running the start operation

Throws:

IllegalStateException - if the server is not in the started state

stop

Thread stop(boolean immediate)

Start the Helix Server, asynchronously

This shuts down all the features, waits for the in-flight requests to complete. During shut-down, all new HTTP requests will fail with HTTP error code 599. This signals the Load Balancer to take the service out of rotation, preventing new requests from flowing to the service.

Returns:

A thread which is running the start operation

Throws:

IllegalStateException - if the server is not in the started state