Package net.carcdr.yhocuspocus.spring.websocket

Class YHocuspocusWebSocketConfigurer.Builder

java.lang.Object

net.carcdr.yhocuspocus.spring.websocket.YHocuspocusWebSocketConfigurer.Builder

Enclosing class:

YHocuspocusWebSocketConfigurer

public static class YHocuspocusWebSocketConfigurer.Builder
extends Object

Builder for YHocuspocusWebSocketConfigurer.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
YHocuspocusWebSocketConfigurer.Builder	addInterceptor(org.springframework.web.socket.server.HandshakeInterceptor interceptor)	Adds a handshake interceptor.
YHocuspocusWebSocketConfigurer.Builder	allowedOrigins(String... origins)	Sets the allowed origins for CORS.
YHocuspocusWebSocketConfigurer	build()	Builds the configurer.
YHocuspocusWebSocketConfigurer.Builder	path(String path)	Sets the WebSocket endpoint path.
YHocuspocusWebSocketConfigurer.Builder	server(net.carcdr.yhocuspocus.core.YHocuspocus server)	Sets the YHocuspocus server (required).

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

server

public YHocuspocusWebSocketConfigurer.Builder server(net.carcdr.yhocuspocus.core.YHocuspocus server)

Sets the YHocuspocus server (required).

Parameters:

server - the server instance

Returns:

this builder

path

public YHocuspocusWebSocketConfigurer.Builder path(String path)

Sets the WebSocket endpoint path.

Parameters:

path - the path (must start with '/')

Returns:

this builder

Throws:

IllegalArgumentException - if path is null or doesn't start with '/'

allowedOrigins

public YHocuspocusWebSocketConfigurer.Builder allowedOrigins(String... origins)

Sets the allowed origins for CORS.

Parameters:

origins - allowed origins (use "*" for all)

Returns:

this builder

addInterceptor

public YHocuspocusWebSocketConfigurer.Builder addInterceptor(org.springframework.web.socket.server.HandshakeInterceptor interceptor)

Adds a handshake interceptor.

Interceptors can be used for authentication, adding session attributes, and other pre-connection logic.

Parameters:

interceptor - the interceptor to add

Returns:

this builder

build

public YHocuspocusWebSocketConfigurer build()

Builds the configurer.

Returns:

new YHocuspocusWebSocketConfigurer instance

Throws:

IllegalStateException - if server is not set