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

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  *  Copyright (C) 2016-2018 Ericsson. All rights reserved.
   4  * ================================================================================
   5  * Licensed under the Apache License, Version 2.0 (the "License");
   6  * you may not use this file except in compliance with the License.
   7  * You may obtain a copy of the License at
   8  *
   9  *      http://www.apache.org/licenses/LICENSE-2.0
  10  *
  11  * Unless required by applicable law or agreed to in writing, software
  12  * distributed under the License is distributed on an "AS IS" BASIS,
  13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14  * See the License for the specific language governing permissions and
  15  * limitations under the License.
  16  *
  17  * SPDX-License-Identifier: Apache-2.0
  18  * ============LICENSE_END=========================================================
  19  */
  20
  21 package org.onap.policy.apex.core.infrastructure.messaging.stringmessaging;
  22
  23 import org.onap.policy.apex.core.infrastructure.messaging.MessagingException;
  24
  25 /**
  26  * This interface is used to call a String Web socket message server or client to send a string.
  27  *
  28  * @author Liam Fallon (liam.fallon@ericsson.com)
  29  */
  30 public interface WSStringMessager {
  31
  32     /**
  33      * Start the string message sender.
  34      *
  35      * @param wsStringMessageListener the listener to use for listening for string messages
  36      * @throws MessagingException the messaging exception
  37      */
  38     void start(WSStringMessageListener wsStringMessageListener) throws MessagingException;
  39
  40     /**
  41      * Stop the string messaging sender.
  42      */
  43     void stop();
  44
  45     /**
  46      * Send a string on a web socket.
  47      *
  48      * @param stringMessage the string message to send
  49      */
  50     void sendString(String stringMessage);
  51 }