gerrit.onap Code Review - policy/apex-pdp.git/blob

   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.stringmessaging;
  23
  24 import org.onap.policy.apex.core.infrastructure.messaging.MessagingException;
  25
  26 /**
  27  * This interface is used to call a String Web socket message server or client to send a string.
  28  *
  29  * @author Liam Fallon (liam.fallon@ericsson.com)
  30  */
  31 public interface WsStringMessager {
  32
  33     /**
  34      * Start the string message sender.
  35      *
  36      * @param wsStringMessageListener the listener to use for listening for string messages
  37      * @throws MessagingException the messaging exception
  38      */
  39     void start(WsStringMessageListener wsStringMessageListener) throws MessagingException;
  40
  41     /**
  42      * Stop the string messaging sender.
  43      */
  44     void stop();
  45
  46     /**
  47      * Send a string on a web socket.
  48      *
  49      * @param stringMessage the string message to send
  50      */
  51     void sendString(String stringMessage);
  52
  53     /**
  54      * Check if the string messager is started.
  55      */
  56     boolean isStarted();
  57 }