io.helixservice.feature.vertx

Class VertxNativeFeature

java.lang.Object

io.helixservice.core.feature.AbstractFeature

io.helixservice.feature.vertx.VertxNativeFeature

All Implemented Interfaces:

ComponentRegistry, Feature

public class VertxNativeFeature
extends AbstractFeature

Provides access to Vert.x native resources. Features may choose to use the Vert.x Native functionality to gain direct access to underlying Vert.x capabilities.

Resource Ownership

This feature owns any Vert.x objects it creates, so that when the server is shut down or restarted all memory and resources are cleaned up and cleared. Currently, only HTTPClient is supported but Vert.x offers a ton more resources that could be provided through this interface.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_HTTPCLIENT_NAME

Constructor Summary

Constructors

Constructor and Description
VertxNativeFeature()

Method Summary

Modifier and Type	Method and Description
java.util.function.Supplier<io.vertx.core.http.HttpClient>	httpClient()
java.util.function.Supplier<io.vertx.core.http.HttpClient>	httpClient(String httpClientName)
java.util.function.Supplier<io.vertx.core.http.HttpClient>	httpClient(String httpClientName, io.vertx.core.http.HttpClientOptions httpClientOptions)
void	start(Server server) Called by Helix Server when the server is starting.
void	stop(Server server) Called by Helix Server when the server has stopped.

Methods inherited from class io.helixservice.core.feature.AbstractFeature

findByType, findByType, finish, getFeatureName, getRegistrationMap, logFeatureDetails, register

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_HTTPCLIENT_NAME

public static final String DEFAULT_HTTPCLIENT_NAME

See Also:

Constant Field Values

Constructor Detail

VertxNativeFeature

public VertxNativeFeature()

Method Detail

start

public void start(Server server)

Description copied from class: AbstractFeature

Called by Helix Server when the server is starting.

The order features will be called is the same order they initially registered with Helix. At the time this method is called, Vert.x will be initialized enabling the feature to create any Vert.x related resources.

Features should create and register any singleton components and allocate resources during the start call. Blocking operations are allowed in this method.

Specified by:

start in interface Feature

Overrides:

start in class AbstractFeature

Parameters:

server - Helix Server that is starting up

stop

public void stop(Server server)

Description copied from class: AbstractFeature

Called by Helix Server when the server has stopped.

The order features will be called is the reverse order they initially registered with Helix. Features must release all owned resources at this point. Blocking operations are allowed in this method.

Specified by:

stop in interface Feature

Overrides:

stop in class AbstractFeature

Parameters:

server - Helix Server that is being stopped

httpClient

public java.util.function.Supplier<io.vertx.core.http.HttpClient> httpClient()

httpClient

public java.util.function.Supplier<io.vertx.core.http.HttpClient> httpClient(String httpClientName)

httpClient

public java.util.function.Supplier<io.vertx.core.http.HttpClient> httpClient(String httpClientName,
                                                                             io.vertx.core.http.HttpClientOptions httpClientOptions)