/
ServerEndpointRegistration.java
216 lines (175 loc) · 6.07 KB
/
ServerEndpointRegistration.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
/*
* Copyright 2002-2022 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.springframework.web.socket.server.standard;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import jakarta.websocket.Decoder;
import jakarta.websocket.Encoder;
import jakarta.websocket.Endpoint;
import jakarta.websocket.Extension;
import jakarta.websocket.HandshakeResponse;
import jakarta.websocket.server.HandshakeRequest;
import jakarta.websocket.server.ServerEndpointConfig;
import org.springframework.beans.factory.BeanFactory;
import org.springframework.beans.factory.BeanFactoryAware;
import org.springframework.lang.Nullable;
import org.springframework.util.Assert;
import org.springframework.web.socket.handler.BeanCreatingHandlerProvider;
/**
* An implementation of {@link jakarta.websocket.server.ServerEndpointConfig} for use in
* Spring-based applications. A {@link ServerEndpointRegistration} bean is detected by
* {@link ServerEndpointExporter} and registered with a Jakarta WebSocket runtime at startup.
*
* <p>Class constructors accept a singleton {@link jakarta.websocket.Endpoint} instance
* or an Endpoint specified by type {@link Class}. When specified by type, the endpoint
* will be instantiated and initialized through the Spring ApplicationContext before
* each client WebSocket connection.
*
* <p>This class also extends
* {@link jakarta.websocket.server.ServerEndpointConfig.Configurator} to make it easier
* to override methods for customizing the handshake process.
*
* @author Rossen Stoyanchev
* @author Juergen Hoeller
* @since 4.0
* @see ServerEndpointExporter
*/
public class ServerEndpointRegistration extends ServerEndpointConfig.Configurator
implements ServerEndpointConfig, BeanFactoryAware {
private final String path;
@Nullable
private final Endpoint endpoint;
@Nullable
private final BeanCreatingHandlerProvider<Endpoint> endpointProvider;
private List<String> subprotocols = new ArrayList<>(0);
private List<Extension> extensions = new ArrayList<>(0);
private List<Class<? extends Encoder>> encoders = new ArrayList<>(0);
private List<Class<? extends Decoder>> decoders = new ArrayList<>(0);
private final Map<String, Object> userProperties = new HashMap<>(4);
/**
* Create a new {@link ServerEndpointRegistration} instance from an
* {@code jakarta.websocket.Endpoint} instance.
* @param path the endpoint path
* @param endpoint the endpoint instance
*/
public ServerEndpointRegistration(String path, Endpoint endpoint) {
Assert.hasText(path, "Path must not be empty");
Assert.notNull(endpoint, "Endpoint must not be null");
this.path = path;
this.endpoint = endpoint;
this.endpointProvider = null;
}
/**
* Create a new {@link ServerEndpointRegistration} instance from an
* {@code jakarta.websocket.Endpoint} class.
* @param path the endpoint path
* @param endpointClass the endpoint class
*/
public ServerEndpointRegistration(String path, Class<? extends Endpoint> endpointClass) {
Assert.hasText(path, "Path must not be empty");
Assert.notNull(endpointClass, "Endpoint Class must not be null");
this.path = path;
this.endpoint = null;
this.endpointProvider = new BeanCreatingHandlerProvider<>(endpointClass);
}
// ServerEndpointConfig implementation
@Override
public String getPath() {
return this.path;
}
@Override
public Class<? extends Endpoint> getEndpointClass() {
if (this.endpoint != null) {
return this.endpoint.getClass();
}
else {
Assert.state(this.endpointProvider != null, "No endpoint set");
return this.endpointProvider.getHandlerType();
}
}
public Endpoint getEndpoint() {
if (this.endpoint != null) {
return this.endpoint;
}
else {
Assert.state(this.endpointProvider != null, "No endpoint set");
return this.endpointProvider.getHandler();
}
}
public void setSubprotocols(List<String> subprotocols) {
this.subprotocols = subprotocols;
}
@Override
public List<String> getSubprotocols() {
return this.subprotocols;
}
public void setExtensions(List<Extension> extensions) {
this.extensions = extensions;
}
@Override
public List<Extension> getExtensions() {
return this.extensions;
}
public void setEncoders(List<Class<? extends Encoder>> encoders) {
this.encoders = encoders;
}
@Override
public List<Class<? extends Encoder>> getEncoders() {
return this.encoders;
}
public void setDecoders(List<Class<? extends Decoder>> decoders) {
this.decoders = decoders;
}
@Override
public List<Class<? extends Decoder>> getDecoders() {
return this.decoders;
}
public void setUserProperties(Map<String, Object> userProperties) {
this.userProperties.clear();
this.userProperties.putAll(userProperties);
}
@Override
public Map<String, Object> getUserProperties() {
return this.userProperties;
}
@Override
public Configurator getConfigurator() {
return this;
}
// ServerEndpointConfig.Configurator implementation
@SuppressWarnings("unchecked")
@Override
public final <T> T getEndpointInstance(Class<T> clazz) throws InstantiationException {
return (T) getEndpoint();
}
@Override
public void modifyHandshake(ServerEndpointConfig sec, HandshakeRequest request, HandshakeResponse response) {
super.modifyHandshake(this, request, response);
}
// Remaining methods
@Override
public void setBeanFactory(BeanFactory beanFactory) {
if (this.endpointProvider != null) {
this.endpointProvider.setBeanFactory(beanFactory);
}
}
@Override
public String toString() {
return "ServerEndpointRegistration for path '" + getPath() + "': " + getEndpointClass();
}
}