8000 refactor!: Renamings in new handlers API (#21408) · vaadin/flow@0a52666 · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

Commit 0a52666

Browse files
mshabarovmshabarov
authored
refactor!: Renamings in new handlers API (#21408)
* refactor!: Renamings in new handlers API * fix test
1 parent 1a62eab commit 0a52666

33 files changed

+54
-91
lines changed

‎flow-html-components/src/main/java/com/vaadin/flow/component/html/Anchor.java

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,7 @@
2727
import com.vaadin.flow.component.PropertyDescriptors;
2828
import com.vaadin.flow.component.Tag;
2929
import com.vaadin.flow.server.AbstractStreamResource;
30-
import com.vaadin.flow.server.DownloadHandler;
31-
import com.vaadin.flow.server.ElementRequestHandler;
30+
import com.vaadin.flow.server.streams.DownloadHandler;
3231
import com.vaadin.flow.server.StreamResource;
3332
import com.vaadin.flow.server.StreamResourceRegistry;
3433

‎flow-html-components/src/main/java/com/vaadin/flow/component/html/HtmlObject.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@
2626
import com.vaadin.flow.component.PropertyDescriptors;
2727
import com.vaadin.flow.component.Tag;
2828
import com.vaadin.flow.server.AbstractStreamResource;
29-
import com.vaadin.flow.server.DownloadHandler;
29+
import com.vaadin.flow.server.streams.DownloadHandler;
3030
import com.vaadin.flow.server.StreamResource;
3131
import com.vaadin.flow.server.StreamResourceRegistry;
3232

‎flow-html-components/src/main/java/com/vaadin/flow/component/html/IFrame.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
import com.vaadin.flow.component.PropertyDescriptors;
2222
import com.vaadin.flow.component.Tag;
2323
import com.vaadin.flow.server.AbstractStreamResource;
24-
import com.vaadin.flow.server.DownloadHandler;
24+
import com.vaadin.flow.server.streams.DownloadHandler;
2525
import com.vaadin.flow.server.StreamResource;
2626
import com.vaadin.flow.server.StreamResourceRegistry;
2727

‎flow-html-components/src/main/java/com/vaadin/flow/component/html/Image.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@
2424
import com.vaadin.flow.component.PropertyDescriptors;
2525
import com.vaadin.flow.component.Tag;
2626
import com.vaadin.flow.server.AbstractStreamResource;
27-
import com.vaadin.flow.server.DownloadHandler;
27+
import com.vaadin.flow.server.streams.DownloadHandler;
2828
import com.vaadin.flow.server.StreamResource;
2929
import com.vaadin.flow.server.StreamResourceRegistry;
3030

‎flow-html-components/src/test/java/com/vaadin/flow/component/html/AnchorTest.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@
2424
import com.vaadin.flow.component.Text;
2525
import com.vaadin.flow.component.UI;
2626
import com.vaadin.flow.server.AbstractStreamResource;
27-
import com.vaadin.flow.server.DownloadHandler;
27+
import com.vaadin.flow.server.streams.DownloadHandler;
2828

2929
public class AnchorTest extends ComponentTest {
3030

‎flow-html-components/src/test/java/com/vaadin/flow/component/html/HtmlComponentSmokeTest.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@
4949
import com.vaadin.flow.internal.StateNode;
5050
import com.vaadin.flow.internal.change.NodeChange;
5151
import com.vaadin.flow.server.AbstractStreamResource;
52-
import com.vaadin.flow.server.DownloadHandler;
52+
import com.vaadin.flow.server.streams.DownloadHandler;
5353

5454
public class HtmlComponentSmokeTest {
5555

‎flow-server/src/main/java/com/vaadin/flow/server/StreamResourceRegistry.java

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@
2525
import com.vaadin.flow.component.UI;
2626
import com.vaadin.flow.dom.Element;
2727
import com.vaadin.flow.server.communication.StreamRequestHandler;
28+
import com.vaadin.flow.server.streams.ElementRequestHandler;
2829

2930
/**
3031
* Registry for {@link StreamResource} instances.

‎flow-server/src/main/java/com/vaadin/flow/server/streams/AbstractDownloadHandler.java

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,6 @@
1616

1717
package com.vaadin.flow.server.streams;
1818

19-
import com.vaadin.flow.server.DownloadHandler;
20-
import com.vaadin.flow.server.DownloadEvent;
21-
2219
/**
2320
* Abstract class for common methods used in pre-made download handlers.
2421
*

‎flow-server/src/main/java/com/vaadin/flow/server/streams/AbstractFileUploadHandler.java

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,6 @@
2323
import java.io.UncheckedIOException;
2424

2525
import com.vaadin.flow.function.SerializableBiConsumer;
26-
import com.vaadin.flow.server.TransferProgressListener;
2726

2827
/**
2928
* Abstract class for file upload handler.

‎flow-server/src/main/java/com/vaadin/flow/server/streams/ClassDownloadHandler.java

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,9 +23,7 @@
2323

2424
import org.slf4j.LoggerFactory;
2525

26-
import com.vaadin.flow.server.DownloadEvent;
2726
import com.vaadin.flow.server.HttpStatusCode;
28-
import com.vaadin.flow.server.TransferProgressListener;
2927

3028
/**
3129
* Download handler for serving a class resource.

‎flow-server/src/main/java/com/vaadin/flow/server/DownloadEvent.java renamed to ‎flow-server/src/main/java/com/vaadin/flow/server/streams/DownloadEvent.java

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
* the License.
1515
*/
1616

17-
package com.vaadin.flow.server;
17+
package com.vaadin.flow.server.streams;
1818

1919
import java.io.IOException;
2020
import java.io.OutputStream;
@@ -27,6 +27,9 @@
2727
import com.vaadin.flow.component.Component;
2828
import com.vaadin.flow.component.UI;
2929
import com.vaadin.flow.dom.Element;
30+
import com.vaadin.flow.server.VaadinRequest;
31+
import com.vaadin.flow.server.VaadinResponse;
32+
import com.vaadin.flow.server.VaadinSession;
3033

3134
/**
3235
* Class containing data on requested client download.
@@ -134,6 +137,15 @@ public Component getOwningComponent() {
134137
return owningElement.getComponent().orElse(null);
135138
}
136139

140+
/**
141+
* Get the owning element for the download related to this event.
142+
*
143+
* @return owning element
144+
*/
145+
public Element getOwningElement() {
146+
return owningElement;
147+
}
148+
137149
/**
138150
* Get the UI instance for this request.
139151
*

‎flow-server/src/main/java/com/vaadin/flow/server/DownloadHandler.java renamed to ‎flow-server/src/main/java/com/vaadin/flow/server/streams/DownloadHandler.java

Lines changed: 4 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -14,24 +14,16 @@
1414
* the License.
1515
*/
1616

17-
package com.vaadin.flow.server;
17+
package com.vaadin.flow.server.streams;
1818

1919
import java.io.File;
20-
import java.io.InputStream;
21-
import java.io.OutputStream;
22-
import java.util.Collection;
2320
import java.util.Optional;
2421

2522
import com.vaadin.flow.dom.Element;
26-
import com.vaadin.flow.function.SerializableConsumer;
2723
import com.vaadin.flow.function.SerializableFunction;
28-
import com.vaadin.flow.server.streams.AbstractDownloadHandler;
29-
import com.vaadin.flow.server.streams.ClassDownloadHandler;
30-
import com.vaadin.flow.server.streams.DownloadResponse;
31-
import com.vaadin.flow.server.streams.FileDownloadHandler;
32-
import com.vaadin.flow.server.streams.InputStreamDownloadHandler;
33-
import com.vaadin.flow.server.streams.ServletResourceDownloadHandler;
34-
import com.vaadin.flow.server.streams.TransferContext;
24+
import com.vaadin.flow.server.VaadinRequest;
25+
import com.vaadin.flow.server.VaadinResponse;
26+
import com.vaadin.flow.server.VaadinSession;
3527

3628
/**
3729
* Interface for handling download of data from the server to the client.

‎flow-server/src/main/java/com/vaadin/flow/server/ElementRequestHandler.java renamed to ‎flow-server/src/main/java/com/vaadin/flow/server/streams/ElementRequestHandler.java

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,12 +13,15 @@
1313
* License for the specific language governing permissions and limitations under
1414
* the License.
1515
*/
16-
package com.vaadin.flow.server;
16+
package com.vaadin.flow.server.streams;
1717

1818
import java.io.Serializable;
1919

2020
import com.vaadin.flow.dom.DisabledUpdateMode;
2121
import com.vaadin.flow.dom.Element;
22+
import com.vaadin.flow.server.VaadinRequest;
23+
import com.vaadin.flow.server.VaadinResponse;
24+
import com.vaadin.flow.server.VaadinSession;
2225

2326
/**
2427
* Request handler callback for handing client-server or server-client data

‎flow-server/src/main/java/com/vaadin/flow/server/streams/FileDownloadHandler.java

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,9 +22,7 @@
2222
import java.io.OutputStream;
2323
import java.io.UncheckedIOException;
2424

25-
import com.vaadin.flow.server.DownloadEvent;
2625
import com.vaadin.flow.server.HttpStatusCode;
27-
import com.vaadin.flow.server.TransferProgressListener;
2826
import com.vaadin.flow.server.VaadinResponse;
2927

3028
/**

‎flow-server/src/main/java/com/vaadin/flow/server/streams/InMemoryUploadHandler.java

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,6 @@
2222
import java.io.UncheckedIOException;
2323

2424
import com.vaadin.flow.function.SerializableBiConsumer;
25-
import com.vaadin.flow.server.TransferProgressListener;
2625

2726
/**
2827
* Upload handler for storing the upload in-memory. Data is returned as a

‎flow-server/src/main/java/com/vaadin/flow/server/streams/InputStreamDownloadHandler.java

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,9 +22,7 @@
2222
import java.io.UncheckedIOException;
2323

2424
import com.vaadin.flow.function.SerializableFunction;
25-
import com.vaadin.flow.server.DownloadEvent;
2625
import com.vaadin.flow.server.HttpStatusCode;
27-
import com.vaadin.flow.server.TransferProgressListener;
2826
import com.vaadin.flow.server.VaadinResponse;
2927

3028
/**

‎flow-server/src/main/java/com/vaadin/flow/server/streams/ServletResourceDownloadHandler.java

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,9 +21,7 @@
2121
import java.io.OutputStream;
2222
import java.io.UncheckedIOException;
2323

24-
import com.vaadin.flow.server.DownloadEvent;
2524
import com.vaadin.flow.server.HttpStatusCode;
26-
import com.vaadin.flow.server.TransferProgressListener;
2725
import com.vaadin.flow.server.VaadinService;
2826
import com.vaadin.flow.server.VaadinServletService;
2927

‎flow-server/src/main/java/com/vaadin/flow/server/streams/TransferContext.java

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,6 @@
1515
*/
1616
package com.vaadin.flow.server.streams;
1717

18-
import java.io.Serializable;
1918
import java.util.Optional;
2019

2120
import com.vaadin.flow.component.Component;
@@ -40,14 +39,14 @@
4039
* name of the file being transferred
4140
* @param owningElement
4241
* the element that initiated the transfer
43-
* @param totalBytes
42+
* @param contentLength
4443
* the total number of bytes to be transferred or <code>-1</code> if
4544
* total number is unknown in advance, e.g. when reading from an
4645
* input stream
4746
*/
4847
public record TransferContext(VaadinRequest request, VaadinResponse response,
4948
VaadinSession session, String fileName, Element owningElement,
50-
long totalBytes) {
49+
long contentLength) {
5150

5251
/**
5352
* Get owner {@link Component} for this event.

‎flow-server/src/main/java/com/vaadin/flow/server/streams/TransferProgressAwareHandler.java

Lines changed: 1 addition & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -19,28 +19,21 @@
1919
import java.io.IOException;
2020
import java.io.Serializable;
2121
import java.util.ArrayList;
22-
import java.util.Collection;
2322
import java.util.Collections;
2423
import java.util.List;
2524
import java.util.Objects;
2625

27-
import com.vaadin.flow.dom.Element;
2826
import com.vaadin.flow.function.SerializableBiConsumer;
2927
import com.vaadin.flow.function.SerializableConsumer;
3028
import com.vaadin.flow.function.SerializableRunnable;
31-
import com.vaadin.flow.server.DownloadEvent;
32-
import com.vaadin.flow.server.TransferProgressListener;
3329
import com.vaadin.flow.shared.Registration;
3430

35-
import elemental.json.JsonValue;
36-
3731
/**
3832
* Abstract class for common methods used in pre-made transfer progress
3933
* handlers.
4034
*
4135
* @param <T>
42-
* type of transfer event, e.g.
43-
* {@link com.vaadin.flow.server.DownloadHandler}
36+
* type of transfer event, e.g. {@link DownloadHandler}
4437
* @param <R>
4538
* type of the subclass implementing this abstract class, needed for
4639
* revealing a proper type when you chain the methods

‎flow-server/src/main/java/com/vaadin/flow/server/TransferProgressListener.java renamed to ‎flow-server/src/main/java/com/vaadin/flow/server/streams/TransferProgressListener.java

Lines changed: 4 additions & 3 deletions
20
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
* the License.
1515
*/
1616

17-
package com.vaadin.flow.server;
17+
package com.vaadin.flow.server.streams;
1818

1919
import java.io.IOException;
20
import java.io.InputStream;
@@ -25,7 +25,8 @@
2525
import java.util.Map;
2626
import java.util.Objects;
2727

28-
import com.vaadin.flow.server.streams.TransferContext;
28+
import com.vaadin.flow.server.Command;
29+
import com.vaadin.flow.server.VaadinSession;
2930

3031
/**
3132
* Interface for listening to transfer progress events.
@@ -198,7 +199,7 @@ static long transfer(InputStream inputStream, OutputStream outputStream,
198199
- lastNotifiedLong >= progressReportInterval) {
199200
long finalTransferred = transferred;
200201
listener.onProgress(transferContext, finalTransferred,
201-
transferContext.totalBytes());
202+
transferContext.contentLength());
202203
lastNotified.put(listener, transferred);
203204
}
204205
}

‎flow-server/src/main/java/com/vaadin/flow/server/streams/UploadEvent.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ public class UploadEvent {
6868
* defined download file name
6969
* @param contentType
7070
* content type string for upload
71-
* @param fileSize
71+
* @param contentLength
7272
* size of the upload
7373
* @param owningElement
7474
* element owning this upload
@@ -80,14 +80,14 @@ public class UploadEvent {
8080
* stream
8181
*/
8282
public UploadEvent(VaadinRequest request, VaadinResponse response,
83-
VaadinSession session, String fileName, long fileSize,
83+
VaadinSession session, String fileName, long contentLength,
8484
String contentType, Element owningElement, FileItemInput item,
8585
Part part) {
8686
this.request = request;
8787
this.response = response;
8888
this.session = session;
8989
this.fileName = fileName;
90-
this.fileSize = fileSize;
90+
this.fileSize = contentLength;
9191
this.owningElement = owningElement;
9292
this.contentType = contentType;
9393
this.item = item;

‎flow-server/src/main/java/com/vaadin/flow/server/streams/UploadHandler.java

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,9 +37,7 @@
3737

3838
import com.vaadin.flow.dom.Element;
3939
import com.vaadin.flow.function.SerializableBiConsumer;
40-
import com.vaadin.flow.server.ElementRequestHandler;
4140
import com.vaadin.flow.server.HttpStatusCode;
42-
import com.vaadin.flow.server.TransferProgressListener;
4341
import com.vaadin.flow.server.VaadinRequest;
4442
import com.vaadin.flow.server.VaadinResponse;
4543
import com.vaadin.flow.server.VaadinSession;

‎flow-server/src/test/java/com/vaadin/flow/server/StreamResourceRegistryTest.java

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,7 @@
3131
import com.vaadin.flow.component.UI;
3232
import com.vaadin.flow.dom.Element;
3333
import com.vaadin.flow.internal.CurrentInstance;
34+
import com.vaadin.flow.server.streams.ElementRequestHandler;
3435

3536
public class StreamResourceRegistryTest {
3637

‎flow-server/src/test/java/com/vaadin/flow/server/communication/StreamRequestHandlerTest.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
import com.vaadin.flow.dom.Element;
1919
import com.vaadin.flow.internal.CurrentInstance;
2020
import com.vaadin.flow.internal.StateNode;
21-
import com.vaadin.flow.server.ElementRequestHandler;
21+
import com.vaadin.flow.server.streams.ElementRequestHandler;
2222
import com.vaadin.flow.server.MockVaadinServletService;
2323
import com.vaadin.flow.server.MockVaadinSession;
2424
import com.vaadin.flow.server.ServiceException;

‎flow-server/src/test/java/com/vaadin/flow/server/streams/AbstractDownloadHandlerTest.java

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -38,8 +38,6 @@
3838
import com.vaadin.flow.function.SerializableConsumer;
3939
import com.vaadin.flow.function.SerializableRunnable;
4040
import com.vaadin.flow.server.Command;
41-
import com.vaadin.flow.server.DownloadEvent;
42-
import com.vaadin.flow.server.TransferProgressListener;
4341
import com.vaadin.flow.server.VaadinRequest;
4442
import com.vaadin.flow.server.VaadinResponse;
4543
import com.vaadin.flow.server.VaadinSession;
@@ -90,7 +88,7 @@ public void handleDownloadRequest(DownloadEvent event) {
9088
}
9189
};
9290
mockContext = Mockito.mock(TransferContext.class);
93-
Mockito.when(mockContext.totalBytes()).thenReturn(TOTAL_BYTES);
91+
Mockito.when(mockContext.contentLength()).thenReturn(TOTAL_BYTES);
9492
listener = Mockito.mock(TransferProgressListener.class);
9593

9694
Mockito.when(mockContext.owningElement()).thenReturn(owner);

‎flow-server/src/test/java/com/vaadin/flow/server/streams/ClassDownloadHandlerTest.java

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -33,9 +33,6 @@
3333
import com.vaadin.flow.component.UI;
3434
import com.vaadin.flow.dom.Element;
3535
import com.vaadin.flow.server.Command;
36-
import com.vaadin.flow.server.DownloadHandler;
37-
import com.vaadin.flow.server.DownloadEvent;
38-
import com.vaadin.flow.server.TransferProgressListener;
3936
import com.vaadin.flow.server.VaadinRequest;
4037
import com.vaadin.flow.server.VaadinResponse;
4138
import com.vaadin.flow.server.VaadinSession;
@@ -86,7 +83,7 @@ public void transferProgressListener_addListener_listenersInvoked()
8683
new TransferProgressListener() {
8784
@Override
8885
public void onStart(TransferContext context) {
89-
Assert.assertEquals(-1, context.totalBytes());
86+
Assert.assertEquals(-1, context.contentLength());
9087
Assert.assertEquals("download", context.fileName());
9188
invocations.add("onStart");
9289
}
@@ -103,7 +100,7 @@ public void onProgress(TransferContext context,
103100
@Override
104101
public void onComplete(TransferContext context,
105102
long transferredBytes) {
106-
Assert.assertEquals(-1, context.totalBytes());
103+
Assert.assertEquals(-1, context.contentLength());
107104
Assert.assertEquals(165000, transferredBytes);
108105
Assert.assertEquals("download", context.fileName());
109106
invocations.add("onComplete");

0 commit comments

Comments
 (0)
0