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.impl.ws;
  22
  23 import org.onap.policy.apex.core.infrastructure.messaging.MessageListener;
  24 import org.onap.policy.apex.core.infrastructure.messaging.impl.ws.messageblock.RawMessageBlock;
  25
  26 /**
  27  * The listener interface for receiving webSocketMessage events. The class that is interested in processing a
  28  * webSocketMessage event implements this interface, and the object created with that class is registered with a
  29  * component using the component's addWebSocketMessageListener method. When the webSocketMessage event occurs, that
  30  * object's appropriate method is invoked.
  31  *
  32  * @author Sajeevan Achuthan (sajeevan.achuthan@ericsson.com)
  33  * @param <M> the generic type
  34  * @see RawMessageBlock
  35  */
  36 public interface WebSocketMessageListener<M> extends MessageListener<M>, Runnable {
  37
  38     /**
  39      * This method is called by the class with which this message listener has been registered.
  40      *
  41      * @param incomingData the data forwarded by the message reception class
  42      */
  43     void onMessage(RawMessageBlock incomingData);
  44
  45     /**
  46      * Register a data forwarder to which messages coming in on the web socket will be forwarded.
  47      *
  48      * @param listener The listener to register
  49      */
  50     void registerDataForwarder(MessageListener<M> listener);
  51
  52     /**
  53      * Unregister a data forwarder that was previously registered on the web socket listener.
  54      *
  55      * @param listener The listener to unregister
  56      */
  57     void unRegisterDataForwarder(MessageListener<M> listener);
  58 }