Module io.helidon.declarative.codegen.model

Package io.helidon.declarative.codegen.model.http

Interface ServerEndpoint

All Superinterfaces:

HttpAnnotated, ModelElement, Prototype.Api, RestEndpoint

All Known Implementing Classes:

ServerEndpoint.BuilderBase.ServerEndpointImpl

public interface ServerEndpoint
extends Prototype.Api, RestEndpoint, HttpAnnotated, ModelElement

REST endpoint for server side endpoint definition.

See Also:

• builder()
• create()

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	ServerEndpoint.Builder	Fluent API builder for ServerEndpoint.
static class	ServerEndpoint.BuilderBase<BUILDER extends ServerEndpoint.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends ServerEndpoint>	Fluent API builder base for ServerEndpoint.

Method Summary

Modifier and Type	Method	Description
static ServerEndpoint.Builder	builder()	Create a new fluent API builder to customize configuration.
static ServerEndpoint.Builder	builder(ServerEndpoint instance)	Create a new fluent API builder from an existing instance.
static ServerEndpoint	create()	Create a new instance with default values.
Optional<String>	listener()	Listener name (optional).
boolean	listenerRequired()	Whether the listener must be defined on the server or not.

Methods inherited from interface io.helidon.declarative.codegen.model.http.HttpAnnotated

computedHeaders, consumes, headers, path, produces

Methods inherited from interface io.helidon.declarative.codegen.model.http.ModelElement

annotations, type

Methods inherited from interface io.helidon.declarative.codegen.model.http.RestEndpoint

methods

Method Details

builder

static ServerEndpoint.Builder builder()

Create a new fluent API builder to customize configuration.

Returns:

a new builder

builder

static ServerEndpoint.Builder builder(ServerEndpoint instance)

Create a new fluent API builder from an existing instance.

Parameters:

instance - an existing instance used as a base for the builder

Returns:

a builder based on an instance

create

static ServerEndpoint create()

Create a new instance with default values.

Returns:

a new instance

listener

Optional<String> listener()

Listener name (optional).

Returns:

listener this endpoint should be assigned to

listenerRequired

boolean listenerRequired()

Whether the listener must be defined on the server or not. If required, server will fail to start if the listener is not configured.

Returns:

whether the listener is required, defaults to false