You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@wicket.apache.org by GitBox <gi...@apache.org> on 2021/05/20 11:30:57 UTC
[GitHub] [wicket] martin-g commented on a change in pull request #469: create demo page showing how to use push in order to update a compone…
martin-g commented on a change in pull request #469:
URL: https://github.com/apache/wicket/pull/469#discussion_r636011467
##########
File path: wicket-examples/src/main/java/org/apache/wicket/examples/websocket/HomePage.html
##########
@@ -29,6 +29,7 @@
<li><a href="WebSocketBehaviorDemoPage.html">demo with WebSocketBehavior</a></li>
<li><a href="WebSocketResourceDemoPage.html">demo with WebSocketResource</a></li>
<li><a href="WebSocketMultiTabResourceDemoPage.html">demo with WebSocketResource and multiple tabs</a></li>
+ <li><a href="WebSocketPushUpdateProgressDemoPage.html">Update a component via push notifications</a></li>
Review comment:
I think it would be more clear if we replace `push` with `server-side initiated` in this label
##########
File path: wicket-examples/src/main/java/org/apache/wicket/examples/websocket/progress/ProgressUpdater.java
##########
@@ -0,0 +1,155 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You 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
+ *
+ * http://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.apache.wicket.examples.websocket.progress;
+
+import java.io.Serializable;
+import java.util.concurrent.ScheduledExecutorService;
+import java.util.concurrent.TimeUnit;
+
+import org.apache.wicket.Application;
+import org.apache.wicket.protocol.ws.WebSocketSettings;
+import org.apache.wicket.protocol.ws.api.IWebSocketConnection;
+import org.apache.wicket.protocol.ws.api.WebSocketPushBroadcaster;
+import org.apache.wicket.protocol.ws.api.message.ConnectedMessage;
+import org.apache.wicket.protocol.ws.api.message.IWebSocketPushMessage;
+import org.apache.wicket.protocol.ws.api.registry.IKey;
+import org.apache.wicket.protocol.ws.api.registry.IWebSocketConnectionRegistry;
+
+/**
+ * A helper class that uses the web connection to push components updates to the client.
+ */
+public class ProgressUpdater
+{
+ public static ProgressUpdateTask start(ConnectedMessage message, ScheduledExecutorService scheduledExecutorService)
+ {
+ // create an asynchronous task that will write the data to the client
+ ProgressUpdateTask progressUpdateTask = new ProgressUpdateTask(message.getApplication(), message.getSessionId(), message.getKey());
+ scheduledExecutorService.schedule(progressUpdateTask, 1, TimeUnit.SECONDS);
+ return progressUpdateTask;
+ }
+
+ public static void restart(ProgressUpdateTask progressUpdateTask, ScheduledExecutorService scheduledExecutorService) {
+ scheduledExecutorService.schedule(progressUpdateTask, 1, TimeUnit.SECONDS);
+ }
+
+ /**
+ * A push message used to update progress.
+ */
+ public static class ProgressUpdate implements IWebSocketPushMessage
+ {
+
+ private final int progress;
+
+ public ProgressUpdate(int progress)
+ {
+ this.progress = progress;
+ }
+
+ public int getProgress()
+ {
+ return progress;
+ }
+ }
+
+ /**
+ * A task that sends data to the client by pushing it to the web socket connection
+ */
+ public static class ProgressUpdateTask implements Runnable, Serializable
+ {
+ /**
+ * The following fields are needed to be able to lookup the IWebSocketConnection from
+ * IWebSocketConnectionRegistry
+ */
+ private final String applicationName;
+ private final String sessionId;
+ private final IKey key;
+
+ private boolean canceled = false;
+ private boolean running = false;
+
+ private ProgressUpdateTask(Application application, String sessionId, IKey key)
+ {
+ this.applicationName = application.getName();
+ this.sessionId = sessionId;
+ this.key = key;
+ }
+
+ @Override
+ public void run()
+ {
+ running = true;
+ Application application = Application.get(applicationName);
+ WebSocketSettings webSocketSettings = WebSocketSettings.Holder.get(application);
+ IWebSocketConnectionRegistry webSocketConnectionRegistry = webSocketSettings.getConnectionRegistry();
+
+ int progress = 0;
+
+ while (progress <= 100)
+ {
+ IWebSocketConnection connection = webSocketConnectionRegistry.getConnection(application, sessionId, key);
+ try
+ {
+ if (connection == null || !connection.isOpen())
+ {
+ running = false;
+ // stop if the web socket connection is closed
+ return;
+ }
+
+ if (canceled)
+ {
+ canceled = false;
+ running = false;
+ return;
+ }
+
+ WebSocketPushBroadcaster broadcaster =
+ new WebSocketPushBroadcaster(webSocketSettings.getConnectionRegistry());
+ broadcaster.broadcast(new ConnectedMessage(application, sessionId, key), new ProgressUpdate(progress));
+
+ // sleep for a while to simulate work
+ TimeUnit.SECONDS.sleep(1);
+ progress++;
+ }
+ catch (InterruptedException x)
+ {
+ Thread.currentThread().interrupt();
+ break;
+ }
+ catch (Exception e)
+ {
+ e.printStackTrace();
Review comment:
Use SLF4J
##########
File path: wicket-examples/src/main/java/org/apache/wicket/examples/websocket/progress/ProgressUpdater.java
##########
@@ -0,0 +1,155 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You 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
+ *
+ * http://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.apache.wicket.examples.websocket.progress;
+
+import java.io.Serializable;
+import java.util.concurrent.ScheduledExecutorService;
+import java.util.concurrent.TimeUnit;
+
+import org.apache.wicket.Application;
+import org.apache.wicket.protocol.ws.WebSocketSettings;
+import org.apache.wicket.protocol.ws.api.IWebSocketConnection;
+import org.apache.wicket.protocol.ws.api.WebSocketPushBroadcaster;
+import org.apache.wicket.protocol.ws.api.message.ConnectedMessage;
+import org.apache.wicket.protocol.ws.api.message.IWebSocketPushMessage;
+import org.apache.wicket.protocol.ws.api.registry.IKey;
+import org.apache.wicket.protocol.ws.api.registry.IWebSocketConnectionRegistry;
+
+/**
+ * A helper class that uses the web connection to push components updates to the client.
+ */
+public class ProgressUpdater
+{
+ public static ProgressUpdateTask start(ConnectedMessage message, ScheduledExecutorService scheduledExecutorService)
+ {
+ // create an asynchronous task that will write the data to the client
+ ProgressUpdateTask progressUpdateTask = new ProgressUpdateTask(message.getApplication(), message.getSessionId(), message.getKey());
+ scheduledExecutorService.schedule(progressUpdateTask, 1, TimeUnit.SECONDS);
+ return progressUpdateTask;
+ }
+
+ public static void restart(ProgressUpdateTask progressUpdateTask, ScheduledExecutorService scheduledExecutorService) {
+ scheduledExecutorService.schedule(progressUpdateTask, 1, TimeUnit.SECONDS);
+ }
+
+ /**
+ * A push message used to update progress.
+ */
+ public static class ProgressUpdate implements IWebSocketPushMessage
+ {
+
+ private final int progress;
+
+ public ProgressUpdate(int progress)
+ {
+ this.progress = progress;
+ }
+
+ public int getProgress()
+ {
+ return progress;
+ }
+ }
+
+ /**
+ * A task that sends data to the client by pushing it to the web socket connection
+ */
+ public static class ProgressUpdateTask implements Runnable, Serializable
+ {
+ /**
+ * The following fields are needed to be able to lookup the IWebSocketConnection from
+ * IWebSocketConnectionRegistry
+ */
+ private final String applicationName;
+ private final String sessionId;
+ private final IKey key;
+
+ private boolean canceled = false;
+ private boolean running = false;
+
+ private ProgressUpdateTask(Application application, String sessionId, IKey key)
+ {
+ this.applicationName = application.getName();
+ this.sessionId = sessionId;
+ this.key = key;
+ }
+
+ @Override
+ public void run()
+ {
+ running = true;
+ Application application = Application.get(applicationName);
+ WebSocketSettings webSocketSettings = WebSocketSettings.Holder.get(application);
+ IWebSocketConnectionRegistry webSocketConnectionRegistry = webSocketSettings.getConnectionRegistry();
+
+ int progress = 0;
+
+ while (progress <= 100)
+ {
+ IWebSocketConnection connection = webSocketConnectionRegistry.getConnection(application, sessionId, key);
+ try
+ {
+ if (connection == null || !connection.isOpen())
+ {
+ running = false;
+ // stop if the web socket connection is closed
+ return;
+ }
+
+ if (canceled)
+ {
+ canceled = false;
Review comment:
why ?
##########
File path: wicket-examples/src/main/java/org/apache/wicket/examples/websocket/WebSocketPushUpdateProgressDemoPage.java
##########
@@ -0,0 +1,30 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You 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
+ *
+ * http://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.apache.wicket.examples.websocket;
+
+import org.apache.wicket.examples.WicketExamplePage;
+import org.apache.wicket.examples.websocket.progress.ProgressBarTogglePanel;
+import org.apache.wicket.protocol.https.RequireHttps;
+
+@RequireHttps
Review comment:
Why TLS is required ?
##########
File path: wicket-examples/src/main/java/org/apache/wicket/examples/websocket/JSR356Application.java
##########
@@ -50,6 +50,7 @@ public void init()
setRootRequestMapper(new HttpsMapper(getRootRequestMapper(), new HttpsConfig(8080, 8443)));
mountPage("/behavior", WebSocketBehaviorDemoPage.class);
+ mountPage("/progress", WebSocketPushUpdateProgressDemoPage.class);
Review comment:
s/progress/push/ ?!
##########
File path: wicket-examples/src/main/java/org/apache/wicket/examples/websocket/progress/ProgressUpdater.java
##########
@@ -0,0 +1,155 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You 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
+ *
+ * http://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.apache.wicket.examples.websocket.progress;
+
+import java.io.Serializable;
+import java.util.concurrent.ScheduledExecutorService;
+import java.util.concurrent.TimeUnit;
+
+import org.apache.wicket.Application;
+import org.apache.wicket.protocol.ws.WebSocketSettings;
+import org.apache.wicket.protocol.ws.api.IWebSocketConnection;
+import org.apache.wicket.protocol.ws.api.WebSocketPushBroadcaster;
+import org.apache.wicket.protocol.ws.api.message.ConnectedMessage;
+import org.apache.wicket.protocol.ws.api.message.IWebSocketPushMessage;
+import org.apache.wicket.protocol.ws.api.registry.IKey;
+import org.apache.wicket.protocol.ws.api.registry.IWebSocketConnectionRegistry;
+
+/**
+ * A helper class that uses the web connection to push components updates to the client.
+ */
+public class ProgressUpdater
+{
+ public static ProgressUpdateTask start(ConnectedMessage message, ScheduledExecutorService scheduledExecutorService)
+ {
+ // create an asynchronous task that will write the data to the client
+ ProgressUpdateTask progressUpdateTask = new ProgressUpdateTask(message.getApplication(), message.getSessionId(), message.getKey());
+ scheduledExecutorService.schedule(progressUpdateTask, 1, TimeUnit.SECONDS);
Review comment:
indentation
##########
File path: wicket-examples/src/main/java/org/apache/wicket/examples/websocket/progress/ProgressBarTogglePanel.java
##########
@@ -0,0 +1,133 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You 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
+ *
+ * http://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.apache.wicket.examples.websocket.progress;
+
+import java.util.concurrent.ScheduledExecutorService;
+
+import org.apache.wicket.ajax.AjaxRequestTarget;
+import org.apache.wicket.ajax.markup.html.AjaxLink;
+import org.apache.wicket.event.IEvent;
+import org.apache.wicket.examples.websocket.JSR356Application;
+import org.apache.wicket.markup.html.basic.Label;
+import org.apache.wicket.markup.html.panel.Panel;
+import org.apache.wicket.model.IModel;
+import org.apache.wicket.protocol.ws.api.WebSocketBehavior;
+import org.apache.wicket.protocol.ws.api.event.WebSocketPushPayload;
+import org.apache.wicket.protocol.ws.api.message.ConnectedMessage;
+
+public class ProgressBarTogglePanel extends Panel
+{
+
+ private int progress = 0;
+ private boolean showProgress = true;
+ private ProgressUpdater.ProgressUpdateTask progressUpdateTask;
+
+ public ProgressBarTogglePanel(String id)
+ {
+ super(id);
+
+ setOutputMarkupId(true);
+
+ add(new WebSocketBehavior()
+ {
+ @Override
+ protected void onConnect(ConnectedMessage message) {
+ progressUpdateTask = ProgressBarTogglePanel.startProgressTask(message);
+ }
+ });
+
+ add(new AjaxLink<Void>("hideShowProgress")
+ {
+ @Override
+ public void onClick(AjaxRequestTarget target)
+ {
+ showProgress = !showProgress;
+ target.add(ProgressBarTogglePanel.this);
+ }
+ }.setBody(new IModel<String>()
Review comment:
You could use lambda here to make it less verbose.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org