root
/
spring-framework
mirror of https://github.com/spring-projects/spring-framework.git
1
0
Fork 0
Code Issues Actions 6 Packages Projects Releases Wiki Activity

Update ServerEndpointRegistration 

In addition to implementing ServerEndpointConfig, the
ServerEndpointRegistration now also extends
ServerEndpointConfig.Configurator making it easier to override
handshake customization methods without having to extend a separate
class.
This commit is contained in:
Rossen Stoyanchev 2013-08-16 15:44:30 -04:00
parent 64d45fe0a5
commit 48996cf572
1 changed files with 32 additions and 45 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

47
spring-websocket/src/main/java/org/springframework/web/socket/server/endpoint/ServerEndpointRegistration.java
View File

@ -36,19 +36,26 @@ import org.springframework.util.Assert;
import org.springframework.web.socket.support.BeanCreatingHandlerProvider;
/**
* An implementation of {@link javax.websocket.server.ServerEndpointConfig} that also
* contains the target {@link javax.websocket.Endpoint}, provided either as a reference or
* as a bean name.
*
* <p>{@link ServerEndpointRegistration} beans are detected by
* An implementation of {@link javax.websocket.server.ServerEndpointConfig} for use in
* Spring applications. A {@link ServerEndpointRegistration} bean is detected by
* {@link ServerEndpointExporter} and registered with a Java WebSocket runtime at startup.
*
* <p>Class constructors accept a singleton {@link javax.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 javax.websocket.server.ServerEndpointConfig.Configurator} to make it easier to
* override methods for customizing the handshake process.
*
* @author Rossen Stoyanchev
* @since 4.0
*
* @see ServerEndpointExporter
*/
public class ServerEndpointRegistration implements ServerEndpointConfig, BeanFactoryAware {
public class ServerEndpointRegistration extends ServerEndpointConfig.Configurator
implements ServerEndpointConfig, BeanFactoryAware {
private final String path;
@ -66,8 +73,6 @@ public class ServerEndpointRegistration implements ServerEndpointConfig, BeanFac
private final Map<String, Object> userProperties = new HashMap<String, Object>();
private final Configurator configurator = new EndpointRegistrationConfigurator();
/**
* Create a new {@link ServerEndpointRegistration} instance from an
@ -161,7 +166,7 @@ public class ServerEndpointRegistration implements ServerEndpointConfig, BeanFac
@Override
public Configurator getConfigurator() {
return this.configurator;
return this;
}
@Override
@ -171,34 +176,17 @@ public class ServerEndpointRegistration implements ServerEndpointConfig, BeanFac
}
}
protected void modifyHandshake(HandshakeRequest request, HandshakeResponse response) {
this.configurator.modifyHandshake(this, request, response);
}
protected boolean checkOrigin(String originHeaderValue) {
return this.configurator.checkOrigin(originHeaderValue);
}
protected String getNegotiatedSubprotocol(List<String> supported, List<String> requested) {
return this.configurator.getNegotiatedSubprotocol(supported, requested);
}
protected List<Extension> getNegotiatedExtensions(List<Extension> installed, List<Extension> requested) {
return this.configurator.getNegotiatedExtensions(installed, requested);
}
private class EndpointRegistrationConfigurator extends Configurator {
// Implementations of ServerEndpointConfig.Configurator
@SuppressWarnings("unchecked")
@Override
public <T> T getEndpointInstance(Class<T> clazz) throws InstantiationException {
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(sec, request, response);
super.modifyHandshake(this, request, response);
}
@Override
@ -215,6 +203,5 @@ public class ServerEndpointRegistration implements ServerEndpointConfig, BeanFac
public List<Extension> getNegotiatedExtensions(List<Extension> installed, List<Extension> requested) {
return super.getNegotiatedExtensions(installed, requested);
}
}
}