Package net.carcdr.yhocuspocus.spring.autoconfigure

Class YHocuspocusProperties

java.lang.Object

net.carcdr.yhocuspocus.spring.autoconfigure.YHocuspocusProperties

@ConfigurationProperties(prefix="yhocuspocus")
public class YHocuspocusProperties
extends Object

Configuration properties for YHocuspocus Spring integration.

These properties can be configured in application.yml or application.properties:

 yhocuspocus:
   path: /collaboration
   allowed-origins:
     - "http://localhost:3000"
   debounce: 2s
   max-debounce: 10s
 

Since:

1.0.0

Constructor Summary

Constructors

Constructor	Description
YHocuspocusProperties()

Method Summary

Modifier and Type	Method	Description
List<String>	getAllowedOrigins()	Gets the allowed origins.
Duration	getDebounce()	Gets the debounce duration.
Duration	getMaxDebounce()	Gets the maximum debounce duration.
String	getPath()	Gets the WebSocket endpoint path.
void	setAllowedOrigins(List<String> allowedOrigins)	Sets the allowed origins.
void	setDebounce(Duration debounce)	Sets the debounce duration.
void	setMaxDebounce(Duration maxDebounce)	Sets the maximum debounce duration.
void	setPath(String path)	Sets the WebSocket endpoint path.

Methods inherited from class java.lang.Object

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

Constructor Details

YHocuspocusProperties

public YHocuspocusProperties()

Method Details

getPath

public String getPath()

Gets the WebSocket endpoint path.

Returns:

the path

setPath

public void setPath(String path)

Sets the WebSocket endpoint path.

Parameters:

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

getAllowedOrigins

public List<String> getAllowedOrigins()

Gets the allowed origins.

Returns:

list of allowed origins

setAllowedOrigins

public void setAllowedOrigins(List<String> allowedOrigins)

Sets the allowed origins.

Parameters:

allowedOrigins - list of allowed origins

getDebounce

public Duration getDebounce()

Gets the debounce duration.

Returns:

debounce duration

setDebounce

public void setDebounce(Duration debounce)

Sets the debounce duration.

Parameters:

debounce - debounce duration

getMaxDebounce

public Duration getMaxDebounce()

Gets the maximum debounce duration.

Returns:

max debounce duration

setMaxDebounce

public void setMaxDebounce(Duration maxDebounce)

Sets the maximum debounce duration.

Parameters:

maxDebounce - max debounce duration