core/core-infrastructure/src/main/java/org/onap/policy/apex/core/infrastructure/messaging/impl/ws/server/WebSocketServerImpl.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  *  Copyright (C) 2016-2018 Ericsson. All rights reserved.
   4  *  Modifications Copyright (C) 2020 Nordix Foundation.
   5  * ================================================================================
   6  * Licensed under the Apache License, Version 2.0 (the "License");
   7  * you may not use this file except in compliance with the License.
   8  * You may obtain a copy of the License at
   9  *
  10  *      http://www.apache.org/licenses/LICENSE-2.0
  11  *
  12  * Unless required by applicable law or agreed to in writing, software
  13  * distributed under the License is distributed on an "AS IS" BASIS,
  14  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15  * See the License for the specific language governing permissions and
  16  * limitations under the License.
  17  *
  18  * SPDX-License-Identifier: Apache-2.0
  19  * ============LICENSE_END=========================================================
  20  */
  21
  22 package org.onap.policy.apex.core.infrastructure.messaging.impl.ws.server;
  23
  24 import java.net.InetSocketAddress;
  25 import org.java_websocket.WebSocket;
  26 import org.java_websocket.handshake.ClientHandshake;
  27 import org.java_websocket.server.WebSocketServer;
  28 import org.slf4j.ext.XLogger;
  29 import org.slf4j.ext.XLoggerFactory;
  30
  31 /**
  32  * This class is the web socket server specific implementation for Apex.
  33  *
  34  * @author Sajeevan Achuthan (sajeevan.achuthan@ericsson.com)
  35  */
  36 abstract class WebSocketServerImpl extends WebSocketServer {
  37     // The logger for this class
  38     private static final XLogger LOGGER = XLoggerFactory.getXLogger(MessageServerImpl.class);
  39
  40     /**
  41      * Constructor of this class.
  42      *
  43      * @param address host address of the local machine.
  44      */
  45     protected WebSocketServerImpl(final InetSocketAddress address) {
  46         super(address);
  47         LOGGER.entry(address.getAddress().getHostAddress() + ":" + address.getPort());
  48         LOGGER.exit();
  49     }
  50
  51     /**
  52      * {@inheritDoc}.
  53      */
  54     @Override
  55     public void onOpen(final WebSocket conn, final ClientHandshake handshake) {
  56         LOGGER.entry(conn, handshake);
  57         LOGGER.debug("A client connection opened from machine {}.",
  58                 conn.getRemoteSocketAddress().getAddress().getHostAddress());
  59         LOGGER.exit();
  60     }
  61
  62     /**
  63      * {@inheritDoc}.
  64      */
  65     @Override
  66     public void onClose(final WebSocket conn, final int code, final String reason, final boolean remote) {
  67         LOGGER.entry(conn, code, remote);
  68         LOGGER.debug("A client  connection from machine {} closing with code {}.", super.getAddress(), code);
  69         LOGGER.exit();
  70     }
  71
  72     /**
  73      * {@inheritDoc}.
  74      */
  75     @Override
  76     public void onError(final WebSocket conn, final Exception ex) {
  77         // some errors like port binding failed may not be assignable to a specific web socket
  78         LOGGER.error("server error occurred", ex);
  79     }
  80 }