aboutsummaryrefslogtreecommitdiffstats
path: root/tools/simple-wsclient/src/main/java/org/onap/policy/apex/tools/simple/wsclient/SimpleEcho.java
blob: 8c7aec008221ca9d597fbc5b1e2eb4b50dd290de (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
/*-
 * ============LICENSE_START=======================================================
 *  Copyright (C) 2016-2018 Ericsson. All rights reserved.
 *  Modifications Copyright (C) 2023 Nordix Foundation.
 * ================================================================================
 * Licensed 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.
 *
 * SPDX-License-Identifier: Apache-2.0
 * ============LICENSE_END=========================================================
 */

package org.onap.policy.apex.tools.simple.wsclient;

import jakarta.websocket.ClientEndpoint;
import jakarta.websocket.CloseReason;
import jakarta.websocket.CloseReason.CloseCodes;
import jakarta.websocket.ContainerProvider;
import jakarta.websocket.DeploymentException;
import jakarta.websocket.OnClose;
import jakarta.websocket.OnError;
import jakarta.websocket.OnMessage;
import jakarta.websocket.OnOpen;
import jakarta.websocket.Session;
import jakarta.websocket.WebSocketContainer;
import java.io.IOException;
import java.io.PrintStream;
import java.net.URI;
import java.net.URISyntaxException;
import org.apache.commons.lang3.Validate;

/**
 * Simple WS client as an echo.
 *
 * @author Sven van der Meer (sven.van.der.meer@ericsson.com)
 */
@ClientEndpoint
public class SimpleEcho {

    /** Application name, used as prompt. */
    private final String appName;

    // Output and error streams
    private PrintStream outStream;
    private PrintStream errStream;

    /**
     * Creates a new simple echo object.
     *
     * @param server the name of the server as either IP address or fully qualified host name, must not be blank
     * @param port the port to be used, must not be blank
     * @param appName the application name, used as prompt, must not be blank
     * @param outStream the stream for message output
     * @param errStream the stream for error messages
     * @throws URISyntaxException is URI could not be created from server/port settings
     * @throws IOException on IO exceptions
     * @throws DeploymentException on deployment exceptions
     * @throws RuntimeException if server or port where blank
     */
    public SimpleEcho(final String server, final String port, final String appName, PrintStream outStream,
                      PrintStream errStream) throws URISyntaxException, DeploymentException, IOException {

        Validate.notBlank(appName, "SimpleEcho: given application name was blank");
        WebSocketContainer container = ContainerProvider.getWebSocketContainer();
        container.connectToServer(this, new URI("ws://" + server + ":" + port));

        this.appName = appName;
        this.outStream = outStream;
        this.errStream = errStream;
    }

    /**
     * Callback hook for Connection close events.
     *
     * @param userSession the userSession which is getting closed.
     * @param reason the reason for connection close
     */
    @OnClose
    public void onClose(Session userSession, CloseReason reason) {
        outStream.println(this.appName + ": Connection closed");
        outStream.print(" ==-->> ");

        CloseCodes reasonCloseCode = CloseCodes.valueOf(reason.getCloseCode().toString());
        switch (reasonCloseCode) {
            case NORMAL_CLOSURE:
                outStream.println("normal");
                break;
            case GOING_AWAY:
                outStream.println("APEX going away");
                break;
            case PROTOCOL_ERROR:
                outStream.println("some protocol error");
                break;
            case CANNOT_ACCEPT:
                outStream.println("received unacceptable type of data");
                break;
            case CLOSED_ABNORMALLY:
                outStream.println("expected UTF-8, found something else");
                break;
            case TOO_BIG:
                outStream.println("message too big");
                break;
            case UNEXPECTED_CONDITION:
                outStream.println("unexpected server condition");
                break;
            default:
                outStream.println("unkown close frame code");
                break;
        }
        outStream.print(" ==-->> " + reason);
    }

    @OnError
    public void onError(final Exception ex) {
        errStream.println(this.appName + ": " + ex.getMessage());
    }

    /**
     * Callback hook for Message Events. This method will be invoked when a client send a message.
     *
     * @param message The text message
     */
    @OnMessage
    public void onMessage(String message) {
        outStream.println(this.appName + ": received");
        outStream.println("---------------------------------");
        outStream.println(message);
        outStream.println("=================================");
        outStream.println();
    }

    /**
     * Callback hook for Connection open events.
     *
     * @param userSession the userSession which is opened.
     */
    @OnOpen
    public void onOpen(Session userSession) {
        outStream.println(this.appName + ": opened connection to APEX (" + userSession.getRequestURI() + ")");
    }
}