in.hocg.boot.ws.autoconfiguration.properties.WebSocketProperties Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of ws-spring-boot-autoconfigure Show documentation

The newest version!

package in.hocg.boot.ws.autoconfiguration.properties;

import com.google.common.collect.Lists;
import lombok.Data;
import org.springframework.boot.context.properties.ConfigurationProperties;

import java.util.Collections;
import java.util.List;

/**
 * Created by hocgin on 2020/8/15
 * email: [email protected]
 *
 * @author hocgin
 */
@Data
@ConfigurationProperties(WebSocketProperties.PREFIX)
public class WebSocketProperties {
    public static final String PREFIX = "boot.websocket";

    /**
     * websocket 地址: ws://127.0.0.1:8080/.socket
     */
    private List endpoint = Collections.singletonList("/.socket");
    /**
     * 允许的源
     */
    private List allowedOrigins = Collections.singletonList("*");
    /**
     * 广播前缀，即客户端要订阅的地址 

     * 服务端发送: @SendTo("/queue/all") 

     * 客户端订阅: client.subscribe("/queue/all", handler)
     * 
     */
    private List destinationPrefix = Lists.newArrayList("/topic", "/queue");
    /**
     * 用户点对点前缀, 即客户端要订阅的地址 

     * 服务端发送: @SendToUser(destinations = destinationPrefix + "/errors") 

     * 客户端订阅: client.subscribe('/user/{destinationPrefix}/errors', handler);
     */
    private String userDestinationPrefix = "/user";
    /**
     * 接收应用消息前缀，即客户端要发送到的目标地址 

     * 服务端订阅: @MessageMapping("/index") 

     * 客户端发送: client.send('/app/index', {});
     */
    private String appDestinationPrefix = "/app";
    /**
     * withSockJS
     */
    private Boolean withSockJS = true;

    private Integer bufferSize = 1024 * 1024;

    private Integer bufferSizeLimit = 1024 * 1024;

    /**
     * 忽略的路径(支持表达式) -- 暂未启用
     */
    private List ignoreUrls = Collections.emptyList();
    /**
     * 拒绝访问(支持表达式) -- 暂未启用
     */
    private List denyUrls = Collections.emptyList();
    /**
     * 需认证(支持表达式) -- 暂未启用
     */
    private List authenticatedUrls = Collections.emptyList();
}