Interface ProtocolConfig

All Superinterfaces:

NamedService

All Known Subinterfaces:

GrpcConfig, io.helidon.webserver.grpc.GrpcConfigBlueprint, Http1Config, io.helidon.webserver.http1.Http1ConfigBlueprint, Http2Config, io.helidon.webserver.http2.Http2ConfigBlueprint, WsConfig, io.helidon.webserver.websocket.WsConfigBlueprint

All Known Implementing Classes:

GrpcConfig.BuilderBase.GrpcConfigImpl, Http1Config.BuilderBase.Http1ConfigImpl, Http2Config.BuilderBase.Http2ConfigImpl, WsConfig.BuilderBase.WsConfigImpl

public interface ProtocolConfig
extends NamedService

Protocol configuration abstraction, used to setup a protocol.

Method Summary

Modifier and Type	Method	Description
default boolean	enabled()	Whether this protocol configuration is enabled.
default Set<String>	transportBindingTypes()	Transport binding provider keys compatible with this protocol.

Methods inherited from interface NamedService

name, type

Modifier and Type	Method	Description
String	name()	Name of this implementation, as provided in ConfiguredProvider.create(Config, String).
String	type()	Type of this implementation, to distinguish instances of same type, with different NamedService.name().

Method Details

enabled

default boolean enabled()

Whether this protocol configuration is enabled.

Returns:

whether this protocol is enabled

transportBindingTypes

default Set<String> transportBindingTypes()

Transport binding provider keys compatible with this protocol.

An empty set means this protocol has no transport preference and can use the listener default binding. Otherwise, at least one returned transport binding type must be active on the listener. Built-in keys are available from TransportBindingTypes.

Returns:

compatible transport binding types for this protocol