Skip to content

Commit 1f374e1

Browse files
georgweissgeorgweiss
committed
Code cleanup, copyright clarification
1 parent 3b955b6 commit 1f374e1

File tree

10 files changed

+45
-97
lines changed

10 files changed

+45
-97
lines changed

‎src/main/java/org/phoebus/pvws/WebSocketConfig.java‎

Lines changed: 1 addition & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -17,29 +17,19 @@
1717
*/
1818
package org.phoebus.pvws;
1919

20-
import com.fasterxml.jackson.databind.DeserializationFeature;
2120
import com.fasterxml.jackson.databind.ObjectMapper;
2221
import org.phoebus.pvws.ws.PvSocketHandler;
23-
import org.phoebus.pvws.ws.Vtype2Json;
2422
import org.phoebus.pvws.ws.WebSocket;
2523
import org.springframework.beans.factory.annotation.Autowired;
26-
import org.springframework.boot.SpringBootConfiguration;
27-
import org.springframework.context.annotation.Bean;
2824
import org.springframework.context.annotation.Configuration;
29-
import org.springframework.context.annotation.Scope;
30-
import org.springframework.context.event.ContextClosedEvent;
31-
import org.springframework.context.event.EventListener;
32-
import org.springframework.web.socket.WebSocketHandler;
33-
import org.springframework.web.socket.WebSocketSession;
3425
import org.springframework.web.socket.config.annotation.EnableWebSocket;
3526
import org.springframework.web.socket.config.annotation.WebSocketConfigurer;
3627
import org.springframework.web.socket.config.annotation.WebSocketHandlerRegistry;
37-
import org.springframework.web.socket.messaging.SessionConnectEvent;
3828

3929
import java.util.List;
40-
import java.util.logging.Level;
4130
import java.util.logging.Logger;
4231

32+
@SuppressWarnings("unused")
4333
@Configuration
4434
@EnableWebSocket
4535
public class WebSocketConfig implements WebSocketConfigurer {

‎src/main/java/org/phoebus/pvws/controllers/PvwsRestController.java‎

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,18 @@
3838
import java.util.logging.Level;
3939
import java.util.logging.Logger;
4040

41+
/**
42+
* This class replaces several servlets from the original pvws implementation,
43+
* which are published under the following copyright:
44+
* <p>
45+
* ******************************************************************************
46+
* Copyright (c) 2019-2022 UT-Battelle, LLC.
47+
* All rights reserved. This program and the accompanying materials
48+
* are made available under the terms of the LICENSE
49+
* which accompanies this distribution
50+
* ******************************************************************************
51+
* </p>
52+
*/
4153
@SuppressWarnings("unused")
4254
@RestController
4355
public class PvwsRestController {
@@ -124,7 +136,6 @@ public List<PvPoolData> pool() {
124136
return data;
125137
}
126138

127-
128139
@GetMapping("/info")
129140
public InfoData info(@RequestParam(name = "env", defaultValue = "false") boolean env) {
130141
InfoData infoData = new InfoData();

‎src/test/java/org/phoebus/pvws/EpicsWebSocketServerApplicationTests.java‎

Lines changed: 20 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,45 +1,43 @@
11
package org.phoebus.pvws;
22

3-
import com.fasterxml.jackson.core.JsonFactory;
43
import com.fasterxml.jackson.databind.ObjectMapper;
5-
import org.checkerframework.checker.units.qual.A;
64
import org.junit.jupiter.api.Test;
75
import org.phoebus.pvws.ws.PvSocketHandler;
86
import org.phoebus.pvws.ws.Vtype2Json;
97
import org.phoebus.pvws.ws.WebSocket;
108
import org.springframework.beans.factory.annotation.Autowired;
119
import org.springframework.boot.test.context.SpringBootTest;
1210

13-
import java.net.Socket;
1411
import java.time.Instant;
1512
import java.util.List;
1613

17-
import static org.junit.jupiter.api.Assertions.*;
14+
import static org.junit.jupiter.api.Assertions.assertNotNull;
1815

16+
@SuppressWarnings("unused")
1917
@SpringBootTest
2018
class EpicsWebSocketServerApplicationTests {
2119

22-
@Autowired
23-
private ObjectMapper objectMapper;
20+
@Autowired
21+
private ObjectMapper objectMapper;
2422

25-
@Autowired
26-
private Vtype2Json vtype2Json;
23+
@Autowired
24+
private Vtype2Json vtype2Json;
2725

28-
@Autowired
29-
private PvSocketHandler pvSocketHandler;
26+
@Autowired
27+
private PvSocketHandler pvSocketHandler;
3028

31-
@Autowired
32-
private Instant start_time;
29+
@Autowired
30+
private Instant start_time;
3331

34-
@Autowired
35-
private List<WebSocket> sockets;
32+
@Autowired
33+
private List<WebSocket> sockets;
3634

37-
@Test
38-
void contextLoads() {
39-
assertNotNull(objectMapper);
40-
assertNotNull(vtype2Json);
41-
assertNotNull(start_time);
42-
assertNotNull(pvSocketHandler);
43-
assertNotNull(sockets);
44-
}
35+
@Test
36+
void contextLoads() {
37+
assertNotNull(objectMapper);
38+
assertNotNull(vtype2Json);
39+
assertNotNull(start_time);
40+
assertNotNull(pvSocketHandler);
41+
assertNotNull(sockets);
42+
}
4543
}

‎src/test/java/org/phoebus/pvws/controllers/PvwsRestControllerTest.java‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,7 @@
3636
import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get;
3737
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;
3838

39+
@SuppressWarnings("unused")
3940
@SpringBootTest
4041
@AutoConfigureMockMvc
4142
public class PvwsRestControllerTest {

‎src/test/java/org/phoebus/pvws/ws/clientconfig/SubscribeClientConfiguration.java‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,11 +27,10 @@
2727
import org.springframework.web.socket.handler.TextWebSocketHandler;
2828

2929
import java.util.List;
30-
import java.util.concurrent.CountDownLatch;
3130
import java.util.concurrent.atomic.AtomicReference;
3231

3332
@SuppressWarnings("unused")
34-
public class SubscribeClientConfiguration extends ClientConfigurationBase{
33+
public class SubscribeClientConfiguration extends ClientConfigurationBase {
3534

3635
@Value("${type}")
3736
private String type;

‎src/test/java/org/phoebus/pvws/ws/handlers/ConnectOnlyWebSocketHandler.java‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@
1919

2020
package org.phoebus.pvws.ws.handlers;
2121

22+
import org.springframework.lang.NonNull;
2223
import org.springframework.web.socket.WebSocketSession;
2324
import org.springframework.web.socket.handler.TextWebSocketHandler;
2425

@@ -34,7 +35,7 @@ public ConnectOnlyWebSocketHandler(CountDownLatch latch) {
3435
}
3536

3637
@Override
37-
public void afterConnectionEstablished(WebSocketSession session) {
38+
public void afterConnectionEstablished(@NonNull WebSocketSession session) {
3839
latch.countDown();
3940
}
4041
}

‎src/test/java/org/phoebus/pvws/ws/handlers/EchoWebSocketHandler.java‎

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,6 @@
2323
import org.apache.commons.logging.Log;
2424
import org.apache.commons.logging.LogFactory;
2525
import org.phoebus.pvws.model.ApplicationClientEchoMessage;
26-
import org.phoebus.pvws.model.ApplicationClientMessage;
2726
import org.springframework.web.socket.TextMessage;
2827
import org.springframework.web.socket.WebSocketSession;
2928
import org.springframework.web.socket.handler.TextWebSocketHandler;
@@ -33,8 +32,6 @@
3332

3433
public class EchoWebSocketHandler extends TextWebSocketHandler {
3534

36-
protected Log logger = LogFactory.getLog(EchoWebSocketHandler.class);
37-
3835
private final CountDownLatch latch;
3936

4037
private final AtomicReference<String> messagePayload;
@@ -45,7 +42,7 @@ public EchoWebSocketHandler(CountDownLatch latch, AtomicReference<String> messag
4542
}
4643

4744
@Override
48-
public void afterConnectionEstablished(WebSocketSession session) throws Exception{
45+
public void afterConnectionEstablished(WebSocketSession session) throws Exception {
4946
ObjectMapper objectMapper = new ObjectMapper();
5047
ApplicationClientEchoMessage applicationClientEchoMessage =
5148
new ApplicationClientEchoMessage();

‎src/test/java/org/phoebus/pvws/ws/handlers/SimpleClientWebSocketHandler.java‎

Lines changed: 0 additions & 51 deletions
This file was deleted.

‎src/test/java/org/phoebus/pvws/ws/handlers/SubscribeUnsubscribeWebSocketHandler.java‎

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@
2222
import com.fasterxml.jackson.databind.ObjectMapper;
2323
import org.phoebus.pvws.model.ApplicationClientMessage;
2424
import org.phoebus.pvws.model.ApplicationClientPvsMessage;
25+
import org.springframework.lang.NonNull;
2526
import org.springframework.web.socket.TextMessage;
2627
import org.springframework.web.socket.WebSocketSession;
2728
import org.springframework.web.socket.handler.TextWebSocketHandler;
@@ -42,10 +43,10 @@ public class SubscribeUnsubscribeWebSocketHandler extends TextWebSocketHandler {
4243

4344
private boolean firstValueMessageReceived = false;
4445

45-
private ApplicationClientMessage listMessage = new ApplicationClientMessage("list");
46+
private final ApplicationClientMessage listMessage = new ApplicationClientMessage("list");
4647

47-
public SubscribeUnsubscribeWebSocketHandler(AtomicReference message1,
48-
AtomicReference message2,
48+
public SubscribeUnsubscribeWebSocketHandler(AtomicReference<String> message1,
49+
AtomicReference<String> message2,
4950
CountDownLatch latch){
5051
this.message1 = message1;
5152
this.message2 = message2;
@@ -60,7 +61,7 @@ public void afterConnectionEstablished(WebSocketSession session) throws Exceptio
6061
}
6162

6263
@Override
63-
public void handleTextMessage(WebSocketSession session, TextMessage message) throws Exception {
64+
public void handleTextMessage(@NonNull WebSocketSession session, TextMessage message) throws Exception {
6465
// Send message only if it contains a value. That way we can detect if the message
6566
// originates from an actual PV (e.g. sim://sine).
6667
if(message.getPayload().contains("value") && !firstValueMessageReceived){

‎src/test/java/org/phoebus/pvws/ws/handlers/SubscribeWebSocketHandler.java‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@
2121

2222
import com.fasterxml.jackson.databind.ObjectMapper;
2323
import org.phoebus.pvws.model.ApplicationClientMessage;
24+
import org.springframework.lang.NonNull;
2425
import org.springframework.web.socket.TextMessage;
2526
import org.springframework.web.socket.WebSocketSession;
2627
import org.springframework.web.socket.handler.TextWebSocketHandler;
@@ -51,7 +52,7 @@ public void afterConnectionEstablished(WebSocketSession session) throws Exceptio
5152
}
5253

5354
@Override
54-
public void handleTextMessage(WebSocketSession session, TextMessage message) throws Exception {
55+
public void handleTextMessage(@NonNull WebSocketSession session, TextMessage message) throws Exception {
5556
// Send message only if it contains a value. That way we can detect if the message
5657
// originates from an actual PV (e.g. sim://sine).
5758
if(message.getPayload().contains("value")){

0 commit comments

Comments
 (0)