Module io.helidon.microprofile.tyrus

Package io.helidon.microprofile.tyrus

Class WebSocketApplication

java.lang.Object

io.helidon.microprofile.tyrus.WebSocketApplication

public final class WebSocketApplication
extends Object

Represents a websocket application with class and config endpoints.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	WebSocketApplication.Builder	Fluent API builder to create WebSocketApplication instances.

Method Summary

Modifier and Type	Method	Description
Set<Class<?>>	annotatedEndpoints()	Get list of annotated endpoints.
Optional<Class<? extends jakarta.websocket.server.ServerApplicationConfig>>	applicationClass()	Get access to an application class, if present.
Set<Class<? extends jakarta.websocket.server.ServerApplicationConfig>>	applicationClasses()	Get access to all application classes.
static WebSocketApplication.Builder	builder()	A new fluent API builder to create a customized WebSocketApplication.
Set<jakarta.websocket.Extension>	extensions()	Get list of installed extensions.
Set<Class<? extends jakarta.websocket.Endpoint>>	programmaticEndpoints()	Get list of programmatic endpoints.

Methods inherited from class java.lang.Object

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

Method Details

builder

public static WebSocketApplication.Builder builder()

A new fluent API builder to create a customized WebSocketApplication.

Returns:

a new builder instance

applicationClass

public Optional<Class<? extends jakarta.websocket.server.ServerApplicationConfig>> applicationClass()

Get access to an application class, if present.

Returns:

Application class optional.

applicationClasses

public Set<Class<? extends jakarta.websocket.server.ServerApplicationConfig>> applicationClasses()

Get access to all application classes. Possibly an empty set.

Returns:

Immutable set of application classes.

programmaticEndpoints

public Set<Class<? extends jakarta.websocket.Endpoint>> programmaticEndpoints()

Get list of programmatic endpoints.

Returns:

List of config endpoints.

annotatedEndpoints

public Set<Class<?>> annotatedEndpoints()

Get list of annotated endpoints.

Returns:

List of annotated endpoint.

extensions

public Set<jakarta.websocket.Extension> extensions()

Get list of installed extensions.

Returns:

List of installed extensions.