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

Merge branch '5.3.x'

This commit is contained in:
rstoyanchev 2022-09-12 12:27:31 +01:00
parent a085a1b6b6 4e97776969
commit c854e35c9d
9 changed files with 138 additions and 86 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

87
spring-messaging/src/main/java/org/springframework/messaging/simp/stomp/DefaultStompSession.java
View File

@ -19,7 +19,6 @@ package org.springframework.messaging.simp.stomp;
import java.lang.reflect.Type;
import java.time.Instant;
import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
import java.util.Map;
import java.util.concurrent.CompletableFuture;
@ -28,6 +27,7 @@ import java.util.concurrent.ExecutionException;
import java.util.concurrent.ScheduledFuture;
import java.util.concurrent.TimeUnit;
import java.util.concurrent.atomic.AtomicInteger;
import java.util.function.Consumer;
import org.apache.commons.logging.Log;
@ -439,7 +439,7 @@ public class DefaultStompSession implements ConnectionHandlingStompSession {
String receiptId = headers.getReceiptId();
ReceiptHandler handler = this.receiptHandlers.get(receiptId);
if (handler != null) {
handler.handleReceiptReceived();
handler.handleReceiptReceived(headers);
}
else if (logger.isDebugEnabled()) {
logger.debug("No matching receipt: " + accessor.getDetailedLogMessage(message.getPayload()));
@ -544,7 +544,7 @@ public class DefaultStompSession implements ConnectionHandlingStompSession {
@Nullable
private final String receiptId;
private final List<Runnable> receiptCallbacks = new ArrayList<>(2);
private final List<Consumer<StompHeaders>> receiptCallbacks = new ArrayList<>(2);
private final List<Runnable> receiptLostCallbacks = new ArrayList<>(2);
@ -554,6 +554,9 @@ public class DefaultStompSession implements ConnectionHandlingStompSession {
@Nullable
private Boolean result;
@Nullable
private StompHeaders receiptHeaders;
public ReceiptHandler(@Nullable String receiptId) {
this.receiptId = receiptId;
if (receiptId != null) {
@ -576,64 +579,80 @@ public class DefaultStompSession implements ConnectionHandlingStompSession {
@Override
public void addReceiptTask(Runnable task) {
addTask(task, true);
addReceiptTask(headers -> task.run());
}
@Override
public void addReceiptTask(Consumer<StompHeaders> task) {
Assert.notNull(this.receiptId, "Set autoReceiptEnabled to track receipts or add a 'receiptId' header");
synchronized (this) {
if (this.result != null) {
if (this.result) {
task.accept(this.receiptHeaders);
}
}
else {
this.receiptCallbacks.add(task);
}
}
}
@Override
public void addReceiptLostTask(Runnable task) {
addTask(task, false);
}
private void addTask(Runnable task, boolean successTask) {
Assert.notNull(this.receiptId,
"To track receipts, set autoReceiptEnabled=true or add 'receiptId' header");
synchronized (this) {
if (this.result != null && this.result == successTask) {
invoke(Collections.singletonList(task));
if (this.result != null) {
if (!this.result) {
task.run();
}
}
else {
if (successTask) {
this.receiptCallbacks.add(task);
}
else {
this.receiptLostCallbacks.add(task);
}
this.receiptLostCallbacks.add(task);
}
}
}
private void invoke(List<Runnable> callbacks) {
for (Runnable runnable : callbacks) {
try {
runnable.run();
}
catch (Throwable ex) {
// ignore
}
}
}
public void handleReceiptReceived() {
handleInternal(true);
public void handleReceiptReceived(StompHeaders receiptHeaders) {
handleInternal(true, receiptHeaders);
}
public void handleReceiptNotReceived() {
handleInternal(false);
handleInternal(false, null);
}
private void handleInternal(boolean result) {
private void handleInternal(boolean result, @Nullable StompHeaders receiptHeaders) {
synchronized (this) {
if (this.result != null) {
return;
}
this.result = result;
invoke(result ? this.receiptCallbacks : this.receiptLostCallbacks);
this.receiptHeaders = receiptHeaders;
if (result) {
this.receiptCallbacks.forEach(consumer -> {
try {
consumer.accept(this.receiptHeaders);
}
catch (Throwable ex) {
// ignore
}
});
}
else {
this.receiptLostCallbacks.forEach(task -> {
try {
task.run();
}
catch (Throwable ex) {
// ignore
}
});
}
DefaultStompSession.this.receiptHandlers.remove(this.receiptId);
if (this.future != null) {
this.future.cancel(true);
}
}
}
}

19
spring-messaging/src/main/java/org/springframework/messaging/simp/stomp/StompSession.java
View File

@ -1,5 +1,5 @@
/*
* Copyright 2002-2019 the original author or authors.
* 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.
@ -16,6 +16,8 @@
package org.springframework.messaging.simp.stomp;
import java.util.function.Consumer;
import org.springframework.lang.Nullable;
/**
@ -139,16 +141,27 @@ public interface StompSession {
/**
* Task to invoke when a receipt is received.
* @param task the task to invoke
* @throws java.lang.IllegalArgumentException if the receiptId is {@code null}
*/
void addReceiptTask(Runnable runnable);
void addReceiptTask(Runnable task);
/**
* Variant of {@link #addReceiptTask(Runnable)} with a {@link Consumer}
* of the headers from the {@code RECEIPT} frame.
* @param task the consumer to invoke
* @throws java.lang.IllegalArgumentException if the receiptId is {@code null}
* @since 5.3.23
*/
void addReceiptTask(Consumer<StompHeaders> task);
/**
* Task to invoke when a receipt is not received in the configured time.
* @param task the task to invoke
* @throws java.lang.IllegalArgumentException if the receiptId is {@code null}
* @see org.springframework.messaging.simp.stomp.StompClientSupport#setReceiptTimeLimit(long)
*/
void addReceiptLostTask(Runnable runnable);
void addReceiptLostTask(Runnable task);
}

20
spring-messaging/src/test/java/org/springframework/messaging/simp/stomp/DefaultStompSessionTests.java
View File

@ -575,22 +575,30 @@ public class DefaultStompSessionTests {
this.session.setTaskScheduler(mock(TaskScheduler.class));
AtomicReference<Boolean> received = new AtomicReference<>();
AtomicReference<StompHeaders> receivedHeaders = new AtomicReference<>();
StompHeaders headers = new StompHeaders();
headers.setDestination("/topic/foo");
headers.setReceipt("my-receipt");
Subscription subscription = this.session.subscribe(headers, mock(StompFrameHandler.class));
subscription.addReceiptTask(() -> received.set(true));
subscription.addReceiptTask(receiptHeaders -> {
received.set(true);
receivedHeaders.set(receiptHeaders);
});
assertThat((Object) received.get()).isNull();
StompHeaderAccessor accessor = StompHeaderAccessor.create(StompCommand.RECEIPT);
accessor.setReceiptId("my-receipt");
accessor.setNativeHeader("foo", "bar");
accessor.setLeaveMutable(true);
this.session.handleMessage(MessageBuilder.createMessage(new byte[0], accessor.getMessageHeaders()));
assertThat(received.get()).isNotNull();
assertThat(received.get()).isTrue();
assertThat(receivedHeaders.get()).isNotNull();
assertThat(receivedHeaders.get().get("foo").size()).isEqualTo(1);
assertThat(receivedHeaders.get().get("foo").get(0)).isEqualTo("bar");
}
@Test
@ -599,6 +607,7 @@ public class DefaultStompSessionTests {
this.session.setTaskScheduler(mock(TaskScheduler.class));
AtomicReference<Boolean> received = new AtomicReference<>();
AtomicReference<StompHeaders> receivedHeaders = new AtomicReference<>();
StompHeaders headers = new StompHeaders();
headers.setDestination("/topic/foo");
@ -607,13 +616,20 @@ public class DefaultStompSessionTests {
StompHeaderAccessor accessor = StompHeaderAccessor.create(StompCommand.RECEIPT);
accessor.setReceiptId("my-receipt");
accessor.setNativeHeader("foo", "bar");
accessor.setLeaveMutable(true);
this.session.handleMessage(MessageBuilder.createMessage(new byte[0], accessor.getMessageHeaders()));
subscription.addReceiptTask(() -> received.set(true));
subscription.addReceiptTask(receiptHeaders -> {
received.set(true);
receivedHeaders.set(receiptHeaders);
});
assertThat(received.get()).isNotNull();
assertThat(received.get()).isTrue();
assertThat(receivedHeaders.get()).isNotNull();
assertThat(receivedHeaders.get().get("foo").size()).isEqualTo(1);
assertThat(receivedHeaders.get().get("foo").get(0)).isEqualTo("bar");
}
@Test

22
spring-websocket/src/main/java/org/springframework/web/socket/client/ConnectionManagerSupport.java
View File

@ -25,11 +25,11 @@ import org.springframework.context.SmartLifecycle;
import org.springframework.web.util.UriComponentsBuilder;
/**
* A base class for WebSocket connection managers. Provides a declarative style of
* connecting to a WebSocket server given a URI to connect to. The connection occurs when
* the Spring ApplicationContext is refreshed, if the {@link #autoStartup} property is set
* to {@code true}, or if set to {@code false}, the {@link #start()} and #stop methods can
* be invoked manually.
* Base class for a connection manager that automates the process of connecting
* to a WebSocket server with the Spring ApplicationContext lifecycle. Connects
* to a WebSocket server on {@link #start()} and disconnects on {@link #stop()}.
* If {@link #setAutoStartup(boolean)} is set to {@code true} this will be done
* automatically when the Spring {@code ApplicationContext} is refreshed.
*
* @author Rossen Stoyanchev
* @since 4.0
@ -163,11 +163,19 @@ public abstract class ConnectionManagerSupport implements SmartLifecycle {
return this.running;
}
/**
* Whether the connection is open/{@code true} or closed/{@code false}.
*/
public abstract boolean isConnected();
/**
* Subclasses implement this to actually establish the connection.
*/
protected abstract void openConnection();
/**
* Subclasses implement this to close the connection.
*/
protected abstract void closeConnection() throws Exception;
protected abstract boolean isConnected();
}

29
spring-websocket/src/main/java/org/springframework/web/socket/client/WebSocketConnectionManager.java
View File

@ -28,10 +28,9 @@ import org.springframework.web.socket.WebSocketSession;
import org.springframework.web.socket.handler.LoggingWebSocketHandlerDecorator;
/**
* A WebSocket connection manager that is given a URI, a {@link WebSocketClient}, and a
* {@link WebSocketHandler}, connects to a WebSocket server through {@link #start()} and
* {@link #stop()} methods. If {@link #setAutoStartup(boolean)} is set to {@code true}
* this will be done automatically when the Spring ApplicationContext is refreshed.
* WebSocket {@link ConnectionManagerSupport connection manager} that connects
* to the server via {@link WebSocketClient} and handles the session with a
* {@link WebSocketHandler}.
*
* @author Rossen Stoyanchev
* @author Sam Brannen
@ -58,14 +57,6 @@ public class WebSocketConnectionManager extends ConnectionManagerSupport {
}
/**
* Decorate the WebSocketHandler provided to the class constructor.
* <p>By default {@link LoggingWebSocketHandlerDecorator} is added.
*/
protected WebSocketHandler decorateWebSocketHandler(WebSocketHandler handler) {
return new LoggingWebSocketHandlerDecorator(handler);
}
/**
* Set the sub-protocols to use. If configured, specified sub-protocols will be
* requested in the handshake through the {@code Sec-WebSocket-Protocol} header. The
@ -130,6 +121,11 @@ public class WebSocketConnectionManager extends ConnectionManagerSupport {
super.stopInternal();
}
@Override
public boolean isConnected() {
return (this.webSocketSession != null && this.webSocketSession.isOpen());
}
@Override
protected void openConnection() {
if (logger.isInfoEnabled()) {
@ -157,9 +153,12 @@ public class WebSocketConnectionManager extends ConnectionManagerSupport {
}
}
@Override
protected boolean isConnected() {
return (this.webSocketSession != null && this.webSocketSession.isOpen());
/**
* Decorate the WebSocketHandler provided to the class constructor.
* <p>By default {@link LoggingWebSocketHandlerDecorator} is added.
*/
protected WebSocketHandler decorateWebSocketHandler(WebSocketHandler handler) {
return new LoggingWebSocketHandlerDecorator(handler);
}
}

22
spring-websocket/src/main/java/org/springframework/web/socket/client/standard/AnnotatedEndpointConnectionManager.java
View File

@ -1,5 +1,5 @@
/*
* Copyright 2002-2018 the original author or authors.
* 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.
@ -31,11 +31,9 @@ import org.springframework.web.socket.client.ConnectionManagerSupport;
import org.springframework.web.socket.handler.BeanCreatingHandlerProvider;
/**
* A WebSocket connection manager that is given a URI, a
* {@link jakarta.websocket.ClientEndpoint}-annotated endpoint, connects to a
* WebSocket server through the {@link #start()} and {@link #stop()} methods.
* If {@link #setAutoStartup(boolean)} is set to {@code true} this will be
* done automatically when the Spring ApplicationContext is refreshed.
* WebSocket {@link ConnectionManagerSupport connection manager} that connects
* to the server via {@link WebSocketContainer} and handles the session with an
* {@link javax.websocket.ClientEndpoint @ClientEndpoint} endpoint.
*
* @author Rossen Stoyanchev
* @since 4.0
@ -101,6 +99,12 @@ public class AnnotatedEndpointConnectionManager extends ConnectionManagerSupport
}
@Override
public boolean isConnected() {
Session session = this.session;
return (session != null && session.isOpen());
}
@Override
protected void openConnection() {
this.taskExecutor.execute(() -> {
@ -135,10 +139,4 @@ public class AnnotatedEndpointConnectionManager extends ConnectionManagerSupport
}
}
@Override
protected boolean isConnected() {
Session session = this.session;
return (session != null && session.isOpen());
}
}

21
spring-websocket/src/main/java/org/springframework/web/socket/client/standard/EndpointConnectionManager.java
View File

@ -1,5 +1,5 @@
/*
* Copyright 2002-2018 the original author or authors.
* 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.
@ -39,10 +39,9 @@ import org.springframework.web.socket.client.ConnectionManagerSupport;
import org.springframework.web.socket.handler.BeanCreatingHandlerProvider;
/**
* A WebSocket connection manager that is given a URI, an {@link Endpoint}, connects to a
* WebSocket server through the {@link #start()} and {@link #stop()} methods. If
* {@link #setAutoStartup(boolean)} is set to {@code true} this will be done automatically
* when the Spring ApplicationContext is refreshed.
* WebSocket {@link ConnectionManagerSupport connection manager} that connects
* to the server via {@link WebSocketContainer} and handles the session with an
* {@link Endpoint}.
*
* @author Rossen Stoyanchev
* @since 4.0
@ -133,6 +132,12 @@ public class EndpointConnectionManager extends ConnectionManagerSupport implemen
}
@Override
public boolean isConnected() {
Session session = this.session;
return (session != null && session.isOpen());
}
@Override
protected void openConnection() {
this.taskExecutor.execute(() -> {
@ -168,10 +173,4 @@ public class EndpointConnectionManager extends ConnectionManagerSupport implemen
}
}
@Override
protected boolean isConnected() {
Session session = this.session;
return (session != null && session.isOpen());
}
}

2
src/docs/asciidoc/integration.adoc
View File

@ -325,7 +325,7 @@ to serialize only a subset of the object properties, as the following example sh
----
[[rest-template-multipart]]
===== Multipart
==== Multipart
To send multipart data, you need to provide a `MultiValueMap<String, Object>` whose values
may be an `Object` for part content, a `Resource` for a file part, or an `HttpEntity` for

2
src/docs/asciidoc/web/websocket.adoc
View File

@ -1347,7 +1347,7 @@ receipt if the server supports it (simple broker does not). For example, with th
headers.setDestination("/topic/...");
headers.setReceipt("r1");
FrameHandler handler = ...;
stompSession.subscribe(headers, handler).addReceiptTask(() -> {
stompSession.subscribe(headers, handler).addReceiptTask(receiptHeaders -> {
// Subscription ready...
});
----