io.helixservice.core.server

Class HelixServer

java.lang.Object

io.helixservice.core.server.HelixServer

All Implemented Interfaces:

ComponentRegistry, Server

public class HelixServer
extends Object
implements Server

Helix Server

The Helix Server controls the lifecycle of the features and components which comprise the service.

Constructor Summary

Constructors

Constructor and Description
HelixServer(java.util.function.Supplier<Feature[]> bootstrapFeaturesSupplier, java.util.function.Supplier<Feature[]> coreFeaturesSupplier) Create a Helix Server

Method Summary

Modifier and Type	Method and Description
<T extends Component> Collection<T>	findByType(String componentType) Find a list of components by type name
<T extends Component> T	findByType(String componentType, T defaultValue) Finds the a registered component by type name.
List<Feature>	getFeatures() Get a list of features started
com.google.common.collect.Multimap<String,Component>	getRegistrationMap() Returns the full map of registered components by type name.
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 class java.lang.Object

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

Constructor Detail

HelixServer

public HelixServer(java.util.function.Supplier<Feature[]> bootstrapFeaturesSupplier,
                   java.util.function.Supplier<Feature[]> coreFeaturesSupplier)

Create a Helix Server

The server expects a lambda or class that can will instantiate features to be installed.

Parameters:

bootstrapFeaturesSupplier - Bootstrap features to be started before others. Primarily, these are configuration related features.

coreFeaturesSupplier - Core features that will be started after the bootstrap features successfully start.

Method Detail

getVertx

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

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

Specified by:

getVertx in interface Server

Returns:

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

getServerState

public ServerState getServerState()

Get the Server's current state

Specified by:

getServerState in interface Server

Returns:

The server's current state

getFeatures

public List<Feature> getFeatures()

Get a list of features started

Specified by:

getFeatures in interface Server

Returns:

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

start

public Thread start()

Start the Helix Server, asynchronously

Specified by:

start in interface Server

Returns:

A thread which is running the start operation

restart

public 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.

Specified by:

restart in interface Server

Returns:

A thread which is running the start operation

stop

public 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.

Specified by:

stop in interface Server

Returns:

A thread which is running the start operation

getRegistrationMap

public com.google.common.collect.Multimap<String,Component> getRegistrationMap()

Returns the full map of registered components by type name.
Do not modify the map, it is only for finding components.

Specified by:

getRegistrationMap in interface ComponentRegistry

Returns:

The registered components map.

findByType

public <T extends Component> Collection<T> findByType(String componentType)

Find a list of components by type name

Specified by:

findByType in interface ComponentRegistry

Type Parameters:

T - Resulting class of the components expected

Parameters:

componentType - Type name of the components to find

Returns:

A collection of the components found, or empty list of none is found.

findByType

public <T extends Component> T findByType(String componentType,
                                          T defaultValue)

Finds the a registered component by type name. This method guarantees that the last (most recently) registered component will be returned.

Specified by:

findByType in interface ComponentRegistry

Type Parameters:

T - Resulting class of the component expected

Parameters:

componentType - Type name of the component to find

defaultValue - Default component if none is found (null is okay)

Returns:

The found component, or the default component if no component was found.