Package net.carcdr.yhocuspocus.spring.websocket

Class YHocuspocusWebSocketConfigurer

java.lang.Object

net.carcdr.yhocuspocus.spring.websocket.YHocuspocusWebSocketConfigurer

All Implemented Interfaces:

org.springframework.web.socket.config.annotation.WebSocketConfigurer

public final class YHocuspocusWebSocketConfigurer
extends Object
implements org.springframework.web.socket.config.annotation.WebSocketConfigurer

Configures WebSocket handling for YHocuspocus.

Use the builder to configure paths, allowed origins, and interceptors:

 YHocuspocusWebSocketConfigurer configurer = YHocuspocusWebSocketConfigurer.builder()
     .server(hocuspocus)
     .path("/collaboration")
     .allowedOrigins("http://localhost:3000")
     .build();
 

The configurer implements WebSocketConfigurer and can be used directly with Spring's @EnableWebSocket annotation.

Since:

1.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	YHocuspocusWebSocketConfigurer.Builder	Builder for YHocuspocusWebSocketConfigurer.

Method Summary

Modifier and Type	Method	Description
static YHocuspocusWebSocketConfigurer.Builder	builder()	Creates a new builder.
String[]	getAllowedOrigins()	Gets the allowed origins.
SpringWebSocketHandler	getHandler()	Gets the WebSocket handler.
String	getPath()	Gets the configured WebSocket path.
net.carcdr.yhocuspocus.core.YHocuspocus	getServer()	Gets the YHocuspocus server instance.
void	registerWebSocketHandlers(org.springframework.web.socket.config.annotation.WebSocketHandlerRegistry registry)

Methods inherited from class java.lang.Object

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

Method Details

registerWebSocketHandlers

public void registerWebSocketHandlers(org.springframework.web.socket.config.annotation.WebSocketHandlerRegistry registry)

Specified by:

registerWebSocketHandlers in interface org.springframework.web.socket.config.annotation.WebSocketConfigurer

getPath

public String getPath()

Gets the configured WebSocket path.

Returns:

the path

getServer

public net.carcdr.yhocuspocus.core.YHocuspocus getServer()

Gets the YHocuspocus server instance.

Returns:

the server

getHandler

public SpringWebSocketHandler getHandler()

Gets the WebSocket handler.

Returns:

the handler

getAllowedOrigins

public String[] getAllowedOrigins()

Gets the allowed origins.

Returns:

copy of allowed origins array

builder

public static YHocuspocusWebSocketConfigurer.Builder builder()

Creates a new builder.

Returns:

builder instance