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;
  22
  23 /**
  24  * The Interface MessagingService specifies the methods that must be implemented by any implementation providing Apex
  25  * messaging.
  26  *
  27  * @author Sajeevan Achuthan (sajeevan.achuthan@ericsson.com)
  28  * @param <MESSAGE> the type of message being passed by an implementation of Apex messaging
  29  */
  30 public interface MessagingService<MESSAGE> {
  31
  32     /**
  33      * Start the messaging connection.
  34      */
  35     void startConnection();
  36
  37     /**
  38      * Stop the messaging connection.
  39      */
  40     void stopConnection();
  41
  42     /**
  43      * Checks if the messaging connection is started.
  44      *
  45      * @return true, if is started
  46      */
  47     boolean isStarted();
  48
  49     /**
  50      * Send a block of messages on the connection, the messages are contained in the the message holder container.
  51      *
  52      * @param messageHolder The message holder holding the messages to be sent
  53      */
  54     void send(MessageHolder<MESSAGE> messageHolder);
  55
  56     /**
  57      * Send a string message on the connection.
  58      *
  59      * @param messageString The message string to be sent
  60      */
  61     void send(String messageString);
  62
  63     /**
  64      * Adds a message listener that will be called when a message is received by this messaging service implementation.
  65      *
  66      * @param messageListener the message listener
  67      */
  68     void addMessageListener(MessageListener<MESSAGE> messageListener);
  69
  70     /**
  71      * Removes the message listener.
  72      *
  73      * @param messageListener the message listener
  74      */
  75     void removeMessageListener(MessageListener<MESSAGE> messageListener);
  76 }