core/core-infrastructure/src/main/java/org/onap/policy/apex/core/infrastructure/messaging/MessageListener.java

   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;
  22
  23 import org.onap.policy.apex.core.infrastructure.messaging.impl.ws.messageblock.MessageBlock;
  24
  25 /**
  26  * The listener interface for receiving message events. The class that is interested in processing a message event
  27  * implements this interface.
  28  *
  29  * @author Sajeevan Achuthan (sajeevan.achuthan@ericsson.com)
  30  * @param <M> of message of any given type that is being listened for and handled
  31  */
  32 public interface MessageListener<M> {
  33
  34     /**
  35      * This method is called when a message block is received on a web socket and is to be forwarded to a listener.
  36      *
  37      * @param data the message data containing a message
  38      */
  39     void onMessage(MessageBlock<M> data);
  40
  41     /**
  42      * This method is called when a string message is received on a web socket and is to be forwarded to a listener.
  43      *
  44      * @param messageString the message string
  45      */
  46     void onMessage(String messageString);
  47 }